scm.getForwardingProfileUserLocationList

Strata Cloud Manager v1.0.6, Apr 25 26

Viewing docs for Strata Cloud Manager v1.0.6
published on Saturday, Apr 25, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

Viewing docs for Strata Cloud Manager v1.0.6
published on Saturday, Apr 25, 2026 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 "ListForwardingProfileUserLocations" API endpoint
// and return all forwarding profile user locations in the "Mobile Users" folder.
// 1. Use a single data block to fetch ALL user locations in the "Mobile Users" folder.
const allMobileUsers = scm.getForwardingProfileUserLocationList({
    folder: "Mobile Users",
});
export const forwardingProfileUserLocationDataSourceResultsFromList = allMobileUsers.then(allMobileUsers => .reduce((__obj, loc) => ({ ...__obj, [loc.id]: loc }), {}));
const paginatedUserLocationsExample = scm.getForwardingProfileUserLocationList({
    folder: "Mobile Users",
    limit: 5,
    offset: 0,
});
export const paginatedUserLocations = paginatedUserLocationsExample.then(paginatedUserLocationsExample => .reduce((__obj, loc) => ({ ...__obj, [loc.id]: loc }), {}));
export const paginationUserLocationsDetails = {
    totalObjectsInFolder: paginatedUserLocationsExample.then(paginatedUserLocationsExample => paginatedUserLocationsExample.total),
    limitUsed: paginatedUserLocationsExample.then(paginatedUserLocationsExample => paginatedUserLocationsExample.limit),
};

import pulumi
import pulumi_scm as scm

# This data source will call the "ListForwardingProfileUserLocations" API endpoint
# and return all forwarding profile user locations in the "Mobile Users" folder.
# 1. Use a single data block to fetch ALL user locations in the "Mobile Users" folder.
all_mobile_users = scm.get_forwarding_profile_user_location_list(folder="Mobile Users")
pulumi.export("forwardingProfileUserLocationDataSourceResultsFromList", {loc.id: loc for loc in all_mobile_users.datas})
paginated_user_locations_example = scm.get_forwarding_profile_user_location_list(folder="Mobile Users",
    limit=5,
    offset=0)
pulumi.export("paginatedUserLocations", {loc.id: loc for loc in paginated_user_locations_example.datas})
pulumi.export("paginationUserLocationsDetails", {
    "totalObjectsInFolder": paginated_user_locations_example.total,
    "limitUsed": paginated_user_locations_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 "ListForwardingProfileUserLocations" API endpoint
    // and return all forwarding profile user locations in the "Mobile Users" folder.
    // 1. Use a single data block to fetch ALL user locations in the "Mobile Users" folder.
    var allMobileUsers = Scm.Index.GetForwardingProfileUserLocationList.Invoke(new()
    {
        Folder = "Mobile Users",
    });

    var paginatedUserLocationsExample = Scm.Index.GetForwardingProfileUserLocationList.Invoke(new()
    {
        Folder = "Mobile Users",
        Limit = 5,
        Offset = 0,
    });

    return new Dictionary<string, object?>
    {
        ["forwardingProfileUserLocationDataSourceResultsFromList"] = ,
        ["paginatedUserLocations"] = ,
        ["paginationUserLocationsDetails"] = 
        {
            { "totalObjectsInFolder", paginatedUserLocationsExample.Apply(getForwardingProfileUserLocationListResult => getForwardingProfileUserLocationListResult.Total) },
            { "limitUsed", paginatedUserLocationsExample.Apply(getForwardingProfileUserLocationListResult => getForwardingProfileUserLocationListResult.Limit) },
        },
    };
});

Example coming soon!

Example coming soon!

Using getForwardingProfileUserLocationList

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 getForwardingProfileUserLocationList(args: GetForwardingProfileUserLocationListArgs, opts?: InvokeOptions): Promise<GetForwardingProfileUserLocationListResult>
function getForwardingProfileUserLocationListOutput(args: GetForwardingProfileUserLocationListOutputArgs, opts?: InvokeOptions): Output<GetForwardingProfileUserLocationListResult>

def get_forwarding_profile_user_location_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) -> GetForwardingProfileUserLocationListResult
def get_forwarding_profile_user_location_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[GetForwardingProfileUserLocationListResult]

func GetForwardingProfileUserLocationList(ctx *Context, args *GetForwardingProfileUserLocationListArgs, opts ...InvokeOption) (*GetForwardingProfileUserLocationListResult, error)
func GetForwardingProfileUserLocationListOutput(ctx *Context, args *GetForwardingProfileUserLocationListOutputArgs, opts ...InvokeOption) GetForwardingProfileUserLocationListResultOutput

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

