ActiveDirectory class

ActiveDirectory is the public representation of the active directory config.

To get more information about ActiveDirectory, see:

• API documentation
• How-to Guides
• Official Documentation

Example Usage

Netapp Active Directory Full

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";

const testActiveDirectoryFull = new gcp.netapp.ActiveDirectory("test_active_directory_full", {
    name: "test-active-directory-full",
    location: "us-central1",
    domain: "ad.internal",
    dns: "172.30.64.3",
    netBiosPrefix: "smbserver",
    username: "user",
    password: "pass",
    aesEncryption: false,
    backupOperators: [
        "test1",
        "test2",
    ],
    administrators: [
        "test1",
        "test2",
    ],
    description: "ActiveDirectory is the public representation of the active directory config.",
    encryptDcConnections: false,
    kdcHostname: "hostname",
    kdcIp: "10.10.0.11",
    labels: {
        foo: "bar",
    },
    ldapSigning: false,
    nfsUsersWithLdap: false,
    organizationalUnit: "CN=Computers",
    securityOperators: [
        "test1",
        "test2",
    ],
    site: "test-site",
});

import pulumi
import pulumi_gcp as gcp

test_active_directory_full = gcp.netapp.ActiveDirectory("test_active_directory_full",
    name="test-active-directory-full",
    location="us-central1",
    domain="ad.internal",
    dns="172.30.64.3",
    net_bios_prefix="smbserver",
    username="user",
    password="pass",
    aes_encryption=False,
    backup_operators=[
        "test1",
        "test2",
    ],
    administrators=[
        "test1",
        "test2",
    ],
    description="ActiveDirectory is the public representation of the active directory config.",
    encrypt_dc_connections=False,
    kdc_hostname="hostname",
    kdc_ip="10.10.0.11",
    labels={
        "foo": "bar",
    },
    ldap_signing=False,
    nfs_users_with_ldap=False,
    organizational_unit="CN=Computers",
    security_operators=[
        "test1",
        "test2",
    ],
    site="test-site")

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;

return await Deployment.RunAsync(() =>
{
    var testActiveDirectoryFull = new Gcp.Netapp.ActiveDirectory("test_active_directory_full", new()
    {
        Name = "test-active-directory-full",
        Location = "us-central1",
        Domain = "ad.internal",
        Dns = "172.30.64.3",
        NetBiosPrefix = "smbserver",
        Username = "user",
        Password = "pass",
        AesEncryption = false,
        BackupOperators = new[]
        {
            "test1",
            "test2",
        },
        Administrators = new[]
        {
            "test1",
            "test2",
        },
        Description = "ActiveDirectory is the public representation of the active directory config.",
        EncryptDcConnections = false,
        KdcHostname = "hostname",
        KdcIp = "10.10.0.11",
        Labels =
        {
            { "foo", "bar" },
        },
        LdapSigning = false,
        NfsUsersWithLdap = false,
        OrganizationalUnit = "CN=Computers",
        SecurityOperators = new[]
        {
            "test1",
            "test2",
        },
        Site = "test-site",
    });

});

