Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Avi Provider
  3. API Docs
  4. Labelgroup
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

avi.Labelgroup

Explore with Pulumi AI

avi logo
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-avi

    <!–

    Copyright 2021 VMware, Inc.
SPDX-License-Identifier: Mozilla Public License 2.0

    –>

    layout: “avi”

    page_title: “Avi: avi.Labelgroup” sidebar_current: “docs-avi-resource-labelgroup” description: |- Creates and manages Avi LabelGroup.

    avi.Labelgroup

    The LabelGroup resource allows the creation and management of Avi LabelGroup

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  foo:
    type: avi:Labelgroup
    properties:
      tenantRef: /api/tenant/?name=admin

    Create Labelgroup Resource

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

    Constructor syntax

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

@overload
def Labelgroup(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               configpb_attributes: Optional[Sequence[LabelgroupConfigpbAttributeArgs]] = None,
               labelgroup_id: Optional[str] = None,
               labels: Optional[Sequence[LabelgroupLabelArgs]] = None,
               name: Optional[str] = None,
               uuid: Optional[str] = None)
    func NewLabelgroup(ctx *Context, name string, args *LabelgroupArgs, opts ...ResourceOption) (*Labelgroup, error)
    public Labelgroup(string name, LabelgroupArgs? args = null, CustomResourceOptions? opts = null)
    public Labelgroup(String name, LabelgroupArgs args)
public Labelgroup(String name, LabelgroupArgs args, CustomResourceOptions options)

    type: avi:Labelgroup
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 LabelgroupArgs
    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 LabelgroupArgs
    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 LabelgroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args LabelgroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args LabelgroupArgs
    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 labelgroupResource = new Avi.Labelgroup("labelgroupResource", new()
{
    ConfigpbAttributes = new[]
    {
        new Avi.Inputs.LabelgroupConfigpbAttributeArgs
        {
            Version = "string",
        },
    },
    LabelgroupId = "string",
    Labels = new[]
    {
        new Avi.Inputs.LabelgroupLabelArgs
        {
            MatchLabels = new[]
            {
                new Avi.Inputs.LabelgroupLabelMatchLabelArgs
                {
                    Key = "string",
                    Values = new[]
                    {
                        "string",
                    },
                },
            },
            MatchOperation = "string",
        },
    },
    Name = "string",
    Uuid = "string",
});

    example, err := avi.NewLabelgroup(ctx, "labelgroupResource", &avi.LabelgroupArgs{
	ConfigpbAttributes: avi.LabelgroupConfigpbAttributeArray{
		&avi.LabelgroupConfigpbAttributeArgs{
			Version: pulumi.String("string"),
		},
	},
	LabelgroupId: pulumi.String("string"),
	Labels: avi.LabelgroupLabelArray{
		&avi.LabelgroupLabelArgs{
			MatchLabels: avi.LabelgroupLabelMatchLabelArray{
				&avi.LabelgroupLabelMatchLabelArgs{
					Key: pulumi.String("string"),
					Values: pulumi.StringArray{
						pulumi.String("string"),
					},
				},
			},
			MatchOperation: pulumi.String("string"),
		},
	},
	Name: pulumi.String("string"),
	Uuid: pulumi.String("string"),
})

    var labelgroupResource = new Labelgroup("labelgroupResource", LabelgroupArgs.builder()
    .configpbAttributes(LabelgroupConfigpbAttributeArgs.builder()
        .version("string")
        .build())
    .labelgroupId("string")
    .labels(LabelgroupLabelArgs.builder()
        .matchLabels(LabelgroupLabelMatchLabelArgs.builder()
            .key("string")
            .values("string")
            .build())
        .matchOperation("string")
        .build())
    .name("string")
    .uuid("string")
    .build());

    labelgroup_resource = avi.Labelgroup("labelgroupResource",
    configpb_attributes=[{
        "version": "string",
    }],
    labelgroup_id="string",
    labels=[{
        "match_labels": [{
            "key": "string",
            "values": ["string"],
        }],
        "match_operation": "string",
    }],
    name="string",
    uuid="string")

    const labelgroupResource = new avi.Labelgroup("labelgroupResource", {
    configpbAttributes: [{
        version: "string",
    }],
    labelgroupId: "string",
    labels: [{
        matchLabels: [{
            key: "string",
            values: ["string"],
        }],
        matchOperation: "string",
    }],
    name: "string",
    uuid: "string",
});

    type: avi:Labelgroup
