Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. getSnippetList
Strata Cloud Manager v0.3.1 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-scm

scm.getSnippetList

Explore with Pulumi AI

Strata Cloud Manager v0.3.1 published on Thursday, Mar 13, 2025 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({});
Copy
import pulumi
import pulumi_scm as scm

example = scm.get_snippet_list()
Copy
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
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;

return await Deployment.RunAsync(() => 
{
    var example = Scm.GetSnippetList.Invoke();

});
Copy
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();

    }
}
Copy
variables:
  example:
    fn::invoke:
      function: scm:getSnippetList
      arguments: {}
Copy

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>
Copy
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]
Copy
func GetSnippetList(ctx *Context, args *GetSnippetListArgs, opts ...InvokeOption) (*GetSnippetListResult, error)
func GetSnippetListOutput(ctx *Context, args *GetSnippetListOutputArgs, opts ...InvokeOption) GetSnippetListResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetSnippetListResult> getSnippetList(GetSnippetListArgs args, InvokeOptions options)
public static Output<GetSnippetListResult> getSnippetList(GetSnippetListArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: scm:index/getSnippetList:getSnippetList
  arguments:
    # arguments dictionary
Copy

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

GetSnippetListDataFolder

Id This property is required. string
The Id param.
Name This property is required. string
The Name param.
Id This property is required. string
The Id param.
Name This property is required. string
The Name param.
id This property is required. String
The Id param.
name This property is required. String
The Name param.
id This property is required. string
The Id param.
name This property is required. string
The Name param.
id This property is required. str
The Id param.
name This property is required. str
The Name param.
id This property is required. String
The Id param.
name This property is required. 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.
Strata Cloud Manager v0.3.1 published on Thursday, Mar 13, 2025 by Pulumi
pulumi/pulumi-scm