QosProfile data source
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as scm from "@pulumi/scm";
//
// Data source to retrieve a single SCM QoS Profile object by its ID.
//
// Replace the ID with the UUID of the QoS Profile you want to find.
const scmQosProf = scm.getQosProfile({
id: "cffecf78-b3b1-4b01-ad31-c69bf839850b",
});
export const scmQosProfileDetails = {
id: scmQosProf.then(scmQosProf => scmQosProf.id),
folder: scmQosProf.then(scmQosProf => scmQosProf.folder),
name: scmQosProf.then(scmQosProf => scmQosProf.name),
};
import pulumi
import pulumi_scm as scm
#
# Data source to retrieve a single SCM QoS Profile object by its ID.
#
# Replace the ID with the UUID of the QoS Profile you want to find.
scm_qos_prof = scm.get_qos_profile(id="cffecf78-b3b1-4b01-ad31-c69bf839850b")
pulumi.export("scmQosProfileDetails", {
"id": scm_qos_prof.id,
"folder": scm_qos_prof.folder,
"name": scm_qos_prof.name,
})
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 single SCM QoS Profile object by its ID.
//
// Replace the ID with the UUID of the QoS Profile you want to find.
scmQosProf, err := scm.LookupQosProfile(ctx, &scm.LookupQosProfileArgs{
Id: "cffecf78-b3b1-4b01-ad31-c69bf839850b",
}, nil)
if err != nil {
return err
}
ctx.Export("scmQosProfileDetails", pulumi.StringMap{
"id": scmQosProf.Id,
"folder": scmQosProf.Folder,
"name": scmQosProf.Name,
})
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Scm = Pulumi.Scm;
return await Deployment.RunAsync(() =>
{
//
// Data source to retrieve a single SCM QoS Profile object by its ID.
//
// Replace the ID with the UUID of the QoS Profile you want to find.
var scmQosProf = Scm.GetQosProfile.Invoke(new()
{
Id = "cffecf78-b3b1-4b01-ad31-c69bf839850b",
});
return new Dictionary<string, object?>
{
["scmQosProfileDetails"] =
{
{ "id", scmQosProf.Apply(getQosProfileResult => getQosProfileResult.Id) },
{ "folder", scmQosProf.Apply(getQosProfileResult => getQosProfileResult.Folder) },
{ "name", scmQosProf.Apply(getQosProfileResult => getQosProfileResult.Name) },
},
};
});
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.GetQosProfileArgs;
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 single SCM QoS Profile object by its ID.
//
// Replace the ID with the UUID of the QoS Profile you want to find.
final var scmQosProf = ScmFunctions.getQosProfile(GetQosProfileArgs.builder()
.id("cffecf78-b3b1-4b01-ad31-c69bf839850b")
.build());
ctx.export("scmQosProfileDetails", Map.ofEntries(
Map.entry("id", scmQosProf.id()),
Map.entry("folder", scmQosProf.folder()),
Map.entry("name", scmQosProf.name())
));
}
}
variables:
#
# Data source to retrieve a single SCM QoS Profile object by its ID.
#
# Replace the ID with the UUID of the QoS Profile you want to find.
scmQosProf:
fn::invoke:
function: scm:getQosProfile
arguments:
id: cffecf78-b3b1-4b01-ad31-c69bf839850b
outputs:
# Output the details of the single QoS Profile object found.
scmQosProfileDetails:
id: ${scmQosProf.id}
folder: ${scmQosProf.folder}
name: ${scmQosProf.name}
Using getQosProfile
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 getQosProfile(args: GetQosProfileArgs, opts?: InvokeOptions): Promise<GetQosProfileResult>
function getQosProfileOutput(args: GetQosProfileOutputArgs, opts?: InvokeOptions): Output<GetQosProfileResult>def get_qos_profile(device: Optional[str] = None,
folder: Optional[str] = None,
id: Optional[str] = None,
name: Optional[str] = None,
snippet: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetQosProfileResult
def get_qos_profile_output(device: Optional[pulumi.Input[str]] = None,
folder: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
snippet: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetQosProfileResult]func LookupQosProfile(ctx *Context, args *LookupQosProfileArgs, opts ...InvokeOption) (*LookupQosProfileResult, error)
func LookupQosProfileOutput(ctx *Context, args *LookupQosProfileOutputArgs, opts ...InvokeOption) LookupQosProfileResultOutput> Note: This function is named LookupQosProfile in the Go SDK.
public static class GetQosProfile
{
public static Task<GetQosProfileResult> InvokeAsync(GetQosProfileArgs args, InvokeOptions? opts = null)
public static Output<GetQosProfileResult> Invoke(GetQosProfileInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetQosProfileResult> getQosProfile(GetQosProfileArgs args, InvokeOptions options)
public static Output<GetQosProfileResult> getQosProfile(GetQosProfileArgs args, InvokeOptions options)
fn::invoke:
function: scm:index/getQosProfile:getQosProfile
arguments:
# arguments dictionaryThe following arguments are supported:
getQosProfile Result
The following output properties are available:
- Aggregate
Bandwidth GetQos Profile Aggregate Bandwidth - Class
Bandwidth GetType Qos Profile Class Bandwidth Type - Device string
- The device in which the resource is defined
- Folder string
- Id string
- UUID of the resource
- Name string
- Snippet string
- Tfid string
- Aggregate
Bandwidth GetQos Profile Aggregate Bandwidth - Class
Bandwidth GetType Qos Profile Class Bandwidth Type - Device string
- The device in which the resource is defined
- Folder string
- Id string
- UUID of the resource
- Name string
- Snippet string
- Tfid string
- aggregate
Bandwidth GetQos Profile Aggregate Bandwidth - class
Bandwidth GetType Qos Profile Class Bandwidth Type - device String
- The device in which the resource is defined
- folder String
- id String
- UUID of the resource
- name String
- snippet String
- tfid String
- aggregate
Bandwidth GetQos Profile Aggregate Bandwidth - class
Bandwidth GetType Qos Profile Class Bandwidth Type - device string
- The device in which the resource is defined
- folder string
- id string
- UUID of the resource
- name string
- snippet string
- tfid string
- aggregate_
bandwidth GetQos Profile Aggregate Bandwidth - class_
bandwidth_ Gettype Qos Profile Class Bandwidth Type - device str
- The device in which the resource is defined
- folder str
- id str
- UUID of the resource
- name str
- snippet str
- tfid str
- aggregate
Bandwidth Property Map - class
Bandwidth Property MapType - device String
- The device in which the resource is defined
- folder String
- id String
- UUID of the resource
- name String
- snippet String
- tfid String
Supporting Types
GetQosProfileAggregateBandwidth
- 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
GetQosProfileClassBandwidthType
- Mbps
Get
Qos Profile Class Bandwidth Type Mbps - Mbps
- Percentage
Get
Qos Profile Class Bandwidth Type Percentage Percentage
ℹ️ Note: You must specify exactly one of
mbpsandpercentage.
- Mbps
Get
Qos Profile Class Bandwidth Type Mbps - Mbps
- Percentage
Get
Qos Profile Class Bandwidth Type Percentage Percentage
ℹ️ Note: You must specify exactly one of
mbpsandpercentage.
- mbps
Get
Qos Profile Class Bandwidth Type Mbps - Mbps
- percentage
Get
Qos Profile Class Bandwidth Type Percentage Percentage
ℹ️ Note: You must specify exactly one of
mbpsandpercentage.
- mbps
Get
Qos Profile Class Bandwidth Type Mbps - Mbps
- percentage
Get
Qos Profile Class Bandwidth Type Percentage Percentage
ℹ️ Note: You must specify exactly one of
mbpsandpercentage.
- mbps
Get
Qos Profile Class Bandwidth Type Mbps - Mbps
- percentage
Get
Qos Profile 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.
GetQosProfileClassBandwidthTypeMbps
- Classes
List<Get
Qos Profile Class Bandwidth Type Mbps Class> - QoS setting for traffic classes
- Classes
[]Get
Qos Profile Class Bandwidth Type Mbps Class - QoS setting for traffic classes
- classes
List<Get
Qos Profile Class Bandwidth Type Mbps Class> - QoS setting for traffic classes
- classes
Get
Qos Profile Class Bandwidth Type Mbps Class[] - QoS setting for traffic classes
- classes
Sequence[Get
Qos Profile Class Bandwidth Type Mbps Class] - QoS setting for traffic classes
- classes List<Property Map>
- QoS setting for traffic classes
GetQosProfileClassBandwidthTypeMbpsClass
- Class
Bandwidth GetQos Profile Class Bandwidth Type Mbps Class Class Bandwidth - Class bandwidth
- Name string
- Traffic class
- Priority string
- traffic class priority
- Class
Bandwidth GetQos Profile Class Bandwidth Type Mbps Class Class Bandwidth - Class bandwidth
- Name string
- Traffic class
- Priority string
- traffic class priority
- class
Bandwidth GetQos Profile Class Bandwidth Type Mbps Class Class Bandwidth - Class bandwidth
- name String
- Traffic class
- priority String
- traffic class priority
- class
Bandwidth GetQos Profile Class Bandwidth Type Mbps Class Class Bandwidth - Class bandwidth
- name string
- Traffic class
- priority string
- traffic class priority
- class_
bandwidth GetQos Profile 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
GetQosProfileClassBandwidthTypeMbpsClassClassBandwidth
- 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
GetQosProfileClassBandwidthTypePercentage
- Classes
List<Get
Qos Profile Class Bandwidth Type Percentage Class> - QoS setting for traffic classes
- Classes
[]Get
Qos Profile Class Bandwidth Type Percentage Class - QoS setting for traffic classes
- classes
List<Get
Qos Profile Class Bandwidth Type Percentage Class> - QoS setting for traffic classes
- classes
Get
Qos Profile Class Bandwidth Type Percentage Class[] - QoS setting for traffic classes
- classes
Sequence[Get
Qos Profile Class Bandwidth Type Percentage Class] - QoS setting for traffic classes
- classes List<Property Map>
- QoS setting for traffic classes
GetQosProfileClassBandwidthTypePercentageClass
- Class
Bandwidth GetQos Profile Class Bandwidth Type Percentage Class Class Bandwidth - Class bandwidth
- Name string
- Traffic class
- Priority string
- traffic class priority
- Class
Bandwidth GetQos Profile Class Bandwidth Type Percentage Class Class Bandwidth - Class bandwidth
- Name string
- Traffic class
- Priority string
- traffic class priority
- class
Bandwidth GetQos Profile Class Bandwidth Type Percentage Class Class Bandwidth - Class bandwidth
- name String
- Traffic class
- priority String
- traffic class priority
- class
Bandwidth GetQos Profile Class Bandwidth Type Percentage Class Class Bandwidth - Class bandwidth
- name string
- Traffic class
- priority string
- traffic class priority
- class_
bandwidth GetQos Profile 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
GetQosProfileClassBandwidthTypePercentageClassClassBandwidth
- 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.
