Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Nsxt Provider
  4. API Docs
  5. PolicyConnectivityPolicy
Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-nsxt

nsxt.PolicyConnectivityPolicy

Viewing docs for nsxt 3.12.0
published on Monday, May 18, 2026 by vmware
Schema (JSON)
vmware/terraform-provider-nsxt

    Create PolicyConnectivityPolicy Resource

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

    Constructor syntax

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

@overload
def PolicyConnectivityPolicy(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             display_name: Optional[str] = None,
                             group_path: Optional[str] = None,
                             parent_path: Optional[str] = None,
                             connectivity_scope: Optional[str] = None,
                             description: Optional[str] = None,
                             nsx_id: Optional[str] = None,
                             policy_connectivity_policy_id: Optional[str] = None,
                             tags: Optional[Sequence[PolicyConnectivityPolicyTagArgs]] = None)
    func NewPolicyConnectivityPolicy(ctx *Context, name string, args PolicyConnectivityPolicyArgs, opts ...ResourceOption) (*PolicyConnectivityPolicy, error)
    public PolicyConnectivityPolicy(string name, PolicyConnectivityPolicyArgs args, CustomResourceOptions? opts = null)
    public PolicyConnectivityPolicy(String name, PolicyConnectivityPolicyArgs args)
public PolicyConnectivityPolicy(String name, PolicyConnectivityPolicyArgs args, CustomResourceOptions options)

    type: nsxt:PolicyConnectivityPolicy
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "nsxt_policyconnectivitypolicy" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args PolicyConnectivityPolicyArgs
    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 PolicyConnectivityPolicyArgs
    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 PolicyConnectivityPolicyArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyConnectivityPolicyArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyConnectivityPolicyArgs
    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 policyConnectivityPolicyResource = new Nsxt.PolicyConnectivityPolicy("policyConnectivityPolicyResource", new()
{
    DisplayName = "string",
    GroupPath = "string",
    ParentPath = "string",
    ConnectivityScope = "string",
    Description = "string",
    NsxId = "string",
    PolicyConnectivityPolicyId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyConnectivityPolicyTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyConnectivityPolicy(ctx, "policyConnectivityPolicyResource", &nsxt.PolicyConnectivityPolicyArgs{
	DisplayName:                pulumi.String("string"),
	GroupPath:                  pulumi.String("string"),
	ParentPath:                 pulumi.String("string"),
	ConnectivityScope:          pulumi.String("string"),
	Description:                pulumi.String("string"),
	NsxId:                      pulumi.String("string"),
	PolicyConnectivityPolicyId: pulumi.String("string"),
	Tags: nsxt.PolicyConnectivityPolicyTagArray{
		&nsxt.PolicyConnectivityPolicyTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    resource "nsxt_policyconnectivitypolicy" "policyConnectivityPolicyResource" {
  display_name                  = "string"
  group_path                    = "string"
  parent_path                   = "string"
  connectivity_scope            = "string"
  description                   = "string"
  nsx_id                        = "string"
  policy_connectivity_policy_id = "string"
  tags {
    scope = "string"
    tag   = "string"
  }
}

    var policyConnectivityPolicyResource = new PolicyConnectivityPolicy("policyConnectivityPolicyResource", PolicyConnectivityPolicyArgs.builder()
    .displayName("string")
    .groupPath("string")
    .parentPath("string")
    .connectivityScope("string")
    .description("string")
    .nsxId("string")
    .policyConnectivityPolicyId("string")
    .tags(PolicyConnectivityPolicyTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_connectivity_policy_resource = nsxt.PolicyConnectivityPolicy("policyConnectivityPolicyResource",
    display_name="string",
    group_path="string",
    parent_path="string",
    connectivity_scope="string",
    description="string",
    nsx_id="string",
    policy_connectivity_policy_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyConnectivityPolicyResource = new nsxt.PolicyConnectivityPolicy("policyConnectivityPolicyResource", {
    displayName: "string",
    groupPath: "string",
    parentPath: "string",
    connectivityScope: "string",
    description: "string",
    nsxId: "string",
    policyConnectivityPolicyId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyConnectivityPolicy
properties:
    connectivityScope: string
    description: string
    displayName: string
    groupPath: string
    nsxId: string
    parentPath: string
    policyConnectivityPolicyId: string
    tags:
        - scope: string
          tag: string

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

    DisplayName string
    Display name of the resource.
    GroupPath string
    Path of group that the policy is applied to.
    ParentPath string
    Path of parent transit gateway.
    ConnectivityScope string
    Either COMMUNITY, ISOLATED or PROMISCUOUS. Default is COMMUNITY.
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyConnectivityPolicyId string
    ID of the resource.
    Tags List<PolicyConnectivityPolicyTag>
    A list of scope + tag pairs to associate with this resource.
    DisplayName string
    Display name of the resource.
    GroupPath string
    Path of group that the policy is applied to.
    ParentPath string
    Path of parent transit gateway.
    ConnectivityScope string
    Either COMMUNITY, ISOLATED or PROMISCUOUS. Default is COMMUNITY.
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    PolicyConnectivityPolicyId string
    ID of the resource.
    Tags []PolicyConnectivityPolicyTagArgs
    A list of scope + tag pairs to associate with this resource.
    display_name string
    Display name of the resource.
    group_path string
    Path of group that the policy is applied to.
    parent_path string
    Path of parent transit gateway.
    connectivity_scope string
    Either COMMUNITY, ISOLATED or PROMISCUOUS. Default is COMMUNITY.
    description string
    Description of the resource.
    nsx_id string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policy_connectivity_policy_id string
    ID of the resource.
    tags list(object)
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    groupPath String
    Path of group that the policy is applied to.
    parentPath String
    Path of parent transit gateway.
    connectivityScope String
    Either COMMUNITY, ISOLATED or PROMISCUOUS. Default is COMMUNITY.
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyConnectivityPolicyId String
    ID of the resource.
    tags List<PolicyConnectivityPolicyTag>
    A list of scope + tag pairs to associate with this resource.
    displayName string
    Display name of the resource.
    groupPath string
    Path of group that the policy is applied to.
    parentPath string
    Path of parent transit gateway.
    connectivityScope string
    Either COMMUNITY, ISOLATED or PROMISCUOUS. Default is COMMUNITY.
    description string
    Description of the resource.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyConnectivityPolicyId string
    ID of the resource.
    tags PolicyConnectivityPolicyTag[]
    A list of scope + tag pairs to associate with this resource.
    display_name str
    Display name of the resource.
    group_path str
    Path of group that the policy is applied to.
    parent_path str
    Path of parent transit gateway.
    connectivity_scope str
    Either COMMUNITY, ISOLATED or PROMISCUOUS. Default is COMMUNITY.
    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 resource.
    policy_connectivity_policy_id str
    ID of the resource.
    tags Sequence[PolicyConnectivityPolicyTagArgs]
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    groupPath String
    Path of group that the policy is applied to.
    parentPath String
    Path of parent transit gateway.
    connectivityScope String
    Either COMMUNITY, ISOLATED or PROMISCUOUS. Default is COMMUNITY.
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    policyConnectivityPolicyId String
    ID of the resource.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    InternalId double
    Internal ID of the 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.
    InternalId float64
    Internal ID of the 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.
    internal_id number
    Internal ID of the 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 String
    The provider-assigned unique ID for this managed resource.
    internalId Double
    Internal ID of the 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.
    internalId number
    Internal ID of the 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.
    internal_id float
    Internal ID of the 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.
    internalId Number
    Internal ID of the 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 PolicyConnectivityPolicy Resource

    Get an existing PolicyConnectivityPolicy 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?: PolicyConnectivityPolicyState, opts?: CustomResourceOptions): PolicyConnectivityPolicy
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        connectivity_scope: Optional[str] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        group_path: Optional[str] = None,
        internal_id: Optional[float] = None,
        nsx_id: Optional[str] = None,
        parent_path: Optional[str] = None,
        path: Optional[str] = None,
        policy_connectivity_policy_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyConnectivityPolicyTagArgs]] = None) -> PolicyConnectivityPolicy
    func GetPolicyConnectivityPolicy(ctx *Context, name string, id IDInput, state *PolicyConnectivityPolicyState, opts ...ResourceOption) (*PolicyConnectivityPolicy, error)
    public static PolicyConnectivityPolicy Get(string name, Input<string> id, PolicyConnectivityPolicyState? state, CustomResourceOptions? opts = null)
    public static PolicyConnectivityPolicy get(String name, Output<String> id, PolicyConnectivityPolicyState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyConnectivityPolicy    get:      id: ${id}
    import {
  to = nsxt_policyconnectivitypolicy.example
  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:
    ConnectivityScope string
    Either COMMUNITY, ISOLATED or PROMISCUOUS. Default is COMMUNITY.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    GroupPath string
    Path of group that the policy is applied to.
    InternalId double
    Internal ID of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    ParentPath string
    Path of parent transit gateway.
    Path string
    The NSX path of the policy resource.
    PolicyConnectivityPolicyId string
    ID of the resource.
    Revision double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags List<PolicyConnectivityPolicyTag>
    A list of scope + tag pairs to associate with this resource.
    ConnectivityScope string
    Either COMMUNITY, ISOLATED or PROMISCUOUS. Default is COMMUNITY.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    GroupPath string
    Path of group that the policy is applied to.
    InternalId float64
    Internal ID of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    ParentPath string
    Path of parent transit gateway.
    Path string
    The NSX path of the policy resource.
    PolicyConnectivityPolicyId string
    ID of the resource.
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []PolicyConnectivityPolicyTagArgs
    A list of scope + tag pairs to associate with this resource.
    connectivity_scope string
    Either COMMUNITY, ISOLATED or PROMISCUOUS. Default is COMMUNITY.
    description string
    Description of the resource.
    display_name string
    Display name of the resource.
    group_path string
    Path of group that the policy is applied to.
    internal_id number
    Internal ID of the resource.
    nsx_id string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    parent_path string
    Path of parent transit gateway.
    path string
    The NSX path of the policy resource.
    policy_connectivity_policy_id string
    ID of the resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags list(object)
    A list of scope + tag pairs to associate with this resource.
    connectivityScope String
    Either COMMUNITY, ISOLATED or PROMISCUOUS. Default is COMMUNITY.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    groupPath String
    Path of group that the policy is applied to.
    internalId Double
    Internal ID of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    parentPath String
    Path of parent transit gateway.
    path String
    The NSX path of the policy resource.
    policyConnectivityPolicyId String
    ID of the resource.
    revision Double
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<PolicyConnectivityPolicyTag>
    A list of scope + tag pairs to associate with this resource.
    connectivityScope string
    Either COMMUNITY, ISOLATED or PROMISCUOUS. Default is COMMUNITY.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    groupPath string
    Path of group that the policy is applied to.
    internalId number
    Internal ID of the resource.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    parentPath string
    Path of parent transit gateway.
    path string
    The NSX path of the policy resource.
    policyConnectivityPolicyId string
    ID of the resource.
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags PolicyConnectivityPolicyTag[]
    A list of scope + tag pairs to associate with this resource.
    connectivity_scope str
    Either COMMUNITY, ISOLATED or PROMISCUOUS. Default is COMMUNITY.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    group_path str
    Path of group that the policy is applied to.
    internal_id float
    Internal ID of the resource.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    parent_path str
    Path of parent transit gateway.
    path str
    The NSX path of the policy resource.
    policy_connectivity_policy_id str
    ID of the resource.
    revision float
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags Sequence[PolicyConnectivityPolicyTagArgs]
    A list of scope + tag pairs to associate with this resource.
    connectivityScope String
    Either COMMUNITY, ISOLATED or PROMISCUOUS. Default is COMMUNITY.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    groupPath String
    Path of group that the policy is applied to.
    internalId Number
    Internal ID of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the resource.
    parentPath String
    Path of parent transit gateway.
    path String
    The NSX path of the policy resource.
    policyConnectivityPolicyId String
    ID of the resource.
    revision Number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this resource.

    Supporting Types

    PolicyConnectivityPolicyTag, PolicyConnectivityPolicyTagArgs

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

    Package Details

    Repository
    nsxt vmware/terraform-provider-nsxt
    License
    Notes
    This Pulumi package is based on the nsxt Terraform Provider.
    Viewing docs for nsxt 3.12.0
    published on Monday, May 18, 2026 by vmware
    Schema (JSON)
    vmware/terraform-provider-nsxt

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial