Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. activedirectory
  5. Domain
Google Cloud v8.30.1 published on Tuesday, May 13, 2025 by Pulumi
pulumi/pulumi-gcp

gcp.activedirectory.Domain

Explore with Pulumi AI

gcp logo
Google Cloud v8.30.1 published on Tuesday, May 13, 2025 by Pulumi
pulumi/pulumi-gcp

    Creates a Microsoft AD domain

    To get more information about Domain, see:

    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)

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v8/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
	})
}

    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 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.List;
import java.util.ArrayList;
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

    Create Domain Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
    @overload
def Domain(resource_name: str,
           args: DomainArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           domain_name: Optional[str] = None,
           locations: Optional[Sequence[str]] = None,
           reserved_ip_range: Optional[str] = None,
           admin: Optional[str] = None,
           authorized_networks: Optional[Sequence[str]] = None,
           deletion_protection: Optional[bool] = None,
           labels: Optional[Mapping[str, str]] = None,
           project: Optional[str] = None)
    func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
    public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
    public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)

    type: gcp:activedirectory:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var domainResource = new Gcp.ActiveDirectory.Domain("domainResource", new()
{
    DomainName = "string",
    Locations = new[]
    {
        "string",
    },
    ReservedIpRange = "string",
    Admin = "string",
    AuthorizedNetworks = new[]
    {
        "string",
    },
    DeletionProtection = false,
    Labels = 
    {
        { "string", "string" },
    },
    Project = "string",
});

    example, err := activedirectory.NewDomain(ctx, "domainResource", &activedirectory.DomainArgs{
	DomainName: pulumi.String("string"),
	Locations: pulumi.StringArray{
		pulumi.String("string"),
	},
	ReservedIpRange: pulumi.String("string"),
	Admin:           pulumi.String("string"),
	AuthorizedNetworks: pulumi.StringArray{
		pulumi.String("string"),
	},
	DeletionProtection: pulumi.Bool(false),
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})

    var domainResource = new Domain("domainResource", DomainArgs.builder()
    .domainName("string")
    .locations("string")
    .reservedIpRange("string")
    .admin("string")
    .authorizedNetworks("string")
    .deletionProtection(false)
    .labels(Map.of("string", "string"))
    .project("string")
    .build());

    domain_resource = gcp.activedirectory.Domain("domainResource",
    domain_name="string",
    locations=["string"],
    reserved_ip_range="string",
    admin="string",
    authorized_networks=["string"],
    deletion_protection=False,
    labels={
        "string": "string",
    },
    project="string")

    const domainResource = new gcp.activedirectory.Domain("domainResource", {
    domainName: "string",
    locations: ["string"],
    reservedIpRange: "string",
    admin: "string",
    authorizedNetworks: ["string"],
    deletionProtection: false,
    labels: {
        string: "string",
    },
    project: "string",
});

    type: gcp:activedirectory:Domain