package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/netapp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := netapp.NewActiveDirectory(ctx, "test_active_directory_full", &netapp.ActiveDirectoryArgs{
			Name:          pulumi.String("test-active-directory-full"),
			Location:      pulumi.String("us-central1"),
			Domain:        pulumi.String("ad.internal"),
			Dns:           pulumi.String("172.30.64.3"),
			NetBiosPrefix: pulumi.String("smbserver"),
			Username:      pulumi.String("user"),
			Password:      pulumi.String("pass"),
			AesEncryption: pulumi.Bool(false),
			BackupOperators: pulumi.StringArray{
				pulumi.String("test1"),
				pulumi.String("test2"),
			},
			Administrators: pulumi.StringArray{
				pulumi.String("test1"),
				pulumi.String("test2"),
			},
			Description:          pulumi.String("ActiveDirectory is the public representation of the active directory config."),
			EncryptDcConnections: pulumi.Bool(false),
			KdcHostname:          pulumi.String("hostname"),
			KdcIp:                pulumi.String("10.10.0.11"),
			Labels: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
			LdapSigning:        pulumi.Bool(false),
			NfsUsersWithLdap:   pulumi.Bool(false),
			OrganizationalUnit: pulumi.String("CN=Computers"),
			SecurityOperators: pulumi.StringArray{
				pulumi.String("test1"),
				pulumi.String("test2"),
			},
			Site: pulumi.String("test-site"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
  }
}

resource "gcp_netapp_activedirectory" "test_active_directory_full" {
  name                   = "test-active-directory-full"
  location               = "us-central1"
  domain                 = "ad.internal"
  dns                    = "172.30.64.3"
  net_bios_prefix        = "smbserver"
  username               = "user"
  password               = "pass"
  aes_encryption         = false
  backup_operators       = ["test1", "test2"]
  administrators         = ["test1", "test2"]
  description            = "ActiveDirectory is the public representation of the active directory config."
  encrypt_dc_connections = false
  kdc_hostname           = "hostname"
  kdc_ip                 = "10.10.0.11"
  labels = {
    "foo" = "bar"
  }
  ldap_signing        = false
  nfs_users_with_ldap = false
  organizational_unit = "CN=Computers"
  security_operators  = ["test1", "test2"]
  site                = "test-site"
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.netapp.ActiveDirectory;
import com.pulumi.gcp.netapp.ActiveDirectoryArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testActiveDirectoryFull = new ActiveDirectory("testActiveDirectoryFull", ActiveDirectoryArgs.builder()
            .name("test-active-directory-full")
            .location("us-central1")
            .domain("ad.internal")
            .dns("172.30.64.3")
            .netBiosPrefix("smbserver")
            .username("user")
            .password("pass")
            .aesEncryption(false)
            .backupOperators(
                "test1",
                "test2")
            .administrators(
                "test1",
                "test2")
            .description("ActiveDirectory is the public representation of the active directory config.")
            .encryptDcConnections(false)
            .kdcHostname("hostname")
            .kdcIp("10.10.0.11")
            .labels(Map.of("foo", "bar"))
            .ldapSigning(false)
            .nfsUsersWithLdap(false)
            .organizationalUnit("CN=Computers")
            .securityOperators(
                "test1",
                "test2")
            .site("test-site")
            .build());

    }
}

resources:
  testActiveDirectoryFull:
    type: gcp:netapp:ActiveDirectory
    name: test_active_directory_full
    properties:
      name: test-active-directory-full
      location: us-central1
      domain: ad.internal
      dns: 172.30.64.3
      netBiosPrefix: smbserver
      username: user
      password: pass
      aesEncryption: false
      backupOperators:
        - test1
        - test2
      administrators:
        - test1
        - test2
      description: ActiveDirectory is the public representation of the active directory config.
      encryptDcConnections: false
      kdcHostname: hostname
      kdcIp: 10.10.0.11
      labels:
        foo: bar
      ldapSigning: false
      nfsUsersWithLdap: false
      organizationalUnit: CN=Computers
      securityOperators:
        - test1
        - test2
      site: test-site

Import

ActiveDirectory can be imported using any of these accepted formats:

• projects/{{project}}/locations/{{location}}/activeDirectories/{{name}}
• {{project}}/{{location}}/{{name}}
• {{location}}/{{name}}

When using the pulumi import command, ActiveDirectory can be imported using one of the formats above. For example:

$ pulumi import gcp:netapp/activeDirectory:ActiveDirectory default projects/{{project}}/locations/{{location}}/activeDirectories/{{name}}
$ pulumi import gcp:netapp/activeDirectory:ActiveDirectory default {{project}}/{{location}}/{{name}}
$ pulumi import gcp:netapp/activeDirectory:ActiveDirectory default {{location}}/{{name}}

Constructors

ActiveDirectory(String name, {ActiveDirectoryArgs? args, CustomResourceOptions? options})

Creates a new ActiveDirectory. name The Pulumi resource name. args Arguments used to configure this ActiveDirectory. The set of arguments for ActiveDirectory. options Resource options controlling this resource's behavior.

ActiveDirectory.reference(String urn)