properties:
    configpbAttributes:
        - version: string
    labelgroupId: string
    labels:
        - matchLabels:
            - key: string
              values:
                - string
          matchOperation: string
    name: string
    uuid: string

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

    ConfigpbAttributes List<LabelgroupConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LabelgroupId string
    Labels List<LabelgroupLabel>
    List of allowed or suggested labels for the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    Name string
    Name of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    ConfigpbAttributes []LabelgroupConfigpbAttributeArgs
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LabelgroupId string
    Labels []LabelgroupLabelArgs
    List of allowed or suggested labels for the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    Name string
    Name of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpbAttributes List<LabelgroupConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    labelgroupId String
    labels List<LabelgroupLabel>
    List of allowed or suggested labels for the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    name String
    Name of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpbAttributes LabelgroupConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    labelgroupId string
    labels LabelgroupLabel[]
    List of allowed or suggested labels for the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    name string
    Name of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid string
    Uuid of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpb_attributes Sequence[LabelgroupConfigpbAttributeArgs]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    labelgroup_id str
    labels Sequence[LabelgroupLabelArgs]
    List of allowed or suggested labels for the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    name str
    Name of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid str
    Uuid of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpbAttributes List<Property Map>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    labelgroupId String
    labels List<Property Map>
    List of allowed or suggested labels for the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    name String
    Name of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Labelgroup 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 Labelgroup Resource

    Get an existing Labelgroup 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?: LabelgroupState, opts?: CustomResourceOptions): Labelgroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        configpb_attributes: Optional[Sequence[LabelgroupConfigpbAttributeArgs]] = None,
        labelgroup_id: Optional[str] = None,
        labels: Optional[Sequence[LabelgroupLabelArgs]] = None,
        name: Optional[str] = None,
        uuid: Optional[str] = None) -> Labelgroup
    func GetLabelgroup(ctx *Context, name string, id IDInput, state *LabelgroupState, opts ...ResourceOption) (*Labelgroup, error)
    public static Labelgroup Get(string name, Input<string> id, LabelgroupState? state, CustomResourceOptions? opts = null)
    public static Labelgroup get(String name, Output<String> id, LabelgroupState state, CustomResourceOptions options)
    resources:  _:    type: avi:Labelgroup    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:
    ConfigpbAttributes List<LabelgroupConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LabelgroupId string
    Labels List<LabelgroupLabel>
    List of allowed or suggested labels for the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    Name string
    Name of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    ConfigpbAttributes []LabelgroupConfigpbAttributeArgs
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LabelgroupId string
    Labels []LabelgroupLabelArgs
    List of allowed or suggested labels for the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    Name string
    Name of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    Uuid string
    Uuid of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpbAttributes List<LabelgroupConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    labelgroupId String
    labels List<LabelgroupLabel>
    List of allowed or suggested labels for the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    name String
    Name of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpbAttributes LabelgroupConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    labelgroupId string
    labels LabelgroupLabel[]
    List of allowed or suggested labels for the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    name string
    Name of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid string
    Uuid of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpb_attributes Sequence[LabelgroupConfigpbAttributeArgs]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    labelgroup_id str
    labels Sequence[LabelgroupLabelArgs]
    List of allowed or suggested labels for the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    name str
    Name of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid str
    Uuid of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    configpbAttributes List<Property Map>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    labelgroupId String
    labels List<Property Map>
    List of allowed or suggested labels for the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    name String
    Name of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.
    uuid String
    Uuid of the label group. Field introduced in 20.1.5. Allowed with any value in enterprise, enterprise with cloud services edition.

    Supporting Types

    LabelgroupConfigpbAttribute, LabelgroupConfigpbAttributeArgs

    Version string
    Version string
    version String
    version string
    version String

    LabelgroupLabel, LabelgroupLabelArgs

    LabelgroupLabelMatchLabel, LabelgroupLabelMatchLabelArgs

    Key string
    Values List<string>
    Key string
    Values []string
    key String
    values List<String>
    key string
    values string[]
    key str
    values Sequence[str]
    key String
    values List<String>

    Package Details

    Repository
    avi vmware/terraform-provider-avi
    License
    Notes
    This Pulumi package is based on the avi Terraform Provider.
    avi logo
    avi 31.1.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-avi