1. Packages
  2. Packages
  3. Strata Cloud Manager Provider
  4. API Docs
  5. getForwardingProfileDestinationList
Viewing docs for Strata Cloud Manager v1.0.6
published on Saturday, Apr 25, 2026 by Pulumi
scm logo
Viewing docs for Strata Cloud Manager v1.0.6
published on Saturday, Apr 25, 2026 by Pulumi

    Retrieves a listing of config items.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as scm from "@pulumi/scm";
    
    // This data source will call the "ListForwardingProfileDestinations" API endpoint
    // and return all forwarding profile destinations in the "Mobile Users" folder.
    // 1. Use a single data block to fetch ALL forwarding profile destinations in the "Mobile Users" folder.
    const allMobileUsers = scm.getForwardingProfileDestinationList({
        folder: "Mobile Users",
    });
    export const forwardingProfileDestinationDataSourceResultsFromList = allMobileUsers.then(allMobileUsers => .reduce((__obj, dest) => ({ ...__obj, [dest.id]: dest }), {}));
    const paginatedDestinationsExample = scm.getForwardingProfileDestinationList({
        folder: "Mobile Users",
        limit: 5,
        offset: 0,
    });
    export const paginatedDestinations = paginatedDestinationsExample.then(paginatedDestinationsExample => .reduce((__obj, dest) => ({ ...__obj, [dest.id]: dest }), {}));
    export const paginationDestinationsDetails = {
        totalObjectsInFolder: paginatedDestinationsExample.then(paginatedDestinationsExample => paginatedDestinationsExample.total),
        limitUsed: paginatedDestinationsExample.then(paginatedDestinationsExample => paginatedDestinationsExample.limit),
    };
    
    import pulumi
    import pulumi_scm as scm
    
    # This data source will call the "ListForwardingProfileDestinations" API endpoint
    # and return all forwarding profile destinations in the "Mobile Users" folder.
    # 1. Use a single data block to fetch ALL forwarding profile destinations in the "Mobile Users" folder.
    all_mobile_users = scm.get_forwarding_profile_destination_list(folder="Mobile Users")
    pulumi.export("forwardingProfileDestinationDataSourceResultsFromList", {dest.id: dest for dest in all_mobile_users.datas})
    paginated_destinations_example = scm.get_forwarding_profile_destination_list(folder="Mobile Users",
        limit=5,
        offset=0)
    pulumi.export("paginatedDestinations", {dest.id: dest for dest in paginated_destinations_example.datas})
    pulumi.export("paginationDestinationsDetails", {
        "totalObjectsInFolder": paginated_destinations_example.total,
        "limitUsed": paginated_destinations_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 "ListForwardingProfileDestinations" API endpoint
        // and return all forwarding profile destinations in the "Mobile Users" folder.
        // 1. Use a single data block to fetch ALL forwarding profile destinations in the "Mobile Users" folder.
        var allMobileUsers = Scm.Index.GetForwardingProfileDestinationList.Invoke(new()
        {
            Folder = "Mobile Users",
        });
    
        var paginatedDestinationsExample = Scm.Index.GetForwardingProfileDestinationList.Invoke(new()
        {
            Folder = "Mobile Users",
            Limit = 5,
            Offset = 0,
        });
    
        return new Dictionary<string, object?>
        {
            ["forwardingProfileDestinationDataSourceResultsFromList"] = ,
            ["paginatedDestinations"] = ,
            ["paginationDestinationsDetails"] = 
            {
                { "totalObjectsInFolder", paginatedDestinationsExample.Apply(getForwardingProfileDestinationListResult => getForwardingProfileDestinationListResult.Total) },
                { "limitUsed", paginatedDestinationsExample.Apply(getForwardingProfileDestinationListResult => getForwardingProfileDestinationListResult.Limit) },
            },
        };
    });
    
    Example coming soon!
    
    Example coming soon!
    

    Using getForwardingProfileDestinationList

    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 getForwardingProfileDestinationList(args: GetForwardingProfileDestinationListArgs, opts?: InvokeOptions): Promise<GetForwardingProfileDestinationListResult>
    function getForwardingProfileDestinationListOutput(args: GetForwardingProfileDestinationListOutputArgs, opts?: InvokeOptions): Output<GetForwardingProfileDestinationListResult>
    def get_forwarding_profile_destination_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) -> GetForwardingProfileDestinationListResult
    def get_forwarding_profile_destination_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[GetForwardingProfileDestinationListResult]
    func GetForwardingProfileDestinationList(ctx *Context, args *GetForwardingProfileDestinationListArgs, opts ...InvokeOption) (*GetForwardingProfileDestinationListResult, error)
    func GetForwardingProfileDestinationListOutput(ctx *Context, args *GetForwardingProfileDestinationListOutputArgs, opts ...InvokeOption) GetForwardingProfileDestinationListResultOutput

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

    public static class GetForwardingProfileDestinationList 
    {
        public static Task<GetForwardingProfileDestinationListResult> InvokeAsync(GetForwardingProfileDestinationListArgs args, InvokeOptions? opts = null)
        public static Output<GetForwardingProfileDestinationListResult> Invoke(GetForwardingProfileDestinationListInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetForwardingProfileDestinationListResult> getForwardingProfileDestinationList(GetForwardingProfileDestinationListArgs args, InvokeOptions options)
    public static Output<GetForwardingProfileDestinationListResult> getForwardingProfileDestinationList(GetForwardingProfileDestinationListArgs args, InvokeOptions options)
    
    fn::invoke:
      function: scm:index/getForwardingProfileDestinationList:getForwardingProfileDestinationList
      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.

    getForwardingProfileDestinationList Result

    The following output properties are available:

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

    GetForwardingProfileDestinationListData

    Description string
    description of the destination
    Folder string
    The folder in which the resource is defined
    Fqdns List<GetForwardingProfileDestinationListDataFqdn>
    List of FQDN based destination entries
    Id string
    The UUID of the destination
    IpAddresses List<GetForwardingProfileDestinationListDataIpAddress>
    List of IP address based destination entries
    Name string
    alphanumeric string [ 0-9a-zA-Z._ -]
    Tfid string
    The Terraform ID.
    Description string
    description of the destination
    Folder string
    The folder in which the resource is defined
    Fqdns []GetForwardingProfileDestinationListDataFqdn
    List of FQDN based destination entries
    Id string
    The UUID of the destination
    IpAddresses []GetForwardingProfileDestinationListDataIpAddress
    List of IP address based destination entries
    Name string
    alphanumeric string [ 0-9a-zA-Z._ -]
    Tfid string
    The Terraform ID.
    description String
    description of the destination
    folder String
    The folder in which the resource is defined
    fqdns List<GetForwardingProfileDestinationListDataFqdn>
    List of FQDN based destination entries
    id String
    The UUID of the destination
    ipAddresses List<GetForwardingProfileDestinationListDataIpAddress>
    List of IP address based destination entries
    name String
    alphanumeric string [ 0-9a-zA-Z._ -]
    tfid String
    The Terraform ID.
    description string
    description of the destination
    folder string
    The folder in which the resource is defined
    fqdns GetForwardingProfileDestinationListDataFqdn[]
    List of FQDN based destination entries
    id string
    The UUID of the destination
    ipAddresses GetForwardingProfileDestinationListDataIpAddress[]
    List of IP address based destination entries
    name string
    alphanumeric string [ 0-9a-zA-Z._ -]
    tfid string
    The Terraform ID.
    description str
    description of the destination
    folder str
    The folder in which the resource is defined
    fqdns Sequence[GetForwardingProfileDestinationListDataFqdn]
    List of FQDN based destination entries
    id str
    The UUID of the destination
    ip_addresses Sequence[GetForwardingProfileDestinationListDataIpAddress]
    List of IP address based destination entries
    name str
    alphanumeric string [ 0-9a-zA-Z._ -]
    tfid str
    The Terraform ID.
    description String
    description of the destination
    folder String
    The folder in which the resource is defined
    fqdns List<Property Map>
    List of FQDN based destination entries
    id String
    The UUID of the destination
    ipAddresses List<Property Map>
    List of IP address based destination entries
    name String
    alphanumeric string [ 0-9a-zA-Z._ -]
    tfid String
    The Terraform ID.

    GetForwardingProfileDestinationListDataFqdn

    Name string
    alphanumeric string [*0-9a-zA-Z._-] and at most one $ by the end
    Port int
    Port number for fqdn based destination
    Name string
    alphanumeric string [*0-9a-zA-Z._-] and at most one $ by the end
    Port int
    Port number for fqdn based destination
    name String
    alphanumeric string [*0-9a-zA-Z._-] and at most one $ by the end
    port Integer
    Port number for fqdn based destination
    name string
    alphanumeric string [*0-9a-zA-Z._-] and at most one $ by the end
    port number
    Port number for fqdn based destination
    name str
    alphanumeric string [*0-9a-zA-Z._-] and at most one $ by the end
    port int
    Port number for fqdn based destination
    name String
    alphanumeric string [*0-9a-zA-Z._-] and at most one $ by the end
    port Number
    Port number for fqdn based destination

    GetForwardingProfileDestinationListDataIpAddress

    Name string
    IP address with wildcards and CIDR notation support
    Port int
    Port number for IP address based destination
    Name string
    IP address with wildcards and CIDR notation support
    Port int
    Port number for IP address based destination
    name String
    IP address with wildcards and CIDR notation support
    port Integer
    Port number for IP address based destination
    name string
    IP address with wildcards and CIDR notation support
    port number
    Port number for IP address based destination
    name str
    IP address with wildcards and CIDR notation support
    port int
    Port number for IP address based destination
    name String
    IP address with wildcards and CIDR notation support
    port Number
    Port number for IP address based destination

    Package Details

    Repository
    scm pulumi/pulumi-scm
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the scm Terraform Provider.
    scm logo
    Viewing docs for Strata Cloud Manager v1.0.6
    published on Saturday, Apr 25, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.