Retrieves a listing of config items.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
//
// Data source to retrieve a list of SCM QoS Profile Signature objects.
//
// Example 1: Fetch a list of all SCM QoS Profile in the "Service Connections" folder.
// Folder must be one of [Remote Networks, Service Connections]"
const allShared = scm.getQosProfileList({
folder: "Service Connections",
});
export const scmQosProfileListAllShared = allShared.then(allShared => allShared.datas);
import pulumi
import pulumi_scm as scm
#
# Data source to retrieve a list of SCM QoS Profile Signature objects.
#
# Example 1: Fetch a list of all SCM QoS Profile in the "Service Connections" folder.
# Folder must be one of [Remote Networks, Service Connections]"
all_shared = scm.get_qos_profile_list(folder="Service Connections")
pulumi.export("scmQosProfileListAllShared", all_shared.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 {
// Data source to retrieve a list of SCM QoS Profile Signature objects.
//
// Example 1: Fetch a list of all SCM QoS Profile in the "Service Connections" folder.
// Folder must be one of [Remote Networks, Service Connections]"
allShared, err := scm.GetQosProfileList(ctx, &scm.GetQosProfileListArgs{
Folder: pulumi.StringRef("Service Connections"),
}, nil)
if err != nil {
return err
}
ctx.Export("scmQosProfileListAllShared", allShared.Datas)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;
return await Deployment.RunAsync(() =>
{
//
// Data source to retrieve a list of SCM QoS Profile Signature objects.
//
// Example 1: Fetch a list of all SCM QoS Profile in the "Service Connections" folder.
// Folder must be one of [Remote Networks, Service Connections]"
var allShared = Scm.GetQosProfileList.Invoke(new()
{
Folder = "Service Connections",
});
return new Dictionary<string, object?>
{
["scmQosProfileListAllShared"] = allShared.Apply(getQosProfileListResult => getQosProfileListResult.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.GetQosProfileListArgs;
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) {
//
// Data source to retrieve a list of SCM QoS Profile Signature objects.
//
// Example 1: Fetch a list of all SCM QoS Profile in the "Service Connections" folder.
// Folder must be one of [Remote Networks, Service Connections]"
final var allShared = ScmFunctions.getQosProfileList(GetQosProfileListArgs.builder()
.folder("Service Connections")
.build());
ctx.export("scmQosProfileListAllShared", allShared.datas());
}
}
variables:
#
# Data source to retrieve a list of SCM QoS Profile Signature objects.
#
# Example 1: Fetch a list of all SCM QoS Profile in the "Service Connections" folder.
# Folder must be one of [Remote Networks, Service Connections]"
allShared:
fn::invoke:
function: scm:getQosProfileList
arguments:
folder: Service Connections
outputs:
# Output the list of all SSCM QoS Profiles from the "Service Connections" folder.
scmQosProfileListAllShared: ${allShared.datas}
Using getQosProfileList
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 getQosProfileList(args: GetQosProfileListArgs, opts?: InvokeOptions): Promise<GetQosProfileListResult>
function getQosProfileListOutput(args: GetQosProfileListOutputArgs, opts?: InvokeOptions): Output<GetQosProfileListResult>def get_qos_profile_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) -> GetQosProfileListResult
def get_qos_profile_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[GetQosProfileListResult]func GetQosProfileList(ctx *Context, args *GetQosProfileListArgs, opts ...InvokeOption) (*GetQosProfileListResult, error)
func GetQosProfileListOutput(ctx *Context, args *GetQosProfileListOutputArgs, opts ...InvokeOption) GetQosProfileListResultOutput> Note: This function is named GetQosProfileList in the Go SDK.
public static class GetQosProfileList
{
public static Task<GetQosProfileListResult> InvokeAsync(GetQosProfileListArgs args, InvokeOptions? opts = null)
public static Output<GetQosProfileListResult> Invoke(GetQosProfileListInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetQosProfileListResult> getQosProfileList(GetQosProfileListArgs args, InvokeOptions options)
public static Output<GetQosProfileListResult> getQosProfileList(GetQosProfileListArgs args, InvokeOptions options)
fn::invoke:
function: scm:index/getQosProfileList:getQosProfileList
arguments:
# arguments dictionaryThe following arguments are supported:
getQosProfileList Result
The following output properties are available:
- Datas
List<Get
Qos Profile List Data> - 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
[]Get
Qos Profile List Data - 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<Get
Qos Profile List Data> - 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
Get
Qos Profile List Data[] - 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[Get
Qos Profile List Data] - 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
GetQosProfileListData
- Aggregate
Bandwidth GetQos Profile List Data Aggregate Bandwidth - Aggregate bandwidth
- Class
Bandwidth GetType Qos Profile List Data Class Bandwidth Type - Class bandwidth type
- Device string
- The device in which the resource is defined
- Folder string
- The folder of the item. Default: Shared.
- Id string
- UUID of the resource
- Name string
- The name of the item.
- Snippet string
- The snippet of the item.
- Tfid string
- The Terraform ID.
- Aggregate
Bandwidth GetQos Profile List Data Aggregate Bandwidth - Aggregate bandwidth
- Class
Bandwidth GetType Qos Profile List Data Class Bandwidth Type - Class bandwidth type
- Device string
- The device in which the resource is defined
- Folder string
- The folder of the item. Default: Shared.
- Id string
- UUID of the resource
- Name string
- The name of the item.
- Snippet string
- The snippet of the item.
- Tfid string
- The Terraform ID.
- aggregate
Bandwidth GetQos Profile List Data Aggregate Bandwidth - Aggregate bandwidth
- class
Bandwidth GetType Qos Profile List Data Class Bandwidth Type - Class bandwidth type
- device String
- The device in which the resource is defined
- folder String
- The folder of the item. Default: Shared.
- id String
- UUID of the resource
- name String
- The name of the item.
- snippet String
- The snippet of the item.
- tfid String
- The Terraform ID.
- aggregate
Bandwidth GetQos Profile List Data Aggregate Bandwidth - Aggregate bandwidth
- class
Bandwidth GetType Qos Profile List Data Class Bandwidth Type - Class bandwidth type
- device string
- The device in which the resource is defined
- folder string
- The folder of the item. Default: Shared.
- id string
- UUID of the resource
- name string
- The name of the item.
- snippet string
- The snippet of the item.
- tfid string
- The Terraform ID.
- aggregate_
bandwidth GetQos Profile List Data Aggregate Bandwidth - Aggregate bandwidth
- class_
bandwidth_ Gettype Qos Profile List Data Class Bandwidth Type - Class bandwidth type
- device str
- The device in which the resource is defined
- folder str
- The folder of the item. Default: Shared.
- id str
- UUID of the resource
- name str
- The name of the item.
- snippet str
- The snippet of the item.
- tfid str
- The Terraform ID.
- aggregate
Bandwidth Property Map - Aggregate bandwidth
- class
Bandwidth Property MapType - Class bandwidth type
- device String
- The device in which the resource is defined
- folder String
- The folder of the item. Default: Shared.
- id String
- UUID of the resource
- name String
- The name of the item.
- snippet String
- The snippet of the item.
- tfid String
- The Terraform ID.
GetQosProfileListDataAggregateBandwidth
- Egress
Guaranteed int - guaranteed sending bandwidth in mbps
- Egress
Max int - max sending bandwidth in mbps
- Egress
Guaranteed int - guaranteed sending bandwidth in mbps
- Egress
Max int - max sending bandwidth in mbps
- egress
Guaranteed Integer - guaranteed sending bandwidth in mbps
- egress
Max Integer - max sending bandwidth in mbps
- egress
Guaranteed number - guaranteed sending bandwidth in mbps
- egress
Max number - max sending bandwidth in mbps
- egress_
guaranteed int - guaranteed sending bandwidth in mbps
- egress_
max int - max sending bandwidth in mbps
- egress
Guaranteed Number - guaranteed sending bandwidth in mbps
- egress
Max Number - max sending bandwidth in mbps
GetQosProfileListDataClassBandwidthType
- Mbps
Get
Qos Profile List Data Class Bandwidth Type Mbps - Mbps
- Percentage
Get
Qos Profile List Data Class Bandwidth Type Percentage Percentage
ℹ️ Note: You must specify exactly one of
mbpsandpercentage.
- Mbps
Get
Qos Profile List Data Class Bandwidth Type Mbps - Mbps
- Percentage
Get
Qos Profile List Data Class Bandwidth Type Percentage Percentage
ℹ️ Note: You must specify exactly one of
mbpsandpercentage.
- mbps
Get
Qos Profile List Data Class Bandwidth Type Mbps - Mbps
- percentage
Get
Qos Profile List Data Class Bandwidth Type Percentage Percentage
ℹ️ Note: You must specify exactly one of
mbpsandpercentage.
- mbps
Get
Qos Profile List Data Class Bandwidth Type Mbps - Mbps
- percentage
Get
Qos Profile List Data Class Bandwidth Type Percentage Percentage
ℹ️ Note: You must specify exactly one of
mbpsandpercentage.
- mbps
Get
Qos Profile List Data Class Bandwidth Type Mbps - Mbps
- percentage
Get
Qos Profile List Data Class Bandwidth Type Percentage Percentage
ℹ️ Note: You must specify exactly one of
mbpsandpercentage.
- mbps Property Map
- Mbps
- percentage Property Map
Percentage
ℹ️ Note: You must specify exactly one of
mbpsandpercentage.
GetQosProfileListDataClassBandwidthTypeMbps
- Classes
List<Get
Qos Profile List Data Class Bandwidth Type Mbps Class> - QoS setting for traffic classes
- Classes
[]Get
Qos Profile List Data Class Bandwidth Type Mbps Class - QoS setting for traffic classes
- classes
List<Get
Qos Profile List Data Class Bandwidth Type Mbps Class> - QoS setting for traffic classes
- classes
Get
Qos Profile List Data Class Bandwidth Type Mbps Class[] - QoS setting for traffic classes
- classes
Sequence[Get
Qos Profile List Data Class Bandwidth Type Mbps Class] - QoS setting for traffic classes
- classes List<Property Map>
- QoS setting for traffic classes
GetQosProfileListDataClassBandwidthTypeMbpsClass
- Class
Bandwidth GetQos Profile List Data Class Bandwidth Type Mbps Class Class Bandwidth - Class bandwidth
- Name string
- Traffic class
- Priority string
- traffic class priority
- Class
Bandwidth GetQos Profile List Data Class Bandwidth Type Mbps Class Class Bandwidth - Class bandwidth
- Name string
- Traffic class
- Priority string
- traffic class priority
- class
Bandwidth GetQos Profile List Data Class Bandwidth Type Mbps Class Class Bandwidth - Class bandwidth
- name String
- Traffic class
- priority String
- traffic class priority
- class
Bandwidth GetQos Profile List Data Class Bandwidth Type Mbps Class Class Bandwidth - Class bandwidth
- name string
- Traffic class
- priority string
- traffic class priority
- class_
bandwidth GetQos Profile List Data Class Bandwidth Type Mbps Class Class Bandwidth - Class bandwidth
- name str
- Traffic class
- priority str
- traffic class priority
- class
Bandwidth Property Map - Class bandwidth
- name String
- Traffic class
- priority String
- traffic class priority
GetQosProfileListDataClassBandwidthTypeMbpsClassClassBandwidth
- Egress
Guaranteed int - guaranteed sending bandwidth in mbps
- Egress
Max int - max sending bandwidth in mbps
- Egress
Guaranteed int - guaranteed sending bandwidth in mbps
- Egress
Max int - max sending bandwidth in mbps
- egress
Guaranteed Integer - guaranteed sending bandwidth in mbps
- egress
Max Integer - max sending bandwidth in mbps
- egress
Guaranteed number - guaranteed sending bandwidth in mbps
- egress
Max number - max sending bandwidth in mbps
- egress_
guaranteed int - guaranteed sending bandwidth in mbps
- egress_
max int - max sending bandwidth in mbps
- egress
Guaranteed Number - guaranteed sending bandwidth in mbps
- egress
Max Number - max sending bandwidth in mbps
GetQosProfileListDataClassBandwidthTypePercentage
- Classes
List<Get
Qos Profile List Data Class Bandwidth Type Percentage Class> - QoS setting for traffic classes
- Classes
[]Get
Qos Profile List Data Class Bandwidth Type Percentage Class - QoS setting for traffic classes
- classes
List<Get
Qos Profile List Data Class Bandwidth Type Percentage Class> - QoS setting for traffic classes
- classes
Get
Qos Profile List Data Class Bandwidth Type Percentage Class[] - QoS setting for traffic classes
- classes
Sequence[Get
Qos Profile List Data Class Bandwidth Type Percentage Class] - QoS setting for traffic classes
- classes List<Property Map>
- QoS setting for traffic classes
GetQosProfileListDataClassBandwidthTypePercentageClass
- Class
Bandwidth GetQos Profile List Data Class Bandwidth Type Percentage Class Class Bandwidth - Class bandwidth
- Name string
- Traffic class
- Priority string
- traffic class priority
- Class
Bandwidth GetQos Profile List Data Class Bandwidth Type Percentage Class Class Bandwidth - Class bandwidth
- Name string
- Traffic class
- Priority string
- traffic class priority
- class
Bandwidth GetQos Profile List Data Class Bandwidth Type Percentage Class Class Bandwidth - Class bandwidth
- name String
- Traffic class
- priority String
- traffic class priority
- class
Bandwidth GetQos Profile List Data Class Bandwidth Type Percentage Class Class Bandwidth - Class bandwidth
- name string
- Traffic class
- priority string
- traffic class priority
- class_
bandwidth GetQos Profile List Data Class Bandwidth Type Percentage Class Class Bandwidth - Class bandwidth
- name str
- Traffic class
- priority str
- traffic class priority
- class
Bandwidth Property Map - Class bandwidth
- name String
- Traffic class
- priority String
- traffic class priority
GetQosProfileListDataClassBandwidthTypePercentageClassClassBandwidth
- Egress
Guaranteed int - guaranteed sending bandwidth in percentage
- Egress
Max int - max sending bandwidth in percentage
- Egress
Guaranteed int - guaranteed sending bandwidth in percentage
- Egress
Max int - max sending bandwidth in percentage
- egress
Guaranteed Integer - guaranteed sending bandwidth in percentage
- egress
Max Integer - max sending bandwidth in percentage
- egress
Guaranteed number - guaranteed sending bandwidth in percentage
- egress
Max number - max sending bandwidth in percentage
- egress_
guaranteed int - guaranteed sending bandwidth in percentage
- egress_
max int - max sending bandwidth in percentage
- egress
Guaranteed Number - guaranteed sending bandwidth in percentage
- egress
Max Number - max sending bandwidth in percentage
Package Details
- Repository
- scm pulumi/pulumi-scm
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
scmTerraform Provider.
