avi.getLabelgroup

Explore with Pulumi AI

avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

<!–

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

–>

layout: “avi”

page_title: “AVI: avi.Labelgroup” sidebar_current: “docs-avi-datasource-labelgroup” description: |- Get information of Avi LabelGroup.

avi.Labelgroup

This data source is used to to get avi.Labelgroup objects.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as avi from "@pulumi/avi";

const fooLabelgroup = avi.getLabelgroup({
    name: "foo",
    uuid: "labelgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
});

import pulumi
import pulumi_avi as avi

foo_labelgroup = avi.get_labelgroup(name="foo",
    uuid="labelgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b")

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/avi/v31/avi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := avi.LookupLabelgroup(ctx, &avi.LookupLabelgroupArgs{
			Name: pulumi.StringRef("foo"),
			Uuid: pulumi.StringRef("labelgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Avi = Pulumi.Avi;

return await Deployment.RunAsync(() => 
{
    var fooLabelgroup = Avi.GetLabelgroup.Invoke(new()
    {
        Name = "foo",
        Uuid = "labelgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.avi.AviFunctions;
import com.pulumi.avi.inputs.GetLabelgroupArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var fooLabelgroup = AviFunctions.getLabelgroup(GetLabelgroupArgs.builder()
            .name("foo")
            .uuid("labelgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
            .build());

    }
}

variables:
  fooLabelgroup:
    fn::invoke:
      function: avi:getLabelgroup
      arguments:
        name: foo
        uuid: labelgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b

Using getLabelgroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getLabelgroup(args: GetLabelgroupArgs, opts?: InvokeOptions): Promise<GetLabelgroupResult>
function getLabelgroupOutput(args: GetLabelgroupOutputArgs, opts?: InvokeOptions): Output<GetLabelgroupResult>

def get_labelgroup(id: Optional[str] = None,
                   name: Optional[str] = None,
                   uuid: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetLabelgroupResult
def get_labelgroup_output(id: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   uuid: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetLabelgroupResult]

func LookupLabelgroup(ctx *Context, args *LookupLabelgroupArgs, opts ...InvokeOption) (*LookupLabelgroupResult, error)
func LookupLabelgroupOutput(ctx *Context, args *LookupLabelgroupOutputArgs, opts ...InvokeOption) LookupLabelgroupResultOutput

> Note: This function is named LookupLabelgroup in the Go SDK.

public static class GetLabelgroup 
{
    public static Task<GetLabelgroupResult> InvokeAsync(GetLabelgroupArgs args, InvokeOptions? opts = null)
    public static Output<GetLabelgroupResult> Invoke(GetLabelgroupInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLabelgroupResult> getLabelgroup(GetLabelgroupArgs args, InvokeOptions options)
public static Output<GetLabelgroupResult> getLabelgroup(GetLabelgroupArgs args, InvokeOptions options)

fn::invoke:
  function: avi:index/getLabelgroup:getLabelgroup
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string
Name string: Search LabelGroup by name.
Uuid string: Search LabelGroup by uuid.

Id string
Name string: Search LabelGroup by name.
Uuid string: Search LabelGroup by uuid.

id String
name String: Search LabelGroup by name.
uuid String: Search LabelGroup by uuid.

id string
name string: Search LabelGroup by name.
uuid string: Search LabelGroup by uuid.

id str
name str: Search LabelGroup by name.
uuid str: Search LabelGroup by uuid.

id String
name String: Search LabelGroup by name.
uuid String: Search LabelGroup by uuid.

getLabelgroup Result

The following output properties are available:

ConfigpbAttributes List<GetLabelgroupConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
Labels List<GetLabelgroupLabel>: 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 []GetLabelgroupConfigpbAttribute: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
Id string
Labels []GetLabelgroupLabel: 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<GetLabelgroupConfigpbAttribute>: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id String
labels List<GetLabelgroupLabel>: 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 GetLabelgroupConfigpbAttribute[]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id string
labels GetLabelgroupLabel[]: 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[GetLabelgroupConfigpbAttribute]: Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
id str
labels Sequence[GetLabelgroupLabel]: 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.
id 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.