Domain class

Creates a Microsoft AD domain

To get more information about Domain, see:

• API documentation
• How-to Guides
• Managed Microsoft Active Directory Quickstart

Example Usage

Active Directory Domain Basic

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

const ad_domain = new gcp.activedirectory.Domain("ad-domain", {
    domainName: "tfgen.org.com",
    locations: ["us-central1"],
    reservedIpRange: "192.168.255.0/24",
    deletionProtection: false,
});

import pulumi
import pulumi_gcp as gcp

ad_domain = gcp.activedirectory.Domain("ad-domain",
    domain_name="tfgen.org.com",
    locations=["us-central1"],
    reserved_ip_range="192.168.255.0/24",
    deletion_protection=False)

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

return await Deployment.RunAsync(() =>
{
    var ad_domain = new Gcp.ActiveDirectory.Domain("ad-domain", new()
    {
        DomainName = "tfgen.org.com",
        Locations = new[]
        {
            "us-central1",
        },
        ReservedIpRange = "192.168.255.0/24",
        DeletionProtection = false,
    });

});

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := activedirectory.NewDomain(ctx, "ad-domain", &activedirectory.DomainArgs{
			DomainName: pulumi.String("tfgen.org.com"),
			Locations: pulumi.StringArray{
				pulumi.String("us-central1"),
			},
			ReservedIpRange:    pulumi.String("192.168.255.0/24"),
			DeletionProtection: pulumi.Bool(false),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

resource "gcp_activedirectory_domain" "ad-domain" {
  domain_name         = "tfgen.org.com"
  locations           = ["us-central1"]
  reserved_ip_range   = "192.168.255.0/24"
  deletion_protection = false
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.activedirectory.Domain;
import com.pulumi.gcp.activedirectory.DomainArgs;
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 ad_domain = new Domain("ad-domain", DomainArgs.builder()
            .domainName("tfgen.org.com")
            .locations("us-central1")
            .reservedIpRange("192.168.255.0/24")
            .deletionProtection(false)
            .build());

    }
}

resources:
  ad-domain:
    type: gcp:activedirectory:Domain
    properties:
      domainName: tfgen.org.com
      locations:
        - us-central1
      reservedIpRange: 192.168.255.0/24
      deletionProtection: false

Import

Domain can be imported using any of these accepted formats:

• {{project}}/{{name}}
• {{project}} {{name}}
• {{name}}

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

$ pulumi import gcp:activedirectory/domain:Domain default {{project}}/{{name}}
$ terraform import google_active_directory_domain.default "{{project}} {{name}}"
$ pulumi import gcp:activedirectory/domain:Domain default {{name}}

Constructors

Domain(String name, {DomainArgs? args, CustomResourceOptions? options})

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

Domain.reference(String urn)

Creates a typed reference to an existing Domain resource.

Properties

admin ↔ Output<String?>

The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.

late, final

authorizedNetworks ↔ Output<List<String>?>

The full names of the Google Compute Engine networks the domain instance is connected to. The domain is only available on networks listed in authorizedNetworks. If CIDR subnets overlap between networks, domain creation will fail.

late, final

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

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

deletionProtection ↔ Output<bool?>

Whether Terraform will be prevented from destroying the domain. Defaults to true. When aterraform destroy or pulumi up would delete the domain, the command will fail if this field is not set to false in Terraform state. When the field is set to true or unset in Terraform state, a pulumi up or terraform destroy that would delete the domain will fail. When the field is set to false, deleting the domain is allowed.

late, final

domainName ↔ Output<String>

The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions of https://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains.

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

fqdn ↔ Output<String>

The fully-qualified domain name of the exposed domain used by clients to connect to the service. Similar to what would be chosen for an Active Directory set up on an internal network.

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

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

Resource labels that can contain user-provided metadata Note: This field is non-authoritative, and will only manage the labels present in your configuration. Please refer to the field effectiveLabels for all of the labels present on the resource.

late, final

locations ↔ Output<List<String>>

Locations where domain needs to be provisioned. compute/docs/regions-zones/ e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.

late, final

name ↔ Output<String>

The unique name of the domain using the format: projects/{project}/locations/global/domains/{domainName}.

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

reservedIpRange ↔ Output<String>

The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger. Ranges must be unique and non-overlapping with existing subnets in authorizedNetworks

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

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

urn ↔ Output<String>

late, final, inherited

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, {DomainState? state, CustomResourceOptions? options}) → Domain

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