properties:
    admin: string
    authorizedNetworks:
        - string
    deletionProtection: false
    domainName: string
    labels:
        string: string
    locations:
        - string
    project: string
    reservedIpRange: string

    Domain Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Domain resource accepts the following input properties:

    DomainName 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.

    Locations List<string>
    Locations where domain needs to be provisioned. [regions][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.
    ReservedIpRange 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
    Admin string
    The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
    AuthorizedNetworks 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.
    DeletionProtection bool
    Labels Dictionary<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 effective_labels for all of the labels present on the resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    DomainName 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.

    Locations []string
    Locations where domain needs to be provisioned. [regions][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.
    ReservedIpRange 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
    Admin string
    The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
    AuthorizedNetworks []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.
    DeletionProtection bool
    Labels 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 effective_labels for all of the labels present on the resource.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    domainName 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.

    locations List<String>
    Locations where domain needs to be provisioned. [regions][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.
    reservedIpRange 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
    admin String
    The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
    authorizedNetworks 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.
    deletionProtection Boolean
    labels 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 effective_labels for all of the labels present on the resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    domainName 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.

    locations string[]
    Locations where domain needs to be provisioned. [regions][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.
    reservedIpRange 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
    admin string
    The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
    authorizedNetworks 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.
    deletionProtection boolean
    labels {[key: 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 effective_labels for all of the labels present on the resource.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    domain_name str
    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.

    locations Sequence[str]
    Locations where domain needs to be provisioned. [regions][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.
    reserved_ip_range str
    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
    admin str
    The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
    authorized_networks Sequence[str]
    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.
    deletion_protection bool
    labels Mapping[str, str]
    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 effective_labels for all of the labels present on the resource.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    domainName 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.

    locations List<String>
    Locations where domain needs to be provisioned. [regions][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.
    reservedIpRange 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
    admin String
    The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
    authorizedNetworks 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.
    deletionProtection Boolean
    labels Map<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 effective_labels for all of the labels present on the resource.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:

    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Fqdn 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique name of the domain using the format: projects/{project}/locations/global/domains/{domainName}.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    EffectiveLabels 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.
    Fqdn 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.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The unique name of the domain using the format: projects/{project}/locations/global/domains/{domainName}.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    effectiveLabels 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.
    fqdn 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.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique name of the domain using the format: projects/{project}/locations/global/domains/{domainName}.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    fqdn 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.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The unique name of the domain using the format: projects/{project}/locations/global/domains/{domainName}.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    fqdn str
    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.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The unique name of the domain using the format: projects/{project}/locations/global/domains/{domainName}.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    fqdn 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.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The unique name of the domain using the format: projects/{project}/locations/global/domains/{domainName}.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.

    Look up Existing Domain Resource

    Get an existing Domain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DomainState, opts?: CustomResourceOptions): Domain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        admin: Optional[str] = None,
        authorized_networks: Optional[Sequence[str]] = None,
        deletion_protection: Optional[bool] = None,
        domain_name: Optional[str] = None,
        effective_labels: Optional[Mapping[str, str]] = None,
        fqdn: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        locations: Optional[Sequence[str]] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        pulumi_labels: Optional[Mapping[str, str]] = None,
        reserved_ip_range: Optional[str] = None) -> Domain
    func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
    public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
    public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)
    resources:  _:    type: gcp:activedirectory:Domain    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Admin string
    The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
    AuthorizedNetworks 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.
    DeletionProtection bool
    DomainName 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.

    EffectiveLabels Dictionary<string, string>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    Fqdn 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.
    Labels Dictionary<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 effective_labels for all of the labels present on the resource.
    Locations List<string>
    Locations where domain needs to be provisioned. [regions][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.
    Name string
    The unique name of the domain using the format: projects/{project}/locations/global/domains/{domainName}.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels Dictionary<string, string>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    ReservedIpRange 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
    Admin string
    The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
    AuthorizedNetworks []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.
    DeletionProtection bool
    DomainName 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.

    EffectiveLabels 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.
    Fqdn 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.
    Labels 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 effective_labels for all of the labels present on the resource.
    Locations []string
    Locations where domain needs to be provisioned. [regions][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.
    Name string
    The unique name of the domain using the format: projects/{project}/locations/global/domains/{domainName}.
    Project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    PulumiLabels map[string]string
    The combination of labels configured directly on the resource and default labels configured on the provider.
    ReservedIpRange 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
    admin String
    The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
    authorizedNetworks 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.
    deletionProtection Boolean
    domainName 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.

    effectiveLabels 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.
    fqdn 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.
    labels 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 effective_labels for all of the labels present on the resource.
    locations List<String>
    Locations where domain needs to be provisioned. [regions][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.
    name String
    The unique name of the domain using the format: projects/{project}/locations/global/domains/{domainName}.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String,String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reservedIpRange 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
    admin string
    The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
    authorizedNetworks 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.
    deletionProtection boolean
    domainName 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.

    effectiveLabels {[key: string]: string}
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    fqdn 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.
    labels {[key: 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 effective_labels for all of the labels present on the resource.
    locations string[]
    Locations where domain needs to be provisioned. [regions][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.
    name string
    The unique name of the domain using the format: projects/{project}/locations/global/domains/{domainName}.
    project string
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels {[key: string]: string}
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reservedIpRange 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
    admin str
    The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
    authorized_networks Sequence[str]
    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.
    deletion_protection bool
    domain_name str
    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.

    effective_labels Mapping[str, str]
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    fqdn str
    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.
    labels Mapping[str, str]
    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 effective_labels for all of the labels present on the resource.
    locations Sequence[str]
    Locations where domain needs to be provisioned. [regions][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.
    name str
    The unique name of the domain using the format: projects/{project}/locations/global/domains/{domainName}.
    project str
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumi_labels Mapping[str, str]
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reserved_ip_range str
    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
    admin String
    The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
    authorizedNetworks 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.
    deletionProtection Boolean
    domainName 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.

    effectiveLabels Map<String>
    All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
    fqdn 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.
    labels Map<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 effective_labels for all of the labels present on the resource.
    locations List<String>
    Locations where domain needs to be provisioned. [regions][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.
    name String
    The unique name of the domain using the format: projects/{project}/locations/global/domains/{domainName}.
    project String
    The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
    pulumiLabels Map<String>
    The combination of labels configured directly on the resource and default labels configured on the provider.
    reservedIpRange 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

    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}}

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

    $ pulumi import gcp:activedirectory/domain:Domain default {{name}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud v8.30.1 published on Tuesday, May 13, 2025 by Pulumi
    pulumi/pulumi-gcp