getGeneralSettingList

Strata Cloud Manager v1.0.5, Mar 21 26

Viewing docs for Strata Cloud Manager v1.0.5
published on Saturday, Mar 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

Viewing docs for Strata Cloud Manager v1.0.5
published on Saturday, Mar 21, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

Example Usage

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

const allSettings = scm.getGeneralSettingList({
    folder: "All",
});
export const fetchedSettingListSummary = {
    countOfSettingsFetched: allSettings.then(allSettings => allSettings.total),
    value: allSettings.then(allSettings => allSettings.datas?.[0]),
};

import pulumi
import pulumi_scm as scm

all_settings = scm.get_general_setting_list(folder="All")
pulumi.export("fetchedSettingListSummary", {
    "countOfSettingsFetched": all_settings.total,
    "value": all_settings.datas[0],
})

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 {
		allSettings, err := scm.GetGeneralSettingList(ctx, &scm.GetGeneralSettingListArgs{
			Folder: pulumi.StringRef("All"),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("fetchedSettingListSummary", pulumi.Map{
			"countOfSettingsFetched": allSettings.Total,
			"value":                  allSettings.Datas[0],
		})
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;

return await Deployment.RunAsync(() => 
{
    var allSettings = Scm.GetGeneralSettingList.Invoke(new()
    {
        Folder = "All",
    });

    return new Dictionary<string, object?>
    {
        ["fetchedSettingListSummary"] = 
        {
            { "countOfSettingsFetched", allSettings.Apply(getGeneralSettingListResult => getGeneralSettingListResult.Total) },
            { "value", allSettings.Apply(getGeneralSettingListResult => getGeneralSettingListResult.Datas[0]) },
        },
    };
});

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.GetGeneralSettingListArgs;
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 allSettings = ScmFunctions.getGeneralSettingList(GetGeneralSettingListArgs.builder()
            .folder("All")
            .build());

        ctx.export("fetchedSettingListSummary", Map.ofEntries(
            Map.entry("countOfSettingsFetched", allSettings.total()),
            Map.entry("value", allSettings.datas()[0])
        ));
    }
}

variables:
  allSettings:
    fn::invoke:
      function: scm:getGeneralSettingList
      arguments:
        folder: All
outputs:
  # -----------------------------------------------------------------------------
  # OUTPUT: Display the fetched list data
  # -----------------------------------------------------------------------------
  fetchedSettingListSummary:
    countOfSettingsFetched: ${allSettings.total}
    value: ${allSettings.datas[0]}

Using getGeneralSettingList

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 getGeneralSettingList(args: GetGeneralSettingListArgs, opts?: InvokeOptions): Promise<GetGeneralSettingListResult>
function getGeneralSettingListOutput(args: GetGeneralSettingListOutputArgs, opts?: InvokeOptions): Output<GetGeneralSettingListResult>

def get_general_setting_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) -> GetGeneralSettingListResult
def get_general_setting_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[GetGeneralSettingListResult]

func GetGeneralSettingList(ctx *Context, args *GetGeneralSettingListArgs, opts ...InvokeOption) (*GetGeneralSettingListResult, error)
func GetGeneralSettingListOutput(ctx *Context, args *GetGeneralSettingListOutputArgs, opts ...InvokeOption) GetGeneralSettingListResultOutput

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

public static class GetGeneralSettingList 
{
    public static Task<GetGeneralSettingListResult> InvokeAsync(GetGeneralSettingListArgs args, InvokeOptions? opts = null)
    public static Output<GetGeneralSettingListResult> Invoke(GetGeneralSettingListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGeneralSettingListResult> getGeneralSettingList(GetGeneralSettingListArgs args, InvokeOptions options)
public static Output<GetGeneralSettingListResult> getGeneralSettingList(GetGeneralSettingListArgs args, InvokeOptions options)

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