public static class GetForwardingProfileUserLocationList 
{
    public static Task<GetForwardingProfileUserLocationListResult> InvokeAsync(GetForwardingProfileUserLocationListArgs args, InvokeOptions? opts = null)
    public static Output<GetForwardingProfileUserLocationListResult> Invoke(GetForwardingProfileUserLocationListInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetForwardingProfileUserLocationListResult> getForwardingProfileUserLocationList(GetForwardingProfileUserLocationListArgs args, InvokeOptions options)
public static Output<GetForwardingProfileUserLocationListResult> getForwardingProfileUserLocationList(GetForwardingProfileUserLocationListArgs args, InvokeOptions options)

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

getForwardingProfileUserLocationList Result

The following output properties are available:

Datas List<GetForwardingProfileUserLocationListData>: The data.
Id string: The provider-assigned unique ID for this managed resource.
Tfid string: The Terraform ID.
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 []GetForwardingProfileUserLocationListData: The data.
Id string: The provider-assigned unique ID for this managed resource.
Tfid string: The Terraform ID.
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<GetForwardingProfileUserLocationListData>: The data.
id String: The provider-assigned unique ID for this managed resource.
tfid String: The Terraform ID.
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 GetForwardingProfileUserLocationListData[]: The data.
id string: The provider-assigned unique ID for this managed resource.
tfid string: The Terraform ID.
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[GetForwardingProfileUserLocationListData]: The data.
id str: The provider-assigned unique ID for this managed resource.
tfid str: The Terraform ID.
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: The Terraform ID.
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

GetForwardingProfileUserLocationListData

Description string: Description of the user location
Folder string: The folder in which the resource is defined
Id string: The UUID of the user location
InternalHostDetection GetForwardingProfileUserLocationListDataInternalHostDetection: Configuration for detecting internal hosts using IP address and FQDN
IpAddresses List<string>: List of IP addresses that define the user location
Name string: alphanumeric string [ 0-9a-zA-Z._-]
Tfid string: The Terraform ID.

Description string: Description of the user location
Folder string: The folder in which the resource is defined
Id string: The UUID of the user location
InternalHostDetection GetForwardingProfileUserLocationListDataInternalHostDetection: Configuration for detecting internal hosts using IP address and FQDN
IpAddresses []string: List of IP addresses that define the user location
Name string: alphanumeric string [ 0-9a-zA-Z._-]
Tfid string: The Terraform ID.

description String: Description of the user location
folder String: The folder in which the resource is defined
id String: The UUID of the user location
internalHostDetection GetForwardingProfileUserLocationListDataInternalHostDetection: Configuration for detecting internal hosts using IP address and FQDN
ipAddresses List<String>: List of IP addresses that define the user location
name String: alphanumeric string [ 0-9a-zA-Z._-]
tfid String: The Terraform ID.

description string: Description of the user location
folder string: The folder in which the resource is defined
id string: The UUID of the user location
internalHostDetection GetForwardingProfileUserLocationListDataInternalHostDetection: Configuration for detecting internal hosts using IP address and FQDN
ipAddresses string[]: List of IP addresses that define the user location
name string: alphanumeric string [ 0-9a-zA-Z._-]
tfid string: The Terraform ID.

description str: Description of the user location
folder str: The folder in which the resource is defined
id str: The UUID of the user location
internal_host_detection GetForwardingProfileUserLocationListDataInternalHostDetection: Configuration for detecting internal hosts using IP address and FQDN
ip_addresses Sequence[str]: List of IP addresses that define the user location
name str: alphanumeric string [ 0-9a-zA-Z._-]
tfid str: The Terraform ID.

description String: Description of the user location
folder String: The folder in which the resource is defined
id String: The UUID of the user location
internalHostDetection Property Map: Configuration for detecting internal hosts using IP address and FQDN
ipAddresses List<String>: List of IP addresses that define the user location
name String: alphanumeric string [ 0-9a-zA-Z._-]
tfid String: The Terraform ID.

GetForwardingProfileUserLocationListDataInternalHostDetection

Fqdn string: user location fqdn
IpAddress string: user location ip address

Fqdn string: user location fqdn
IpAddress string: user location ip address

fqdn String: user location fqdn
ipAddress String: user location ip address

fqdn string: user location fqdn
ipAddress string: user location ip address

fqdn str: user location fqdn
ip_address str: user location ip address

fqdn String: user location fqdn
ipAddress String: user location ip address

Package Details

Repository: scm pulumi/pulumi-scm
License: Apache-2.0
Notes: This Pulumi package is based on the scm Terraform Provider.

Viewing docs for Strata Cloud Manager v1.0.6
published on Saturday, Apr 25, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-scm

scm.getForwardingProfileUserLocationList

On this page

On this page

Example Usage

Using getForwardingProfileUserLocationList

getForwardingProfileUserLocationList Result

Supporting Types

GetForwardingProfileUserLocationListData

GetForwardingProfileUserLocationListDataInternalHostDetection

Package Details

On this page

On this page