Creates a typed reference to an existing ActiveDirectory resource.

Properties

administrators ↔ Output<List<String>?>

Domain user accounts to be added to the local Administrators group of the SMB service. Comma-separated list of domain users or groups. The Domain Admin group is automatically added when the service joins your domain as a hidden group.

late, final

aesEncryption ↔ Output<bool?>

Enables AES-128 and AES-256 encryption for Kerberos-based communication with Active Directory.

late, final

backupOperators ↔ Output<List<String>?>

Domain user/group accounts to be added to the Backup Operators group of the SMB service. The Backup Operators group allows members to backup and restore files regardless of whether they have read or write access to the files. Comma-separated list.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Create time of the active directory. A timestamp in RFC3339 UTC "Zulu" format. Examples: "2023-06-22T09:13:01.617Z".

late, final

deletionPolicy ↔ Output<String>

Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.

late, final

description ↔ Output<String?>

An optional description of this resource.

late, final

dns ↔ Output<String>

Comma separated list of DNS server IP addresses for the Active Directory domain.

late, final

domain ↔ Output<String>

Fully qualified domain name for the Active Directory domain.

late, final

effectiveLabels ↔ Output<Map<String, String>>

All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.

late, final

encryptDcConnections ↔ Output<bool?>

If enabled, traffic between the SMB server to Domain Controller (DC) will be encrypted.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

kdcHostname ↔ Output<String?>

Hostname of the Active Directory server used as Kerberos Key Distribution Center. Only required for volumes using kerberized NFSv4.1

late, final

kdcIp ↔ Output<String?>

IP address of the Active Directory server used as Kerberos Key Distribution Center.

late, final

labels ↔ Output<Map<String, String>?>

Labels as key value pairs. Example: { "owner": "Bob", "department": "finance", "purpose": "testing" }.

late, final

ldapSigning ↔ Output<bool?>

Specifies whether or not the LDAP traffic needs to be signed.

late, final

location ↔ Output<String>

Name of the region for the policy to apply to.

late, final

name ↔ Output<String>

The resource name of the Active Directory pool. Needs to be unique per location.

late, final

netBiosPrefix ↔ Output<String>

NetBIOS name prefix of the server to be created. A five-character random ID is generated automatically, for example, -6f9a, and appended to the prefix. The full UNC share path will have the following format: \\NetBIOS_PREFIX-ABCD.DOMAIN_NAME\SHARE_NAME

late, final

nfsUsersWithLdap ↔ Output<bool?>

Local UNIX users on clients without valid user information in Active Directory are blocked from access to LDAP enabled volumes. This option can be used to temporarily switch such volumes to AUTH_SYS authentication (user ID + 1-16 groups).

late, final

organizationalUnit ↔ Output<String>

Name of the Organizational Unit where you intend to create the computer account for NetApp Volumes. Defaults to CN=Computers if left empty.

late, final

password ↔ Output<String>

Password for specified username. Note - Manual changes done to the password will not be detected. Terraform will not re-apply the password, unless you use a new password in Terraform. Note: This property is sensitive and will not be displayed in the plan.

late, final

project ↔ Output<String>

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

late, final

pulumiLabels ↔ Output<Map<String, String>>

The combination of labels configured directly on the resource and default labels configured on the provider.

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

securityOperators ↔ Output<List<String>?>

Domain accounts that require elevated privileges such as SeSecurityPrivilege to manage security logs. Comma-separated list.

late, final

site ↔ Output<String?>

Specifies an Active Directory site to manage domain controller selection. Use when Active Directory domain controllers in multiple regions are configured. Defaults to Default-First-Site-Name if left empty.

late, final

state ↔ Output<String>

The state of the Active Directory policy (not the Active Directory itself).

late, final

stateDetails ↔ Output<String>

The state details of the Active Directory.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

username ↔ Output<String>

Username for the Active Directory account with permissions to create the compute account within the specified organizational unit.

late, final

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

get(String name, Input<String> id, {ActiveDirectoryState? state, CustomResourceOptions? options}) → ActiveDirectory

Gets an existing ActiveDirectory resource's state with the given name and id.