Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Nsxt Provider
  3. API Docs
  4. PolicyDomain
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

nsxt.PolicyDomain

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
vmware/terraform-provider-nsxt

    Create PolicyDomain Resource

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

    Constructor syntax

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

@overload
def PolicyDomain(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 display_name: Optional[str] = None,
                 sites: Optional[Sequence[str]] = None,
                 description: Optional[str] = None,
                 nsx_id: Optional[str] = None,
                 policy_domain_id: Optional[str] = None,
                 tags: Optional[Sequence[PolicyDomainTagArgs]] = None)
    func NewPolicyDomain(ctx *Context, name string, args PolicyDomainArgs, opts ...ResourceOption) (*PolicyDomain, error)
    public PolicyDomain(string name, PolicyDomainArgs args, CustomResourceOptions? opts = null)
    public PolicyDomain(String name, PolicyDomainArgs args)
public PolicyDomain(String name, PolicyDomainArgs args, CustomResourceOptions options)

    type: nsxt:PolicyDomain
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 PolicyDomainArgs
    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 PolicyDomainArgs
    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 PolicyDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyDomainArgs
    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 policyDomainResource = new Nsxt.PolicyDomain("policyDomainResource", new()
{
    DisplayName = "string",
    Sites = new[]
    {
        "string",
    },
    Description = "string",
    NsxId = "string",
    PolicyDomainId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyDomainTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyDomain(ctx, "policyDomainResource", &nsxt.PolicyDomainArgs{
	DisplayName: pulumi.String("string"),
	Sites: pulumi.StringArray{
		pulumi.String("string"),
	},
	Description:    pulumi.String("string"),
	NsxId:          pulumi.String("string"),
	PolicyDomainId: pulumi.String("string"),
	Tags: nsxt.PolicyDomainTagArray{
		&nsxt.PolicyDomainTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyDomainResource = new PolicyDomain("policyDomainResource", PolicyDomainArgs.builder()
    .displayName("string")
    .sites("string")
    .description("string")
    .nsxId("string")
    .policyDomainId("string")
    .tags(PolicyDomainTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_domain_resource = nsxt.PolicyDomain("policyDomainResource",
    display_name="string",
    sites=["string"],
    description="string",
    nsx_id="string",
    policy_domain_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyDomainResource = new nsxt.PolicyDomain("policyDomainResource", {
    displayName: "string",
    sites: ["string"],
    description: "string",
    nsxId: "string",
    policyDomainId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyDomain
properties:
    description: string
    displayName: string
    nsxId: string
    policyDomainId: string
    sites:
        - string
    tags:
        - scope: string
          tag: string

    PolicyDomain 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 PolicyDomain resource accepts the following input properties:

    DisplayName string
    Display name of the resource.
    Sites List<string>
    A list of sites (a.k.a locations) for this domain.
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the Domain resource.
    PolicyDomainId string
    ID of the Domain.
    Tags List<PolicyDomainTag>
    A list of scope + tag pairs to associate with this Domain.
    DisplayName string
    Display name of the resource.
    Sites []string
    A list of sites (a.k.a locations) for this domain.
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the Domain resource.
    PolicyDomainId string
    ID of the Domain.
    Tags []PolicyDomainTagArgs
    A list of scope + tag pairs to associate with this Domain.
    displayName String
    Display name of the resource.
    sites List<String>
    A list of sites (a.k.a locations) for this domain.
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the Domain resource.
    policyDomainId String
    ID of the Domain.
    tags List<PolicyDomainTag>
    A list of scope + tag pairs to associate with this Domain.
    displayName string
    Display name of the resource.
    sites string[]
    A list of sites (a.k.a locations) for this domain.
    description string
    Description of the resource.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the Domain resource.
    policyDomainId string
    ID of the Domain.
    tags PolicyDomainTag[]
    A list of scope + tag pairs to associate with this Domain.
    display_name str
    Display name of the resource.
    sites Sequence[str]
    A list of sites (a.k.a locations) for this domain.
    description str
    Description of the resource.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the Domain resource.
    policy_domain_id str
    ID of the Domain.
    tags Sequence[PolicyDomainTagArgs]
    A list of scope + tag pairs to associate with this Domain.
    displayName String
    Display name of the resource.
    sites List<String>
    A list of sites (a.k.a locations) for this domain.
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the Domain resource.
    policyDomainId String
    ID of the Domain.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this Domain.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Id string
    The provider-assigned unique ID for this managed resource.
    Path string
    The NSX path of the policy resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id string
    The provider-assigned unique ID for this managed resource.
    path string
    The NSX path of the policy resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id str
    The provider-assigned unique ID for this managed resource.
    path str
    The NSX path of the policy resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    id String
    The provider-assigned unique ID for this managed resource.
    path String
    The NSX path of the policy resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.

    Look up Existing PolicyDomain Resource

    Get an existing PolicyDomain 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?: PolicyDomainState, opts?: CustomResourceOptions): PolicyDomain
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_domain_id: Optional[str] = None,
        revision: Optional[float] = None,
        sites: Optional[Sequence[str]] = None,
        tags: Optional[Sequence[PolicyDomainTagArgs]] = None) -> PolicyDomain
    func GetPolicyDomain(ctx *Context, name string, id IDInput, state *PolicyDomainState, opts ...ResourceOption) (*PolicyDomain, error)
    public static PolicyDomain Get(string name, Input<string> id, PolicyDomainState? state, CustomResourceOptions? opts = null)
    public static PolicyDomain get(String name, Output<String> id, PolicyDomainState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyDomain    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:
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the Domain resource.
    Path string
    The NSX path of the policy resource.
    PolicyDomainId string
    ID of the Domain.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Sites List<string>
    A list of sites (a.k.a locations) for this domain.
    Tags List<PolicyDomainTag>
    A list of scope + tag pairs to associate with this Domain.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the Domain resource.
    Path string
    The NSX path of the policy resource.
    PolicyDomainId string
    ID of the Domain.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Sites []string
    A list of sites (a.k.a locations) for this domain.
    Tags []PolicyDomainTagArgs
    A list of scope + tag pairs to associate with this Domain.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the Domain resource.
    path String
    The NSX path of the policy resource.
    policyDomainId String
    ID of the Domain.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    sites List<String>
    A list of sites (a.k.a locations) for this domain.
    tags List<PolicyDomainTag>
    A list of scope + tag pairs to associate with this Domain.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the Domain resource.
    path string
    The NSX path of the policy resource.
    policyDomainId string
    ID of the Domain.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    sites string[]
    A list of sites (a.k.a locations) for this domain.
    tags PolicyDomainTag[]
    A list of scope + tag pairs to associate with this Domain.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the Domain resource.
    path str
    The NSX path of the policy resource.
    policy_domain_id str
    ID of the Domain.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    sites Sequence[str]
    A list of sites (a.k.a locations) for this domain.
    tags Sequence[PolicyDomainTagArgs]
    A list of scope + tag pairs to associate with this Domain.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the Domain resource.
    path String
    The NSX path of the policy resource.
    policyDomainId String
    ID of the Domain.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    sites List<String>
    A list of sites (a.k.a locations) for this domain.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this Domain.

    Supporting Types

    PolicyDomainTag, PolicyDomainTagArgs

    Scope string
    Tag string
    A list of scope + tag pairs to associate with this Domain.
    Scope string
    Tag string
    A list of scope + tag pairs to associate with this Domain.
    scope String
    tag String
    A list of scope + tag pairs to associate with this Domain.
    scope string
    tag string
    A list of scope + tag pairs to associate with this Domain.
    scope str
    tag str
    A list of scope + tag pairs to associate with this Domain.
    scope String
    tag String
    A list of scope + tag pairs to associate with this Domain.

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt