Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Scm Provider
  3. API Docs
  4. getSnippetList
Strata Cloud Manager v0.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
pulumi/pulumi-scm

scm.getSnippetList

Explore with Pulumi AI

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

    Retrieves a listing of config items.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";

const example = scm.getSnippetList({});

    import pulumi
import pulumi_scm as scm

example = scm.get_snippet_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.GetSnippetList(ctx, &scm.GetSnippetListArgs{}, 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.GetSnippetList.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.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 example = ScmFunctions.getSnippetList();

    }
}

    variables:
  example:
    fn::invoke:
      Function: scm:getSnippetList
      Arguments: {}

    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(limit: Optional[int] = None,
                     name: Optional[str] = None,
                     offset: Optional[int] = None,
                     opts: Optional[InvokeOptions] = None) -> GetSnippetListResult
def get_snippet_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[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)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: scm:index/getSnippetList:getSnippetList
  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.

    getSnippetList Result

    The following output properties are available:

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

    GetSnippetListData

    CreatedIn string
    The CreatedIn param.
    Description string
    The Description param.
    DisplayName string
    The DisplayName param.
    Folders List<GetSnippetListDataFolder>
    The Folders param.
    Id string
    The Id param.
    Labels List<string>
    The Labels param.
    LastUpdate string
    The LastUpdate param.
    Name string
    The Name param.
    SharedIn string
    The SharedIn param.
    Type string
    The Type param. String must be one of these: "predefined".
    CreatedIn string
    The CreatedIn param.
    Description string
    The Description param.
    DisplayName string
    The DisplayName param.
    Folders []GetSnippetListDataFolder
    The Folders param.
    Id string
    The Id param.
    Labels []string
    The Labels param.
    LastUpdate string
    The LastUpdate param.
    Name string
    The Name param.
    SharedIn string
    The SharedIn param.
    Type string
    The Type param. String must be one of these: "predefined".
    createdIn String
    The CreatedIn param.
    description String
    The Description param.
    displayName String
    The DisplayName param.
    folders List<GetSnippetListDataFolder>
    The Folders param.
    id String
    The Id param.
    labels List<String>
    The Labels param.
    lastUpdate String
    The LastUpdate param.
    name String
    The Name param.
    sharedIn String
    The SharedIn param.
    type String
    The Type param. String must be one of these: "predefined".
    createdIn string
    The CreatedIn param.
    description string
    The Description param.
    displayName string
    The DisplayName param.
    folders GetSnippetListDataFolder[]
    The Folders param.
    id string
    The Id param.
    labels string[]
    The Labels param.
    lastUpdate string
    The LastUpdate param.
    name string
    The Name param.
    sharedIn string
    The SharedIn param.
    type string
    The Type param. String must be one of these: "predefined".
    created_in str
    The CreatedIn param.
    description str
    The Description param.
    display_name str
    The DisplayName param.
    folders Sequence[GetSnippetListDataFolder]
    The Folders param.
    id str
    The Id param.
    labels Sequence[str]
    The Labels param.
    last_update str
    The LastUpdate param.
    name str
    The Name param.
    shared_in str
    The SharedIn param.
    type str
    The Type param. String must be one of these: "predefined".
    createdIn String
    The CreatedIn param.
    description String
    The Description param.
    displayName String
    The DisplayName param.
    folders List<Property Map>
    The Folders param.
    id String
    The Id param.
    labels List<String>
    The Labels param.
    lastUpdate String
    The LastUpdate param.
    name String
    The Name param.
    sharedIn String
    The SharedIn param.
    type String
    The Type param. String must be one of these: "predefined".

    GetSnippetListDataFolder

    Id string
    The Id param.
    Name string
    The Name param.
    Id string
    The Id param.
    Name string
    The Name param.
    id String
    The Id param.
    name String
    The Name param.
    id string
    The Id param.
    name string
    The Name param.
    id str
    The Id param.
    name str
    The Name param.
    id String
    The Id param.
    name String
    The Name 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.1.6 published on Wednesday, Oct 16, 2024 by Pulumi
    pulumi/pulumi-scm