getAddressGroupList

Strata Cloud Manager v0.4.3, Nov 8 25

Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

Strata Cloud Manager v0.4.3 published on Saturday, Nov 8, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

Example Usage

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

// This data source will call the "ListAddresses" API endpoint
// and return all filters in the "Shared" folder.
// 1. Use a single data block to fetch ALL addresses in the "Shared" folder.
const allShared = scm.getAddressGroupList({
    folder: "All",
});
export const addressGroupsDataSourceResultsFromList = allShared.then(allShared => .reduce((__obj, addr) => ({ ...__obj, [addr.id]: addr })));
const paginatedAddressGroupsExample = scm.getAddressGroupList({
    folder: "All",
    limit: 5,
    offset: 0,
});
export const paginatedAddressGroups = paginatedAddressGroupsExample.then(paginatedAddressGroupsExample => .reduce((__obj, addr) => ({ ...__obj, [addr.id]: addr })));
export const paginationAddressGroupsDetails = {
    totalObjectsInFolder: paginatedAddressGroupsExample.then(paginatedAddressGroupsExample => paginatedAddressGroupsExample.total),
    limitUsed: paginatedAddressGroupsExample.then(paginatedAddressGroupsExample => paginatedAddressGroupsExample.limit),
};

import pulumi
import pulumi_scm as scm

# This data source will call the "ListAddresses" API endpoint
# and return all filters in the "Shared" folder.
# 1. Use a single data block to fetch ALL addresses in the "Shared" folder.
all_shared = scm.get_address_group_list(folder="All")
pulumi.export("addressGroupsDataSourceResultsFromList", {addr.id: addr for addr in all_shared.datas})
paginated_address_groups_example = scm.get_address_group_list(folder="All",
    limit=5,
    offset=0)
pulumi.export("paginatedAddressGroups", {addr.id: addr for addr in paginated_address_groups_example.datas})
pulumi.export("paginationAddressGroupsDetails", {
    "totalObjectsInFolder": paginated_address_groups_example.total,
    "limitUsed": paginated_address_groups_example.limit,
})

Example coming soon!

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

return await Deployment.RunAsync(() => 
{
    // This data source will call the "ListAddresses" API endpoint
    // and return all filters in the "Shared" folder.
    // 1. Use a single data block to fetch ALL addresses in the "Shared" folder.
    var allShared = Scm.GetAddressGroupList.Invoke(new()
    {
        Folder = "All",
    });

    var paginatedAddressGroupsExample = Scm.GetAddressGroupList.Invoke(new()
    {
        Folder = "All",
        Limit = 5,
        Offset = 0,
    });

    return new Dictionary<string, object?>
    {
        ["addressGroupsDataSourceResultsFromList"] = ,
        ["paginatedAddressGroups"] = ,
        ["paginationAddressGroupsDetails"] = 
        {
            { "totalObjectsInFolder", paginatedAddressGroupsExample.Apply(getAddressGroupListResult => getAddressGroupListResult.Total) },
            { "limitUsed", paginatedAddressGroupsExample.Apply(getAddressGroupListResult => getAddressGroupListResult.Limit) },
        },
    };
});

Example coming soon!

Example coming soon!

Using getAddressGroupList

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 getAddressGroupList(args: GetAddressGroupListArgs, opts?: InvokeOptions): Promise<GetAddressGroupListResult>
function getAddressGroupListOutput(args: GetAddressGroupListOutputArgs, opts?: InvokeOptions): Output<GetAddressGroupListResult>

def get_address_group_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) -> GetAddressGroupListResult
def get_address_group_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[GetAddressGroupListResult]

func GetAddressGroupList(ctx *Context, args *GetAddressGroupListArgs, opts ...InvokeOption) (*GetAddressGroupListResult, error)
func GetAddressGroupListOutput(ctx *Context, args *GetAddressGroupListOutputArgs, opts ...InvokeOption) GetAddressGroupListResultOutput

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

public static class GetAddressGroupList 
{
    public static Task<GetAddressGroupListResult> InvokeAsync(GetAddressGroupListArgs args, InvokeOptions? opts = null)
    public static Output<GetAddressGroupListResult> Invoke(GetAddressGroupListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAddressGroupListResult> getAddressGroupList(GetAddressGroupListArgs args, InvokeOptions options)
public static Output<GetAddressGroupListResult> getAddressGroupList(GetAddressGroupListArgs args, InvokeOptions options)

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