1. Packages
  2. Nsxt Provider
  3. API Docs
  4. VmTags
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

nsxt.VmTags

Explore with Pulumi AI

nsxt logo
nsxt 3.8.1 published on Wednesday, Apr 30, 2025 by vmware

    Create VmTags Resource

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

    Constructor syntax

    new VmTags(name: string, args: VmTagsArgs, opts?: CustomResourceOptions);
    @overload
    def VmTags(resource_name: str,
               args: VmTagsArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def VmTags(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               instance_id: Optional[str] = None,
               logical_port_tags: Optional[Sequence[VmTagsLogicalPortTagArgs]] = None,
               tags: Optional[Sequence[VmTagsTagArgs]] = None,
               vm_tags_id: Optional[str] = None)
    func NewVmTags(ctx *Context, name string, args VmTagsArgs, opts ...ResourceOption) (*VmTags, error)
    public VmTags(string name, VmTagsArgs args, CustomResourceOptions? opts = null)
    public VmTags(String name, VmTagsArgs args)
    public VmTags(String name, VmTagsArgs args, CustomResourceOptions options)
    
    type: nsxt:VmTags
    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 VmTagsArgs
    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 VmTagsArgs
    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 VmTagsArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VmTagsArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VmTagsArgs
    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 vmTagsResource = new Nsxt.VmTags("vmTagsResource", new()
    {
        InstanceId = "string",
        LogicalPortTags = new[]
        {
            new Nsxt.Inputs.VmTagsLogicalPortTagArgs
            {
                Scope = "string",
                Tag = "string",
            },
        },
        Tags = new[]
        {
            new Nsxt.Inputs.VmTagsTagArgs
            {
                Scope = "string",
                Tag = "string",
            },
        },
        VmTagsId = "string",
    });
    
    example, err := nsxt.NewVmTags(ctx, "vmTagsResource", &nsxt.VmTagsArgs{
    	InstanceId: pulumi.String("string"),
    	LogicalPortTags: nsxt.VmTagsLogicalPortTagArray{
    		&nsxt.VmTagsLogicalPortTagArgs{
    			Scope: pulumi.String("string"),
    			Tag:   pulumi.String("string"),
    		},
    	},
    	Tags: nsxt.VmTagsTagArray{
    		&nsxt.VmTagsTagArgs{
    			Scope: pulumi.String("string"),
    			Tag:   pulumi.String("string"),
    		},
    	},
    	VmTagsId: pulumi.String("string"),
    })
    
    var vmTagsResource = new VmTags("vmTagsResource", VmTagsArgs.builder()
        .instanceId("string")
        .logicalPortTags(VmTagsLogicalPortTagArgs.builder()
            .scope("string")
            .tag("string")
            .build())
        .tags(VmTagsTagArgs.builder()
            .scope("string")
            .tag("string")
            .build())
        .vmTagsId("string")
        .build());
    
    vm_tags_resource = nsxt.VmTags("vmTagsResource",
        instance_id="string",
        logical_port_tags=[{
            "scope": "string",
            "tag": "string",
        }],
        tags=[{
            "scope": "string",
            "tag": "string",
        }],
        vm_tags_id="string")
    
    const vmTagsResource = new nsxt.VmTags("vmTagsResource", {
        instanceId: "string",
        logicalPortTags: [{
            scope: "string",
            tag: "string",
        }],
        tags: [{
            scope: "string",
            tag: "string",
        }],
        vmTagsId: "string",
    });
    
    type: nsxt:VmTags
    properties:
        instanceId: string
        logicalPortTags:
            - scope: string
              tag: string
        tags:
            - scope: string
              tag: string
        vmTagsId: string
    

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

    InstanceId string
    BIOS Id of the Virtual Machine.
    LogicalPortTags List<VmTagsLogicalPortTag>
    A list of scope + tag pairs to associate with all logical ports that are automatically created for this VM.
    Tags List<VmTagsTag>
    A list of scope + tag pairs to associate with this VM.
    VmTagsId string
    InstanceId string
    BIOS Id of the Virtual Machine.
    LogicalPortTags []VmTagsLogicalPortTagArgs
    A list of scope + tag pairs to associate with all logical ports that are automatically created for this VM.
    Tags []VmTagsTagArgs
    A list of scope + tag pairs to associate with this VM.
    VmTagsId string
    instanceId String
    BIOS Id of the Virtual Machine.
    logicalPortTags List<VmTagsLogicalPortTag>
    A list of scope + tag pairs to associate with all logical ports that are automatically created for this VM.
    tags List<VmTagsTag>
    A list of scope + tag pairs to associate with this VM.
    vmTagsId String
    instanceId string
    BIOS Id of the Virtual Machine.
    logicalPortTags VmTagsLogicalPortTag[]
    A list of scope + tag pairs to associate with all logical ports that are automatically created for this VM.
    tags VmTagsTag[]
    A list of scope + tag pairs to associate with this VM.
    vmTagsId string
    instance_id str
    BIOS Id of the Virtual Machine.
    logical_port_tags Sequence[VmTagsLogicalPortTagArgs]
    A list of scope + tag pairs to associate with all logical ports that are automatically created for this VM.
    tags Sequence[VmTagsTagArgs]
    A list of scope + tag pairs to associate with this VM.
    vm_tags_id str
    instanceId String
    BIOS Id of the Virtual Machine.
    logicalPortTags List<Property Map>
    A list of scope + tag pairs to associate with all logical ports that are automatically created for this VM.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this VM.
    vmTagsId String

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VmTags Resource

    Get an existing VmTags 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?: VmTagsState, opts?: CustomResourceOptions): VmTags
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            instance_id: Optional[str] = None,
            logical_port_tags: Optional[Sequence[VmTagsLogicalPortTagArgs]] = None,
            tags: Optional[Sequence[VmTagsTagArgs]] = None,
            vm_tags_id: Optional[str] = None) -> VmTags
    func GetVmTags(ctx *Context, name string, id IDInput, state *VmTagsState, opts ...ResourceOption) (*VmTags, error)
    public static VmTags Get(string name, Input<string> id, VmTagsState? state, CustomResourceOptions? opts = null)
    public static VmTags get(String name, Output<String> id, VmTagsState state, CustomResourceOptions options)
    resources:  _:    type: nsxt:VmTags    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:
    InstanceId string
    BIOS Id of the Virtual Machine.
    LogicalPortTags List<VmTagsLogicalPortTag>
    A list of scope + tag pairs to associate with all logical ports that are automatically created for this VM.
    Tags List<VmTagsTag>
    A list of scope + tag pairs to associate with this VM.
    VmTagsId string
    InstanceId string
    BIOS Id of the Virtual Machine.
    LogicalPortTags []VmTagsLogicalPortTagArgs
    A list of scope + tag pairs to associate with all logical ports that are automatically created for this VM.
    Tags []VmTagsTagArgs
    A list of scope + tag pairs to associate with this VM.
    VmTagsId string
    instanceId String
    BIOS Id of the Virtual Machine.
    logicalPortTags List<VmTagsLogicalPortTag>
    A list of scope + tag pairs to associate with all logical ports that are automatically created for this VM.
    tags List<VmTagsTag>
    A list of scope + tag pairs to associate with this VM.
    vmTagsId String
    instanceId string
    BIOS Id of the Virtual Machine.
    logicalPortTags VmTagsLogicalPortTag[]
    A list of scope + tag pairs to associate with all logical ports that are automatically created for this VM.
    tags VmTagsTag[]
    A list of scope + tag pairs to associate with this VM.
    vmTagsId string
    instance_id str
    BIOS Id of the Virtual Machine.
    logical_port_tags Sequence[VmTagsLogicalPortTagArgs]
    A list of scope + tag pairs to associate with all logical ports that are automatically created for this VM.
    tags Sequence[VmTagsTagArgs]
    A list of scope + tag pairs to associate with this VM.
    vm_tags_id str
    instanceId String
    BIOS Id of the Virtual Machine.
    logicalPortTags List<Property Map>
    A list of scope + tag pairs to associate with all logical ports that are automatically created for this VM.
    tags List<Property Map>
    A list of scope + tag pairs to associate with this VM.
    vmTagsId String

    Supporting Types

    VmTagsLogicalPortTag, VmTagsLogicalPortTagArgs

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

    VmTagsTag, VmTagsTagArgs

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

    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