1. Packages
  2. Scm Provider
  3. API Docs
  4. getTagList
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi

scm.getTagList

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi

    Retrieves a listing of config items.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scm from "@pulumi/scm";
    
    const example = scm.getTagList({
        folder: "Shared",
    });
    
    import pulumi
    import pulumi_scm as scm
    
    example = scm.get_tag_list(folder="Shared")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-scm/sdk/go/scm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := scm.GetTagList(ctx, &scm.GetTagListArgs{
    			Folder: pulumi.StringRef("Shared"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scm = Pulumi.Scm;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Scm.GetTagList.Invoke(new()
        {
            Folder = "Shared",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.scm.ScmFunctions;
    import com.pulumi.scm.inputs.GetTagListArgs;
    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 example = ScmFunctions.getTagList(GetTagListArgs.builder()
                .folder("Shared")
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          Function: scm:getTagList
          Arguments:
            folder: Shared
    

    Using getTagList

    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 getTagList(args: GetTagListArgs, opts?: InvokeOptions): Promise<GetTagListResult>
    function getTagListOutput(args: GetTagListOutputArgs, opts?: InvokeOptions): Output<GetTagListResult>
    def get_tag_list(device: Optional[str] = None,
                     folder: Optional[str] = None,
                     limit: Optional[int] = None,
                     name: Optional[str] = None,
                     offset: Optional[int] = None,
                     snippet: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetTagListResult
    def get_tag_list_output(device: Optional[pulumi.Input[str]] = None,
                     folder: Optional[pulumi.Input[str]] = None,
                     limit: Optional[pulumi.Input[int]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     offset: Optional[pulumi.Input[int]] = None,
                     snippet: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetTagListResult]
    func GetTagList(ctx *Context, args *GetTagListArgs, opts ...InvokeOption) (*GetTagListResult, error)
    func GetTagListOutput(ctx *Context, args *GetTagListOutputArgs, opts ...InvokeOption) GetTagListResultOutput

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

    public static class GetTagList 
    {
        public static Task<GetTagListResult> InvokeAsync(GetTagListArgs args, InvokeOptions? opts = null)
        public static Output<GetTagListResult> Invoke(GetTagListInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetTagListResult> getTagList(GetTagListArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: scm:index/getTagList:getTagList
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Device string
    The Device param.
    Folder string
    The Folder param.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Name string
    The Name param.
    Offset int
    The Offset param. Default: 0.
    Snippet string
    The Snippet param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Name string
    The Name param.
    Offset int
    The Offset param. Default: 0.
    Snippet string
    The Snippet param.
    device String
    The Device param.
    folder String
    The Folder param.
    limit Integer
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name String
    The Name param.
    offset Integer
    The Offset param. Default: 0.
    snippet String
    The Snippet param.
    device string
    The Device param.
    folder string
    The Folder param.
    limit number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name string
    The Name param.
    offset number
    The Offset param. Default: 0.
    snippet string
    The Snippet param.
    device str
    The Device param.
    folder str
    The Folder param.
    limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name str
    The Name param.
    offset int
    The Offset param. Default: 0.
    snippet str
    The Snippet param.
    device String
    The Device param.
    folder String
    The Folder param.
    limit Number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    name String
    The Name param.
    offset Number
    The Offset param. Default: 0.
    snippet String
    The Snippet param.

    getTagList Result

    The following output properties are available:

    Datas List<GetTagListData>
    The Data param.
    Id string
    The provider-assigned unique ID for this managed resource.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Offset int
    The Offset param. Default: 0.
    Tfid string
    Total int
    The Total param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    The Name param.
    Snippet string
    The Snippet param.
    Datas []GetTagListData
    The Data param.
    Id string
    The provider-assigned unique ID for this managed resource.
    Limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    Offset int
    The Offset param. Default: 0.
    Tfid string
    Total int
    The Total param.
    Device string
    The Device param.
    Folder string
    The Folder param.
    Name string
    The Name param.
    Snippet string
    The Snippet param.
    datas List<GetTagListData>
    The Data param.
    id String
    The provider-assigned unique ID for this managed resource.
    limit Integer
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset Integer
    The Offset param. Default: 0.
    tfid String
    total Integer
    The Total param.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    The Name param.
    snippet String
    The Snippet param.
    datas GetTagListData[]
    The Data param.
    id string
    The provider-assigned unique ID for this managed resource.
    limit number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset number
    The Offset param. Default: 0.
    tfid string
    total number
    The Total param.
    device string
    The Device param.
    folder string
    The Folder param.
    name string
    The Name param.
    snippet string
    The Snippet param.
    datas Sequence[GetTagListData]
    The Data param.
    id str
    The provider-assigned unique ID for this managed resource.
    limit int
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset int
    The Offset param. Default: 0.
    tfid str
    total int
    The Total param.
    device str
    The Device param.
    folder str
    The Folder param.
    name str
    The Name param.
    snippet str
    The Snippet param.
    datas List<Property Map>
    The Data param.
    id String
    The provider-assigned unique ID for this managed resource.
    limit Number
    The Limit param. A limit of -1 will return all configured items. Default: 200.
    offset Number
    The Offset param. Default: 0.
    tfid String
    total Number
    The Total param.
    device String
    The Device param.
    folder String
    The Folder param.
    name String
    The Name param.
    snippet String
    The Snippet param.

    Supporting Types

    GetTagListData

    Color string
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    Comments string
    The Comments param. String length must not exceed 1023 characters.
    Id string
    UUID of the resource.
    Name string
    The Name param. String length must not exceed 127 characters.
    Color string
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    Comments string
    The Comments param. String length must not exceed 1023 characters.
    Id string
    UUID of the resource.
    Name string
    The Name param. String length must not exceed 127 characters.
    color String
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    comments String
    The Comments param. String length must not exceed 1023 characters.
    id String
    UUID of the resource.
    name String
    The Name param. String length must not exceed 127 characters.
    color string
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    comments string
    The Comments param. String length must not exceed 1023 characters.
    id string
    UUID of the resource.
    name string
    The Name param. String length must not exceed 127 characters.
    color str
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    comments str
    The Comments param. String length must not exceed 1023 characters.
    id str
    UUID of the resource.
    name str
    The Name param. String length must not exceed 127 characters.
    color String
    The Color param. String must be one of these: "Red", "Green", "Blue", "Yellow", "Copper", "Orange", "Purple", "Gray", "Light Green", "Cyan", "Light Gray", "Blue Gray", "Lime", "Black", "Gold", "Brown", "Olive", "Maroon", "Red-Orange", "Yellow-Orange", "Forest Green", "Turquoise Blue", "Azure Blue", "Cerulean Blue", "Midnight Blue", "Medium Blue", "Cobalt Blue", "Violet Blue", "Blue Violet", "Medium Violet", "Medium Rose", "Lavender", "Orchid", "Thistle", "Peach", "Salmon", "Magenta", "Red Violet", "Mahogany", "Burnt Sienna", "Chestnut".
    comments String
    The Comments param. String length must not exceed 1023 characters.
    id String
    UUID of the resource.
    name String
    The Name param. String length must not exceed 127 characters.

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi