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

nsxt.PolicyEvpnTenant

Explore with Pulumi AI

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

    Create PolicyEvpnTenant Resource

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

    Constructor syntax

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

@overload
def PolicyEvpnTenant(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     display_name: Optional[str] = None,
                     mappings: Optional[Sequence[PolicyEvpnTenantMappingArgs]] = None,
                     transport_zone_path: Optional[str] = None,
                     vni_pool_path: Optional[str] = None,
                     description: Optional[str] = None,
                     nsx_id: Optional[str] = None,
                     policy_evpn_tenant_id: Optional[str] = None,
                     tags: Optional[Sequence[PolicyEvpnTenantTagArgs]] = None)
    func NewPolicyEvpnTenant(ctx *Context, name string, args PolicyEvpnTenantArgs, opts ...ResourceOption) (*PolicyEvpnTenant, error)
    public PolicyEvpnTenant(string name, PolicyEvpnTenantArgs args, CustomResourceOptions? opts = null)
    public PolicyEvpnTenant(String name, PolicyEvpnTenantArgs args)
public PolicyEvpnTenant(String name, PolicyEvpnTenantArgs args, CustomResourceOptions options)

    type: nsxt:PolicyEvpnTenant
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 PolicyEvpnTenantArgs
    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 PolicyEvpnTenantArgs
    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 PolicyEvpnTenantArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args PolicyEvpnTenantArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args PolicyEvpnTenantArgs
    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 policyEvpnTenantResource = new Nsxt.PolicyEvpnTenant("policyEvpnTenantResource", new()
{
    DisplayName = "string",
    Mappings = new[]
    {
        new Nsxt.Inputs.PolicyEvpnTenantMappingArgs
        {
            Vlans = "string",
            Vnis = "string",
        },
    },
    TransportZonePath = "string",
    VniPoolPath = "string",
    Description = "string",
    NsxId = "string",
    PolicyEvpnTenantId = "string",
    Tags = new[]
    {
        new Nsxt.Inputs.PolicyEvpnTenantTagArgs
        {
            Scope = "string",
            Tag = "string",
        },
    },
});

    example, err := nsxt.NewPolicyEvpnTenant(ctx, "policyEvpnTenantResource", &nsxt.PolicyEvpnTenantArgs{
	DisplayName: pulumi.String("string"),
	Mappings: nsxt.PolicyEvpnTenantMappingArray{
		&nsxt.PolicyEvpnTenantMappingArgs{
			Vlans: pulumi.String("string"),
			Vnis:  pulumi.String("string"),
		},
	},
	TransportZonePath:  pulumi.String("string"),
	VniPoolPath:        pulumi.String("string"),
	Description:        pulumi.String("string"),
	NsxId:              pulumi.String("string"),
	PolicyEvpnTenantId: pulumi.String("string"),
	Tags: nsxt.PolicyEvpnTenantTagArray{
		&nsxt.PolicyEvpnTenantTagArgs{
			Scope: pulumi.String("string"),
			Tag:   pulumi.String("string"),
		},
	},
})

    var policyEvpnTenantResource = new PolicyEvpnTenant("policyEvpnTenantResource", PolicyEvpnTenantArgs.builder()
    .displayName("string")
    .mappings(PolicyEvpnTenantMappingArgs.builder()
        .vlans("string")
        .vnis("string")
        .build())
    .transportZonePath("string")
    .vniPoolPath("string")
    .description("string")
    .nsxId("string")
    .policyEvpnTenantId("string")
    .tags(PolicyEvpnTenantTagArgs.builder()
        .scope("string")
        .tag("string")
        .build())
    .build());

    policy_evpn_tenant_resource = nsxt.PolicyEvpnTenant("policyEvpnTenantResource",
    display_name="string",
    mappings=[{
        "vlans": "string",
        "vnis": "string",
    }],
    transport_zone_path="string",
    vni_pool_path="string",
    description="string",
    nsx_id="string",
    policy_evpn_tenant_id="string",
    tags=[{
        "scope": "string",
        "tag": "string",
    }])

    const policyEvpnTenantResource = new nsxt.PolicyEvpnTenant("policyEvpnTenantResource", {
    displayName: "string",
    mappings: [{
        vlans: "string",
        vnis: "string",
    }],
    transportZonePath: "string",
    vniPoolPath: "string",
    description: "string",
    nsxId: "string",
    policyEvpnTenantId: "string",
    tags: [{
        scope: "string",
        tag: "string",
    }],
});

    type: nsxt:PolicyEvpnTenant
