getAddressList

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.getAddressList({
    folder: "All",
});
export const addressDataSourceResultsFromList = allShared.then(allShared => .reduce((__obj, addr) => ({ ...__obj, [addr.id]: addr })));
const paginatedAddressesExample = scm.getAddressList({
    folder: "All",
    limit: 5,
    offset: 0,
});
export const paginatedAddresses = paginatedAddressesExample.then(paginatedAddressesExample => .reduce((__obj, addr) => ({ ...__obj, [addr.id]: addr })));
export const paginationAddressesDetails = {
    totalObjectsInFolder: paginatedAddressesExample.then(paginatedAddressesExample => paginatedAddressesExample.total),
    limitUsed: paginatedAddressesExample.then(paginatedAddressesExample => paginatedAddressesExample.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_list(folder="All")
pulumi.export("addressDataSourceResultsFromList", {addr.id: addr for addr in all_shared.datas})
paginated_addresses_example = scm.get_address_list(folder="All",
    limit=5,
    offset=0)
pulumi.export("paginatedAddresses", {addr.id: addr for addr in paginated_addresses_example.datas})
pulumi.export("paginationAddressesDetails", {
    "totalObjectsInFolder": paginated_addresses_example.total,
    "limitUsed": paginated_addresses_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.GetAddressList.Invoke(new()
    {
        Folder = "All",
    });

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

    return new Dictionary<string, object?>
    {
        ["addressDataSourceResultsFromList"] = ,
        ["paginatedAddresses"] = ,
        ["paginationAddressesDetails"] = 
        {
            { "totalObjectsInFolder", paginatedAddressesExample.Apply(getAddressListResult => getAddressListResult.Total) },
            { "limitUsed", paginatedAddressesExample.Apply(getAddressListResult => getAddressListResult.Limit) },
        },
    };
});

Example coming soon!

Example coming soon!

Using getAddressList

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 getAddressList(args: GetAddressListArgs, opts?: InvokeOptions): Promise<GetAddressListResult>
function getAddressListOutput(args: GetAddressListOutputArgs, opts?: InvokeOptions): Output<GetAddressListResult>

def get_address_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) -> GetAddressListResult
def get_address_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[GetAddressListResult]

func GetAddressList(ctx *Context, args *GetAddressListArgs, opts ...InvokeOption) (*GetAddressListResult, error)
func GetAddressListOutput(ctx *Context, args *GetAddressListOutputArgs, opts ...InvokeOption) GetAddressListResultOutput

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

public static class GetAddressList 
{
    public static Task<GetAddressListResult> InvokeAsync(GetAddressListArgs args, InvokeOptions? opts = null)
    public static Output<GetAddressListResult> Invoke(GetAddressListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAddressListResult> getAddressList(GetAddressListArgs args, InvokeOptions options)
public static Output<GetAddressListResult> getAddressList(GetAddressListArgs args, InvokeOptions options)

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

getAddressList Result

The following output properties are available:

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

GetAddressListData

Description string: The description of the address object
Device string: The device in which the resource is defined
Folder string: The folder in which the resource is defined
Fqdn string: Fully qualified domain name
Id string: The UUID of the address object
IpNetmask string: IP address with or without CIDR notation
IpRange string: Ip range
IpWildcard string: IP wildcard mask
Name string: The name of the address object
Snippet string: The snippet in which the resource is defined
Tags List<string>: Tags assocaited with the address object
Tfid string

Description string: The description of the address object
Device string: The device in which the resource is defined
Folder string: The folder in which the resource is defined
Fqdn string: Fully qualified domain name
Id string: The UUID of the address object
IpNetmask string: IP address with or without CIDR notation
IpRange string: Ip range
IpWildcard string: IP wildcard mask
Name string: The name of the address object
Snippet string: The snippet in which the resource is defined
Tags []string: Tags assocaited with the address object
Tfid string

description String: The description of the address object
device String: The device in which the resource is defined
folder String: The folder in which the resource is defined
fqdn String: Fully qualified domain name
id String: The UUID of the address object
ipNetmask String: IP address with or without CIDR notation
ipRange String: Ip range
ipWildcard String: IP wildcard mask
name String: The name of the address object
snippet String: The snippet in which the resource is defined
tags List<String>: Tags assocaited with the address object
tfid String

description string: The description of the address object
device string: The device in which the resource is defined
folder string: The folder in which the resource is defined
fqdn string: Fully qualified domain name
id string: The UUID of the address object
ipNetmask string: IP address with or without CIDR notation
ipRange string: Ip range
ipWildcard string: IP wildcard mask
name string: The name of the address object
snippet string: The snippet in which the resource is defined
tags string[]: Tags assocaited with the address object
tfid string

description str: The description of the address object
device str: The device in which the resource is defined
folder str: The folder in which the resource is defined
fqdn str: Fully qualified domain name
id str: The UUID of the address object
ip_netmask str: IP address with or without CIDR notation
ip_range str: Ip range
ip_wildcard str: IP wildcard mask
name str: The name of the address object
snippet str: The snippet in which the resource is defined
tags Sequence[str]: Tags assocaited with the address object
tfid str

description String: The description of the address object
device String: The device in which the resource is defined
folder String: The folder in which the resource is defined
fqdn String: Fully qualified domain name
id String: The UUID of the address object
ipNetmask String: IP address with or without CIDR notation
ipRange String: Ip range
ipWildcard String: IP wildcard mask
name String: The name of the address object
snippet String: The snippet in which the resource is defined
tags List<String>: Tags assocaited with the address object
tfid String

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.4.3 published on Saturday, Nov 8, 2025 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

scm.getAddressList

On this page

On this page

Example Usage

Using getAddressList

getAddressList Result

Supporting Types

GetAddressListData

Package Details

On this page

On this page