1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. getVariableList
Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi
scm logo
Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi

    Retrieves a listing of config items.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scm from "@pulumi/scm";
    
    //
    // Data source to retrieve a list of all variables in a folder.
    //
    // Example 1: Fetch a list of all variables in the "Global" aka "All" folder.
    const allGlobal = scm.getVariableList({
        folder: "All",
    });
    export const scmVariableListGlobal = allGlobal.then(allGlobal => allGlobal.datas);
    // Example 2: Use pagination to get the first variables by name.
    const paginated = scm.getVariableList({
        folder: "All",
        limit: 5,
        offset: 0,
    });
    export const scmVariableListPaginated = paginated.then(paginated => paginated.datas);
    
    import pulumi
    import pulumi_scm as scm
    
    #
    # Data source to retrieve a list of all variables in a folder.
    #
    # Example 1: Fetch a list of all variables in the "Global" aka "All" folder.
    all_global = scm.get_variable_list(folder="All")
    pulumi.export("scmVariableListGlobal", all_global.datas)
    # Example 2: Use pagination to get the first variables by name.
    paginated = scm.get_variable_list(folder="All",
        limit=5,
        offset=0)
    pulumi.export("scmVariableListPaginated", paginated.datas)
    
    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 {
    		// Data source to retrieve a list of all variables in a folder.
    		//
    		// Example 1: Fetch a list of all variables in the "Global" aka "All" folder.
    		allGlobal, err := scm.GetVariableList(ctx, &scm.GetVariableListArgs{
    			Folder: pulumi.StringRef("All"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("scmVariableListGlobal", allGlobal.Datas)
    		// Example 2: Use pagination to get the first variables by name.
    		paginated, err := scm.GetVariableList(ctx, &scm.GetVariableListArgs{
    			Folder: pulumi.StringRef("All"),
    			Limit:  pulumi.IntRef(5),
    			Offset: pulumi.IntRef(0),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("scmVariableListPaginated", paginated.Datas)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scm = Pulumi.Scm;
    
    return await Deployment.RunAsync(() => 
    {
        //
        // Data source to retrieve a list of all variables in a folder.
        //
        // Example 1: Fetch a list of all variables in the "Global" aka "All" folder.
        var allGlobal = Scm.GetVariableList.Invoke(new()
        {
            Folder = "All",
        });
    
        // Example 2: Use pagination to get the first variables by name.
        var paginated = Scm.GetVariableList.Invoke(new()
        {
            Folder = "All",
            Limit = 5,
            Offset = 0,
        });
    
        return new Dictionary<string, object?>
        {
            ["scmVariableListGlobal"] = allGlobal.Apply(getVariableListResult => getVariableListResult.Datas),
            ["scmVariableListPaginated"] = paginated.Apply(getVariableListResult => getVariableListResult.Datas),
        };
    });
    
    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.GetVariableListArgs;
    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) {
            //
            // Data source to retrieve a list of all variables in a folder.
            //
            // Example 1: Fetch a list of all variables in the "Global" aka "All" folder.
            final var allGlobal = ScmFunctions.getVariableList(GetVariableListArgs.builder()
                .folder("All")
                .build());
    
            ctx.export("scmVariableListGlobal", allGlobal.datas());
            // Example 2: Use pagination to get the first variables by name.
            final var paginated = ScmFunctions.getVariableList(GetVariableListArgs.builder()
                .folder("All")
                .limit(5)
                .offset(0)
                .build());
    
            ctx.export("scmVariableListPaginated", paginated.datas());
        }
    }
    
    variables:
      #
      # Data source to retrieve a list of all variables in a folder.
      #
    
      # Example 1: Fetch a list of all variables in the "Global" aka "All" folder.
      allGlobal:
        fn::invoke:
          function: scm:getVariableList
          arguments:
            folder: All
      # Example 2: Use pagination to get the first variables by name.
      paginated:
        fn::invoke:
          function: scm:getVariableList
          arguments:
            folder: All
            limit: 5
            offset: 0
    outputs:
      # Output the list of all variables from the "Global" aka "All" folder.
      scmVariableListGlobal: ${allGlobal.datas}
      scmVariableListPaginated: ${paginated.datas}
    

    Using getVariableList

    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 getVariableList(args: GetVariableListArgs, opts?: InvokeOptions): Promise<GetVariableListResult>
    function getVariableListOutput(args: GetVariableListOutputArgs, opts?: InvokeOptions): Output<GetVariableListResult>
    def get_variable_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) -> GetVariableListResult
    def get_variable_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[GetVariableListResult]
    func GetVariableList(ctx *Context, args *GetVariableListArgs, opts ...InvokeOption) (*GetVariableListResult, error)
    func GetVariableListOutput(ctx *Context, args *GetVariableListOutputArgs, opts ...InvokeOption) GetVariableListResultOutput

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

    public static class GetVariableList 
    {
        public static Task<GetVariableListResult> InvokeAsync(GetVariableListArgs args, InvokeOptions? opts = null)
        public static Output<GetVariableListResult> Invoke(GetVariableListInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVariableListResult> getVariableList(GetVariableListArgs args, InvokeOptions options)
    public static Output<GetVariableListResult> getVariableList(GetVariableListArgs args, InvokeOptions options)
    
    fn::invoke:
      function: scm:index/getVariableList:getVariableList
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Integer
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Integer
    The offset of the first item to return.
    snippet String
    The snippet of the item.
    device string
    The device of the item.
    folder string
    The folder of the item. Default: Shared.
    limit number
    The max number of items to return. Default: 200.
    name string
    The name of the item.
    offset number
    The offset of the first item to return.
    snippet string
    The snippet of the item.
    device str
    The device of the item.
    folder str
    The folder of the item. Default: Shared.
    limit int
    The max number of items to return. Default: 200.
    name str
    The name of the item.
    offset int
    The offset of the first item to return.
    snippet str
    The snippet of the item.
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Number
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Number
    The offset of the first item to return.
    snippet String
    The snippet of the item.

    getVariableList Result

    The following output properties are available:

    Datas List<GetVariableListData>
    The data.
    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    Total int
    The total number of items.
    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    Datas []GetVariableListData
    The data.
    Id string
    The provider-assigned unique ID for this managed resource.
    Tfid string
    Total int
    The total number of items.
    Device string
    The device of the item.
    Folder string
    The folder of the item. Default: Shared.
    Limit int
    The max number of items to return. Default: 200.
    Name string
    The name of the item.
    Offset int
    The offset of the first item to return.
    Snippet string
    The snippet of the item.
    datas List<GetVariableListData>
    The data.
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String
    total Integer
    The total number of items.
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Integer
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Integer
    The offset of the first item to return.
    snippet String
    The snippet of the item.
    datas GetVariableListData[]
    The data.
    id string
    The provider-assigned unique ID for this managed resource.
    tfid string
    total number
    The total number of items.
    device string
    The device of the item.
    folder string
    The folder of the item. Default: Shared.
    limit number
    The max number of items to return. Default: 200.
    name string
    The name of the item.
    offset number
    The offset of the first item to return.
    snippet string
    The snippet of the item.
    datas Sequence[GetVariableListData]
    The data.
    id str
    The provider-assigned unique ID for this managed resource.
    tfid str
    total int
    The total number of items.
    device str
    The device of the item.
    folder str
    The folder of the item. Default: Shared.
    limit int
    The max number of items to return. Default: 200.
    name str
    The name of the item.
    offset int
    The offset of the first item to return.
    snippet str
    The snippet of the item.
    datas List<Property Map>
    The data.
    id String
    The provider-assigned unique ID for this managed resource.
    tfid String
    total Number
    The total number of items.
    device String
    The device of the item.
    folder String
    The folder of the item. Default: Shared.
    limit Number
    The max number of items to return. Default: 200.
    name String
    The name of the item.
    offset Number
    The offset of the first item to return.
    snippet String
    The snippet of the item.

    Supporting Types

    GetVariableListData

    Description string
    The description of the variable
    Device string
    The device in which the resource is defined
    Folder string
    The folder in which the resource is defined
    Id string
    UUID of the variable
    Name string
    The name of the variable
    Overridden bool
    Is the variable overridden?
    Snippet string
    The snippet in which the resource is defined
    Tfid string
    Type string
    The variable type
    Value string
    The value of the variable
    Description string
    The description of the variable
    Device string
    The device in which the resource is defined
    Folder string
    The folder in which the resource is defined
    Id string
    UUID of the variable
    Name string
    The name of the variable
    Overridden bool
    Is the variable overridden?
    Snippet string
    The snippet in which the resource is defined
    Tfid string
    Type string
    The variable type
    Value string
    The value of the variable
    description String
    The description of the variable
    device String
    The device in which the resource is defined
    folder String
    The folder in which the resource is defined
    id String
    UUID of the variable
    name String
    The name of the variable
    overridden Boolean
    Is the variable overridden?
    snippet String
    The snippet in which the resource is defined
    tfid String
    type String
    The variable type
    value String
    The value of the variable
    description string
    The description of the variable
    device string
    The device in which the resource is defined
    folder string
    The folder in which the resource is defined
    id string
    UUID of the variable
    name string
    The name of the variable
    overridden boolean
    Is the variable overridden?
    snippet string
    The snippet in which the resource is defined
    tfid string
    type string
    The variable type
    value string
    The value of the variable
    description str
    The description of the variable
    device str
    The device in which the resource is defined
    folder str
    The folder in which the resource is defined
    id str
    UUID of the variable
    name str
    The name of the variable
    overridden bool
    Is the variable overridden?
    snippet str
    The snippet in which the resource is defined
    tfid str
    type str
    The variable type
    value str
    The value of the variable
    description String
    The description of the variable
    device String
    The device in which the resource is defined
    folder String
    The folder in which the resource is defined
    id String
    UUID of the variable
    name String
    The name of the variable
    overridden Boolean
    Is the variable overridden?
    snippet String
    The snippet in which the resource is defined
    tfid String
    type String
    The variable type
    value String
    The value of the variable

    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.4.3 published on Saturday, Nov 8, 2025 by Pulumi
      Meet Neo: Your AI Platform Teammate