1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. getFolderList
Strata Cloud Manager v0.4.0 published on Thursday, May 15, 2025 by Pulumi

scm.getFolderList

Explore with Pulumi AI

scm logo
Strata Cloud Manager v0.4.0 published on Thursday, May 15, 2025 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.getFolderList({});
    
    import pulumi
    import pulumi_scm as scm
    
    example = scm.get_folder_list()
    
    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.GetFolderList(ctx, &scm.GetFolderListArgs{}, 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.GetFolderList.Invoke();
    
    });
    
    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.GetFolderListArgs;
    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.getFolderList(GetFolderListArgs.builder()
                .build());
    
        }
    }
    
    variables:
      example:
        fn::invoke:
          function: scm:getFolderList
          arguments: {}
    

    Using getFolderList

    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 getFolderList(args: GetFolderListArgs, opts?: InvokeOptions): Promise<GetFolderListResult>
    function getFolderListOutput(args: GetFolderListOutputArgs, opts?: InvokeOptions): Output<GetFolderListResult>
    def get_folder_list(limit: Optional[int] = None,
                        name: Optional[str] = None,
                        offset: Optional[int] = None,
                        opts: Optional[InvokeOptions] = None) -> GetFolderListResult
    def get_folder_list_output(limit: Optional[pulumi.Input[int]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        offset: Optional[pulumi.Input[int]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetFolderListResult]
    func GetFolderList(ctx *Context, args *GetFolderListArgs, opts ...InvokeOption) (*GetFolderListResult, error)
    func GetFolderListOutput(ctx *Context, args *GetFolderListOutputArgs, opts ...InvokeOption) GetFolderListResultOutput

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

    public static class GetFolderList 
    {
        public static Task<GetFolderListResult> InvokeAsync(GetFolderListArgs args, InvokeOptions? opts = null)
        public static Output<GetFolderListResult> Invoke(GetFolderListInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetFolderListResult> getFolderList(GetFolderListArgs args, InvokeOptions options)
    public static Output<GetFolderListResult> getFolderList(GetFolderListArgs args, InvokeOptions options)
    
    fn::invoke:
      function: scm:index/getFolderList:getFolderList
      arguments:
        # arguments dictionary

    The following arguments are supported:

    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.
    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.
    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.
    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.
    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.
    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.

    getFolderList Result

    The following output properties are available:

    Datas List<GetFolderListData>
    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.
    Name string
    The Name param.
    Datas []GetFolderListData
    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.
    Name string
    The Name param.
    datas List<GetFolderListData>
    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.
    name String
    The Name param.
    datas GetFolderListData[]
    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.
    name string
    The Name param.
    datas Sequence[GetFolderListData]
    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.
    name str
    The Name 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.
    name String
    The Name param.

    Supporting Types

    GetFolderListData

    Description string
    The Description param.
    Id string
    The Id param.
    Labels List<string>
    The Labels param.
    Name string
    The Name param.
    Parent string
    The Parent param.
    Snippets List<string>
    The Snippets param.
    Description string
    The Description param.
    Id string
    The Id param.
    Labels []string
    The Labels param.
    Name string
    The Name param.
    Parent string
    The Parent param.
    Snippets []string
    The Snippets param.
    description String
    The Description param.
    id String
    The Id param.
    labels List<String>
    The Labels param.
    name String
    The Name param.
    parent String
    The Parent param.
    snippets List<String>
    The Snippets param.
    description string
    The Description param.
    id string
    The Id param.
    labels string[]
    The Labels param.
    name string
    The Name param.
    parent string
    The Parent param.
    snippets string[]
    The Snippets param.
    description str
    The Description param.
    id str
    The Id param.
    labels Sequence[str]
    The Labels param.
    name str
    The Name param.
    parent str
    The Parent param.
    snippets Sequence[str]
    The Snippets param.
    description String
    The Description param.
    id String
    The Id param.
    labels List<String>
    The Labels param.
    name String
    The Name param.
    parent String
    The Parent param.
    snippets List<String>
    The Snippets param.

    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.0 published on Thursday, May 15, 2025 by Pulumi