properties:
    description: string
    displayName: string
    mappings:
        - vlans: string
          vnis: string
    nsxId: string
    policyEvpnTenantId: string
    tags:
        - scope: string
          tag: string
    transportZonePath: string
    vniPoolPath: string

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

    DisplayName string
    Display name of the resource.
    Mappings List<PolicyEvpnTenantMapping>
    List of VLAN - VNI mappings for this tenant.
    TransportZonePath string
    Policy path for Overlay Transport Zone.
    VniPoolPath string
    Policy path for existing VNI pool.
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    PolicyEvpnTenantId string
    Tags List<PolicyEvpnTenantTag>
    A list of scope + tag pairs to associate with this resource.
    DisplayName string
    Display name of the resource.
    Mappings []PolicyEvpnTenantMappingArgs
    List of VLAN - VNI mappings for this tenant.
    TransportZonePath string
    Policy path for Overlay Transport Zone.
    VniPoolPath string
    Policy path for existing VNI pool.
    Description string
    Description of the resource.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    PolicyEvpnTenantId string
    Tags []PolicyEvpnTenantTagArgs
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    mappings List<PolicyEvpnTenantMapping>
    List of VLAN - VNI mappings for this tenant.
    transportZonePath String
    Policy path for Overlay Transport Zone.
    vniPoolPath String
    Policy path for existing VNI pool.
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyEvpnTenantId String
    tags List<PolicyEvpnTenantTag>
    A list of scope + tag pairs to associate with this resource.
    displayName string
    Display name of the resource.
    mappings PolicyEvpnTenantMapping[]
    List of VLAN - VNI mappings for this tenant.
    transportZonePath string
    Policy path for Overlay Transport Zone.
    vniPoolPath string
    Policy path for existing VNI pool.
    description string
    Description of the resource.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyEvpnTenantId string
    tags PolicyEvpnTenantTag[]
    A list of scope + tag pairs to associate with this resource.
    display_name str
    Display name of the resource.
    mappings Sequence[PolicyEvpnTenantMappingArgs]
    List of VLAN - VNI mappings for this tenant.
    transport_zone_path str
    Policy path for Overlay Transport Zone.
    vni_pool_path str
    Policy path for existing VNI pool.
    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 policy resource.
    policy_evpn_tenant_id str
    tags Sequence[PolicyEvpnTenantTagArgs]
    A list of scope + tag pairs to associate with this resource.
    displayName String
    Display name of the resource.
    mappings List<Property Map>
    List of VLAN - VNI mappings for this tenant.
    transportZonePath String
    Policy path for Overlay Transport Zone.
    vniPoolPath String
    Policy path for existing VNI pool.
    description String
    Description of the resource.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    policyEvpnTenantId String
    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 PolicyEvpnTenant 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 PolicyEvpnTenant Resource

    Get an existing PolicyEvpnTenant 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?: PolicyEvpnTenantState, opts?: CustomResourceOptions): PolicyEvpnTenant
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        mappings: Optional[Sequence[PolicyEvpnTenantMappingArgs]] = None,
        nsx_id: Optional[str] = None,
        path: Optional[str] = None,
        policy_evpn_tenant_id: Optional[str] = None,
        revision: Optional[float] = None,
        tags: Optional[Sequence[PolicyEvpnTenantTagArgs]] = None,
        transport_zone_path: Optional[str] = None,
        vni_pool_path: Optional[str] = None) -> PolicyEvpnTenant
    func GetPolicyEvpnTenant(ctx *Context, name string, id IDInput, state *PolicyEvpnTenantState, opts ...ResourceOption) (*PolicyEvpnTenant, error)
    public static PolicyEvpnTenant Get(string name, Input<string> id, PolicyEvpnTenantState? state, CustomResourceOptions? opts = null)
    public static PolicyEvpnTenant get(String name, Output<String> id, PolicyEvpnTenantState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:PolicyEvpnTenant    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.
    Mappings List<PolicyEvpnTenantMapping>
    List of VLAN - VNI mappings for this tenant.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    Path string
    The NSX path of the policy resource.
    PolicyEvpnTenantId string
    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<PolicyEvpnTenantTag>
    A list of scope + tag pairs to associate with this resource.
    TransportZonePath string
    Policy path for Overlay Transport Zone.
    VniPoolPath string
    Policy path for existing VNI pool.
    Description string
    Description of the resource.
    DisplayName string
    Display name of the resource.
    Mappings []PolicyEvpnTenantMappingArgs
    List of VLAN - VNI mappings for this tenant.
    NsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    Path string
    The NSX path of the policy resource.
    PolicyEvpnTenantId string
    Revision float64
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    Tags []PolicyEvpnTenantTagArgs
    A list of scope + tag pairs to associate with this resource.
    TransportZonePath string
    Policy path for Overlay Transport Zone.
    VniPoolPath string
    Policy path for existing VNI pool.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    mappings List<PolicyEvpnTenantMapping>
    List of VLAN - VNI mappings for this tenant.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path String
    The NSX path of the policy resource.
    policyEvpnTenantId String
    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<PolicyEvpnTenantTag>
    A list of scope + tag pairs to associate with this resource.
    transportZonePath String
    Policy path for Overlay Transport Zone.
    vniPoolPath String
    Policy path for existing VNI pool.
    description string
    Description of the resource.
    displayName string
    Display name of the resource.
    mappings PolicyEvpnTenantMapping[]
    List of VLAN - VNI mappings for this tenant.
    nsxId string
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path string
    The NSX path of the policy resource.
    policyEvpnTenantId string
    revision number
    Indicates current revision number of the object as seen by NSX-T API server. This attribute can be useful for debugging.
    tags PolicyEvpnTenantTag[]
    A list of scope + tag pairs to associate with this resource.
    transportZonePath string
    Policy path for Overlay Transport Zone.
    vniPoolPath string
    Policy path for existing VNI pool.
    description str
    Description of the resource.
    display_name str
    Display name of the resource.
    mappings Sequence[PolicyEvpnTenantMappingArgs]
    List of VLAN - VNI mappings for this tenant.
    nsx_id str
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path str
    The NSX path of the policy resource.
    policy_evpn_tenant_id str
    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[PolicyEvpnTenantTagArgs]
    A list of scope + tag pairs to associate with this resource.
    transport_zone_path str
    Policy path for Overlay Transport Zone.
    vni_pool_path str
    Policy path for existing VNI pool.
    description String
    Description of the resource.
    displayName String
    Display name of the resource.
    mappings List<Property Map>
    List of VLAN - VNI mappings for this tenant.
    nsxId String
    The NSX ID of this resource. If set, this ID will be used to create the policy resource.
    path String
    The NSX path of the policy resource.
    policyEvpnTenantId String
    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.
    transportZonePath String
    Policy path for Overlay Transport Zone.
    vniPoolPath String
    Policy path for existing VNI pool.

    Supporting Types

    PolicyEvpnTenantMapping, PolicyEvpnTenantMappingArgs

    Vlans string
    Single VLAN Id or range of VLAN Ids.
    Vnis string
    Single VNI or range of VNIs. Please note that the range should match the range of vlans exactly.
    Vlans string
    Single VLAN Id or range of VLAN Ids.
    Vnis string
    Single VNI or range of VNIs. Please note that the range should match the range of vlans exactly.
    vlans String
    Single VLAN Id or range of VLAN Ids.
    vnis String
    Single VNI or range of VNIs. Please note that the range should match the range of vlans exactly.
    vlans string
    Single VLAN Id or range of VLAN Ids.
    vnis string
    Single VNI or range of VNIs. Please note that the range should match the range of vlans exactly.
    vlans str
    Single VLAN Id or range of VLAN Ids.
    vnis str
    Single VNI or range of VNIs. Please note that the range should match the range of vlans exactly.
    vlans String
    Single VLAN Id or range of VLAN Ids.
    vnis String
    Single VNI or range of VNIs. Please note that the range should match the range of vlans exactly.

    PolicyEvpnTenantTag, PolicyEvpnTenantTagArgs

    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.
    nsxt logo
    nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware
    vmware/terraform-provider-nsxt