1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. getSnippetList
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";
    
    const allSnippets = scm.getSnippetList({
        limit: 10,
    });
    export const snippetsListRaw = allSnippets.then(allSnippets => allSnippets.datas);
    
    import pulumi
    import pulumi_scm as scm
    
    all_snippets = scm.get_snippet_list(limit=10)
    pulumi.export("snippetsListRaw", all_snippets.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 {
    		allSnippets, err := scm.GetSnippetList(ctx, &scm.GetSnippetListArgs{
    			Limit: pulumi.IntRef(10),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("snippetsListRaw", allSnippets.Datas)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Scm = Pulumi.Scm;
    
    return await Deployment.RunAsync(() => 
    {
        var allSnippets = Scm.GetSnippetList.Invoke(new()
        {
            Limit = 10,
        });
    
        return new Dictionary<string, object?>
        {
            ["snippetsListRaw"] = allSnippets.Apply(getSnippetListResult => getSnippetListResult.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.GetSnippetListArgs;
    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 allSnippets = ScmFunctions.getSnippetList(GetSnippetListArgs.builder()
                .limit(10)
                .build());
    
            ctx.export("snippetsListRaw", allSnippets.datas());
        }
    }
    
    variables:
      allSnippets:
        fn::invoke:
          function: scm:getSnippetList
          arguments:
            limit: 10
    outputs:
      # Output the raw list of all application objects
      snippetsListRaw: ${allSnippets.datas}
    

    Using getSnippetList

    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 getSnippetList(args: GetSnippetListArgs, opts?: InvokeOptions): Promise<GetSnippetListResult>
    function getSnippetListOutput(args: GetSnippetListOutputArgs, opts?: InvokeOptions): Output<GetSnippetListResult>
    def get_snippet_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) -> GetSnippetListResult
    def get_snippet_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[GetSnippetListResult]
    func GetSnippetList(ctx *Context, args *GetSnippetListArgs, opts ...InvokeOption) (*GetSnippetListResult, error)
    func GetSnippetListOutput(ctx *Context, args *GetSnippetListOutputArgs, opts ...InvokeOption) GetSnippetListResultOutput

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

    public static class GetSnippetList 
    {
        public static Task<GetSnippetListResult> InvokeAsync(GetSnippetListArgs args, InvokeOptions? opts = null)
        public static Output<GetSnippetListResult> Invoke(GetSnippetListInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetSnippetListResult> getSnippetList(GetSnippetListArgs args, InvokeOptions options)
    public static Output<GetSnippetListResult> getSnippetList(GetSnippetListArgs args, InvokeOptions options)
    
    fn::invoke:
      function: scm:index/getSnippetList:getSnippetList
      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.

    getSnippetList Result

    The following output properties are available:

    Datas List<GetSnippetListData>
    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 []GetSnippetListData
    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<GetSnippetListData>
    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 GetSnippetListData[]
    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[GetSnippetListData]
    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

    GetSnippetListData

    Description string
    The description of the snippet
    Id string
    The UUID of the snippet
    Labels List<string>
    Labels applied to the snippet
    Name string
    The name of the snippet
    Tfid string
    Type string
    The snippet type
    Description string
    The description of the snippet
    Id string
    The UUID of the snippet
    Labels []string
    Labels applied to the snippet
    Name string
    The name of the snippet
    Tfid string
    Type string
    The snippet type
    description String
    The description of the snippet
    id String
    The UUID of the snippet
    labels List<String>
    Labels applied to the snippet
    name String
    The name of the snippet
    tfid String
    type String
    The snippet type
    description string
    The description of the snippet
    id string
    The UUID of the snippet
    labels string[]
    Labels applied to the snippet
    name string
    The name of the snippet
    tfid string
    type string
    The snippet type
    description str
    The description of the snippet
    id str
    The UUID of the snippet
    labels Sequence[str]
    Labels applied to the snippet
    name str
    The name of the snippet
    tfid str
    type str
    The snippet type
    description String
    The description of the snippet
    id String
    The UUID of the snippet
    labels List<String>
    Labels applied to the snippet
    name String
    The name of the snippet
    tfid String
    type String
    The snippet type

    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