1. Packages
  2. Strata Cloud Manager Provider
  3. API Docs
  4. getBandwidthAllocationList
Viewing docs for Strata Cloud Manager v1.0.5
published on Saturday, Mar 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-scm

scm.getBandwidthAllocationList

scm logo
Viewing docs for Strata Cloud Manager v1.0.5
published on Saturday, Mar 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-scm

    Retrieves a listing of config items.

    Example Usage

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

const example = scm.getBandwidthAllocationList({
    name: "taiwan",
    limit: 50,
    offset: 0,
});
export const allocationList = example.then(example => example.datas);

    import pulumi
import pulumi_scm as scm

example = scm.get_bandwidth_allocation_list(name="taiwan",
    limit=50,
    offset=0)
pulumi.export("allocationList", example.datas)

    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 {
		example, err := scm.GetBandwidthAllocationList(ctx, &scm.GetBandwidthAllocationListArgs{
			Name:   pulumi.StringRef("taiwan"),
			Limit:  pulumi.IntRef(50),
			Offset: pulumi.IntRef(0),
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("allocationList", example.Datas)
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Scm.GetBandwidthAllocationList.Invoke(new()
    {
        Name = "taiwan",
        Limit = 50,
        Offset = 0,
    });

    return new Dictionary<string, object?>
    {
        ["allocationList"] = example.Apply(getBandwidthAllocationListResult => getBandwidthAllocationListResult.Datas),
    };
});

    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.GetBandwidthAllocationListArgs;
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 example = ScmFunctions.getBandwidthAllocationList(GetBandwidthAllocationListArgs.builder()
            .name("taiwan")
            .limit(50)
            .offset(0)
            .build());

        ctx.export("allocationList", example.datas());
    }
}

    variables:
  example:
    fn::invoke:
      function: scm:getBandwidthAllocationList
      arguments:
        name: taiwan
        limit: 50
        offset: 0
outputs:
  allocationList: ${example.datas}

    Using getBandwidthAllocationList

    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 getBandwidthAllocationList(args: GetBandwidthAllocationListArgs, opts?: InvokeOptions): Promise<GetBandwidthAllocationListResult>
function getBandwidthAllocationListOutput(args: GetBandwidthAllocationListOutputArgs, opts?: InvokeOptions): Output<GetBandwidthAllocationListResult>
    def get_bandwidth_allocation_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) -> GetBandwidthAllocationListResult
def get_bandwidth_allocation_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[GetBandwidthAllocationListResult]
    func GetBandwidthAllocationList(ctx *Context, args *GetBandwidthAllocationListArgs, opts ...InvokeOption) (*GetBandwidthAllocationListResult, error)
func GetBandwidthAllocationListOutput(ctx *Context, args *GetBandwidthAllocationListOutputArgs, opts ...InvokeOption) GetBandwidthAllocationListResultOutput

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

    public static class GetBandwidthAllocationList 
{
    public static Task<GetBandwidthAllocationListResult> InvokeAsync(GetBandwidthAllocationListArgs args, InvokeOptions? opts = null)
    public static Output<GetBandwidthAllocationListResult> Invoke(GetBandwidthAllocationListInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetBandwidthAllocationListResult> getBandwidthAllocationList(GetBandwidthAllocationListArgs args, InvokeOptions options)
public static Output<GetBandwidthAllocationListResult> getBandwidthAllocationList(GetBandwidthAllocationListArgs args, InvokeOptions options)

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

    getBandwidthAllocationList Result

    The following output properties are available:

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

    GetBandwidthAllocationListData

    AllocatedBandwidth int
    bandwidth to allocate in Mbps
    Name string
    name of the aggregated bandwidth region
    Qos GetBandwidthAllocationListDataQos
    Qos
    SpnNameLists List<string>
    Spn name list
    Tfid string
    The Terraform ID.
    AllocatedBandwidth int
    bandwidth to allocate in Mbps
    Name string
    name of the aggregated bandwidth region
    Qos GetBandwidthAllocationListDataQos
    Qos
    SpnNameLists []string
    Spn name list
    Tfid string
    The Terraform ID.
    allocatedBandwidth Integer
    bandwidth to allocate in Mbps
    name String
    name of the aggregated bandwidth region
    qos GetBandwidthAllocationListDataQos
    Qos
    spnNameLists List<String>
    Spn name list
    tfid String
    The Terraform ID.
    allocatedBandwidth number
    bandwidth to allocate in Mbps
    name string
    name of the aggregated bandwidth region
    qos GetBandwidthAllocationListDataQos
    Qos
    spnNameLists string[]
    Spn name list
    tfid string
    The Terraform ID.
    allocated_bandwidth int
    bandwidth to allocate in Mbps
    name str
    name of the aggregated bandwidth region
    qos GetBandwidthAllocationListDataQos
    Qos
    spn_name_lists Sequence[str]
    Spn name list
    tfid str
    The Terraform ID.
    allocatedBandwidth Number
    bandwidth to allocate in Mbps
    name String
    name of the aggregated bandwidth region
    qos Property Map
    Qos
    spnNameLists List<String>
    Spn name list
    tfid String
    The Terraform ID.

    GetBandwidthAllocationListDataQos

    Customized bool
    Customized
    Enabled bool
    Enabled
    GuaranteedRatio double
    Guaranteed ratio
    Profile string
    Profile
    Customized bool
    Customized
    Enabled bool
    Enabled
    GuaranteedRatio float64
    Guaranteed ratio
    Profile string
    Profile
    customized Boolean
    Customized
    enabled Boolean
    Enabled
    guaranteedRatio Double
    Guaranteed ratio
    profile String
    Profile
    customized boolean
    Customized
    enabled boolean
    Enabled
    guaranteedRatio number
    Guaranteed ratio
    profile string
    Profile
    customized bool
    Customized
    enabled bool
    Enabled
    guaranteed_ratio float
    Guaranteed ratio
    profile str
    Profile
    customized Boolean
    Customized
    enabled Boolean
    Enabled
    guaranteedRatio Number
    Guaranteed ratio
    profile String
    Profile

    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.5
    published on Saturday, Mar 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-scm
      Try Pulumi Cloud free. Your team will thank you.