1. Packages
  2. Avi Provider
  3. API Docs
  4. getStringgroup
avi 31.1.1 published on Monday, Apr 14, 2025 by vmware

avi.getStringgroup

Explore with Pulumi AI

avi logo
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.Stringgroup” sidebar_current: “docs-avi-datasource-stringgroup” description: |- Get information of Avi StringGroup.

    avi.Stringgroup

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

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as avi from "@pulumi/avi";
    
    const fooStringgroup = avi.getStringgroup({
        name: "foo",
        uuid: "stringgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b",
    });
    
    import pulumi
    import pulumi_avi as avi
    
    foo_stringgroup = avi.get_stringgroup(name="foo",
        uuid="stringgroup-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.LookupStringgroup(ctx, &avi.LookupStringgroupArgs{
    			Name: pulumi.StringRef("foo"),
    			Uuid: pulumi.StringRef("stringgroup-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 fooStringgroup = Avi.GetStringgroup.Invoke(new()
        {
            Name = "foo",
            Uuid = "stringgroup-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.GetStringgroupArgs;
    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 fooStringgroup = AviFunctions.getStringgroup(GetStringgroupArgs.builder()
                .name("foo")
                .uuid("stringgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b")
                .build());
    
        }
    }
    
    variables:
      fooStringgroup:
        fn::invoke:
          function: avi:getStringgroup
          arguments:
            name: foo
            uuid: stringgroup-f9cf6b3e-a411-436f-95e2-2982ba2b217b
    

    Using getStringgroup

    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 getStringgroup(args: GetStringgroupArgs, opts?: InvokeOptions): Promise<GetStringgroupResult>
    function getStringgroupOutput(args: GetStringgroupOutputArgs, opts?: InvokeOptions): Output<GetStringgroupResult>
    def get_stringgroup(id: Optional[str] = None,
                        name: Optional[str] = None,
                        tenant_ref: Optional[str] = None,
                        uuid: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetStringgroupResult
    def get_stringgroup_output(id: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        tenant_ref: Optional[pulumi.Input[str]] = None,
                        uuid: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetStringgroupResult]
    func LookupStringgroup(ctx *Context, args *LookupStringgroupArgs, opts ...InvokeOption) (*LookupStringgroupResult, error)
    func LookupStringgroupOutput(ctx *Context, args *LookupStringgroupOutputArgs, opts ...InvokeOption) LookupStringgroupResultOutput

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

    public static class GetStringgroup 
    {
        public static Task<GetStringgroupResult> InvokeAsync(GetStringgroupArgs args, InvokeOptions? opts = null)
        public static Output<GetStringgroupResult> Invoke(GetStringgroupInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetStringgroupResult> getStringgroup(GetStringgroupArgs args, InvokeOptions options)
    public static Output<GetStringgroupResult> getStringgroup(GetStringgroupArgs args, InvokeOptions options)
    
    fn::invoke:
      function: avi:index/getStringgroup:getStringgroup
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    Name string
    Search StringGroup by name.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Search StringGroup by uuid.
    Id string
    Name string
    Search StringGroup by name.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Search StringGroup by uuid.
    id String
    name String
    Search StringGroup by name.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Search StringGroup by uuid.
    id string
    name string
    Search StringGroup by name.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Search StringGroup by uuid.
    id str
    name str
    Search StringGroup by name.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Search StringGroup by uuid.
    id String
    name String
    Search StringGroup by name.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Search StringGroup by uuid.

    getStringgroup Result

    The following output properties are available:

    ConfigpbAttributes List<GetStringgroupConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Id string
    Kvs List<GetStringgroupKv>
    Configure key value in the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LongestMatch string
    Enable the longest match, default is the shortest match. Field introduced in 18.2.8. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Markers List<GetStringgroupMarker>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Type string
    Type of stringgroup. Enum options - SG_TYPE_STRING, SG_TYPE_KEYVAL. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Uuid of the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    ConfigpbAttributes []GetStringgroupConfigpbAttribute
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Id string
    Kvs []GetStringgroupKv
    Configure key value in the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    LongestMatch string
    Enable the longest match, default is the shortest match. Field introduced in 18.2.8. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Markers []GetStringgroupMarker
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Name string
    Name of the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    TenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Type string
    Type of stringgroup. Enum options - SG_TYPE_STRING, SG_TYPE_KEYVAL. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    Uuid string
    Uuid of the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes List<GetStringgroupConfigpbAttribute>
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id String
    kvs List<GetStringgroupKv>
    Configure key value in the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    longestMatch String
    Enable the longest match, default is the shortest match. Field introduced in 18.2.8. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers List<GetStringgroupMarker>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    type String
    Type of stringgroup. Enum options - SG_TYPE_STRING, SG_TYPE_KEYVAL. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Uuid of the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpbAttributes GetStringgroupConfigpbAttribute[]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description string
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id string
    kvs GetStringgroupKv[]
    Configure key value in the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    longestMatch string
    Enable the longest match, default is the shortest match. Field introduced in 18.2.8. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers GetStringgroupMarker[]
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name string
    Name of the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef string
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    type string
    Type of stringgroup. Enum options - SG_TYPE_STRING, SG_TYPE_KEYVAL. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid string
    Uuid of the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    configpb_attributes Sequence[GetStringgroupConfigpbAttribute]
    Protobuf versioning for config pbs. Field introduced in 21.1.1. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    description str
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id str
    kvs Sequence[GetStringgroupKv]
    Configure key value in the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    longest_match str
    Enable the longest match, default is the shortest match. Field introduced in 18.2.8. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers Sequence[GetStringgroupMarker]
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name str
    Name of the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenant_ref str
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    type str
    Type of stringgroup. Enum options - SG_TYPE_STRING, SG_TYPE_KEYVAL. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid str
    Uuid of the string group. Allowed with any value in enterprise, essentials, basic, 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.
    description String
    Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    id String
    kvs List<Property Map>
    Configure key value in the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    longestMatch String
    Enable the longest match, default is the shortest match. Field introduced in 18.2.8. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    markers List<Property Map>
    List of labels to be used for granular rbac. Field introduced in 20.1.5. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    name String
    Name of the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    tenantRef String
    It is a reference to an object of type tenant. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    type String
    Type of stringgroup. Enum options - SG_TYPE_STRING, SG_TYPE_KEYVAL. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.
    uuid String
    Uuid of the string group. Allowed with any value in enterprise, essentials, basic, enterprise with cloud services edition.

    Supporting Types

    GetStringgroupConfigpbAttribute

    Version string
    Version string
    version String
    version string
    version String

    GetStringgroupKv

    Key string
    Value string
    Key string
    Value string
    key String
    value String
    key string
    value string
    key str
    value str
    key String
    value String

    GetStringgroupMarker

    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