azure-native.databoxedge.BandwidthSchedule
Explore with Pulumi AI
The bandwidth schedule details. Azure REST API version: 2022-03-01. Prior API version in Azure Native 1.x: 2020-12-01.
Other available API versions: 2023-01-01-preview, 2023-07-01, 2023-12-01.
Example Usage
BandwidthSchedulePut
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var bandwidthSchedule = new AzureNative.DataBoxEdge.BandwidthSchedule("bandwidthSchedule", new()
{
Days = new[]
{
AzureNative.DataBoxEdge.DayOfWeek.Sunday,
AzureNative.DataBoxEdge.DayOfWeek.Monday,
},
DeviceName = "testedgedevice",
Name = "bandwidth-1",
RateInMbps = 100,
ResourceGroupName = "GroupForEdgeAutomation",
Start = "0:0:0",
Stop = "13:59:0",
});
});
package main
import (
databoxedge "github.com/pulumi/pulumi-azure-native-sdk/databoxedge/v2"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := databoxedge.NewBandwidthSchedule(ctx, "bandwidthSchedule", &databoxedge.BandwidthScheduleArgs{
Days: pulumi.StringArray{
pulumi.String(databoxedge.DayOfWeekSunday),
pulumi.String(databoxedge.DayOfWeekMonday),
},
DeviceName: pulumi.String("testedgedevice"),
Name: pulumi.String("bandwidth-1"),
RateInMbps: pulumi.Int(100),
ResourceGroupName: pulumi.String("GroupForEdgeAutomation"),
Start: pulumi.String("0:0:0"),
Stop: pulumi.String("13:59:0"),
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.databoxedge.BandwidthSchedule;
import com.pulumi.azurenative.databoxedge.BandwidthScheduleArgs;
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) {
var bandwidthSchedule = new BandwidthSchedule("bandwidthSchedule", BandwidthScheduleArgs.builder()
.days(
"Sunday",
"Monday")
.deviceName("testedgedevice")
.name("bandwidth-1")
.rateInMbps(100)
.resourceGroupName("GroupForEdgeAutomation")
.start("0:0:0")
.stop("13:59:0")
.build());
}
}
import pulumi
import pulumi_azure_native as azure_native
bandwidth_schedule = azure_native.databoxedge.BandwidthSchedule("bandwidthSchedule",
days=[
azure_native.databoxedge.DayOfWeek.SUNDAY,
azure_native.databoxedge.DayOfWeek.MONDAY,
],
device_name="testedgedevice",
name="bandwidth-1",
rate_in_mbps=100,
resource_group_name="GroupForEdgeAutomation",
start="0:0:0",
stop="13:59:0")
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const bandwidthSchedule = new azure_native.databoxedge.BandwidthSchedule("bandwidthSchedule", {
days: [
azure_native.databoxedge.DayOfWeek.Sunday,
azure_native.databoxedge.DayOfWeek.Monday,
],
deviceName: "testedgedevice",
name: "bandwidth-1",
rateInMbps: 100,
resourceGroupName: "GroupForEdgeAutomation",
start: "0:0:0",
stop: "13:59:0",
});
resources:
bandwidthSchedule:
type: azure-native:databoxedge:BandwidthSchedule
properties:
days:
- Sunday
- Monday
deviceName: testedgedevice
name: bandwidth-1
rateInMbps: 100
resourceGroupName: GroupForEdgeAutomation
start: 0:0:0
stop: 13:59:0
Create BandwidthSchedule Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new BandwidthSchedule(name: string, args: BandwidthScheduleArgs, opts?: CustomResourceOptions);
@overload
def BandwidthSchedule(resource_name: str,
args: BandwidthScheduleArgs,
opts: Optional[ResourceOptions] = None)
@overload
def BandwidthSchedule(resource_name: str,
opts: Optional[ResourceOptions] = None,
days: Optional[Sequence[Union[str, DayOfWeek]]] = None,
device_name: Optional[str] = None,
rate_in_mbps: Optional[int] = None,
resource_group_name: Optional[str] = None,
start: Optional[str] = None,
stop: Optional[str] = None,
name: Optional[str] = None)
func NewBandwidthSchedule(ctx *Context, name string, args BandwidthScheduleArgs, opts ...ResourceOption) (*BandwidthSchedule, error)
public BandwidthSchedule(string name, BandwidthScheduleArgs args, CustomResourceOptions? opts = null)
public BandwidthSchedule(String name, BandwidthScheduleArgs args)
public BandwidthSchedule(String name, BandwidthScheduleArgs args, CustomResourceOptions options)
type: azure-native:databoxedge:BandwidthSchedule
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args BandwidthScheduleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args BandwidthScheduleArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args BandwidthScheduleArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args BandwidthScheduleArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args BandwidthScheduleArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var bandwidthScheduleResource = new AzureNative.DataBoxEdge.BandwidthSchedule("bandwidthScheduleResource", new()
{
Days = new[]
{
"string",
},
DeviceName = "string",
RateInMbps = 0,
ResourceGroupName = "string",
Start = "string",
Stop = "string",
Name = "string",
});
example, err := databoxedge.NewBandwidthSchedule(ctx, "bandwidthScheduleResource", &databoxedge.BandwidthScheduleArgs{
Days: pulumi.StringArray{
pulumi.String("string"),
},
DeviceName: pulumi.String("string"),
RateInMbps: pulumi.Int(0),
ResourceGroupName: pulumi.String("string"),
Start: pulumi.String("string"),
Stop: pulumi.String("string"),
Name: pulumi.String("string"),
})
var bandwidthScheduleResource = new BandwidthSchedule("bandwidthScheduleResource", BandwidthScheduleArgs.builder()
.days("string")
.deviceName("string")
.rateInMbps(0)
.resourceGroupName("string")
.start("string")
.stop("string")
.name("string")
.build());
bandwidth_schedule_resource = azure_native.databoxedge.BandwidthSchedule("bandwidthScheduleResource",
days=["string"],
device_name="string",
rate_in_mbps=0,
resource_group_name="string",
start="string",
stop="string",
name="string")
const bandwidthScheduleResource = new azure_native.databoxedge.BandwidthSchedule("bandwidthScheduleResource", {
days: ["string"],
deviceName: "string",
rateInMbps: 0,
resourceGroupName: "string",
start: "string",
stop: "string",
name: "string",
});
type: azure-native:databoxedge:BandwidthSchedule
properties:
days:
- string
deviceName: string
name: string
rateInMbps: 0
resourceGroupName: string
start: string
stop: string
BandwidthSchedule Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The BandwidthSchedule resource accepts the following input properties:
- Days
List<Union<string, Pulumi.
Azure Native. Data Box Edge. Day Of Week>> - The days of the week when this schedule is applicable.
- Device
Name string - The device name.
- Rate
In intMbps - The bandwidth rate in Mbps.
- Resource
Group stringName - The resource group name.
- Start string
- The start time of the schedule in UTC.
- Stop string
- The stop time of the schedule in UTC.
- Name string
- The bandwidth schedule name which needs to be added/updated.
- Days []string
- The days of the week when this schedule is applicable.
- Device
Name string - The device name.
- Rate
In intMbps - The bandwidth rate in Mbps.
- Resource
Group stringName - The resource group name.
- Start string
- The start time of the schedule in UTC.
- Stop string
- The stop time of the schedule in UTC.
- Name string
- The bandwidth schedule name which needs to be added/updated.
- days
List<Either<String,Day
Of Week>> - The days of the week when this schedule is applicable.
- device
Name String - The device name.
- rate
In IntegerMbps - The bandwidth rate in Mbps.
- resource
Group StringName - The resource group name.
- start String
- The start time of the schedule in UTC.
- stop String
- The stop time of the schedule in UTC.
- name String
- The bandwidth schedule name which needs to be added/updated.
- days
(string | Day
Of Week)[] - The days of the week when this schedule is applicable.
- device
Name string - The device name.
- rate
In numberMbps - The bandwidth rate in Mbps.
- resource
Group stringName - The resource group name.
- start string
- The start time of the schedule in UTC.
- stop string
- The stop time of the schedule in UTC.
- name string
- The bandwidth schedule name which needs to be added/updated.
- days
Sequence[Union[str, Day
Of Week]] - The days of the week when this schedule is applicable.
- device_
name str - The device name.
- rate_
in_ intmbps - The bandwidth rate in Mbps.
- resource_
group_ strname - The resource group name.
- start str
- The start time of the schedule in UTC.
- stop str
- The stop time of the schedule in UTC.
- name str
- The bandwidth schedule name which needs to be added/updated.
- days List<String | "Sunday" | "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday">
- The days of the week when this schedule is applicable.
- device
Name String - The device name.
- rate
In NumberMbps - The bandwidth rate in Mbps.
- resource
Group StringName - The resource group name.
- start String
- The start time of the schedule in UTC.
- stop String
- The stop time of the schedule in UTC.
- name String
- The bandwidth schedule name which needs to be added/updated.
Outputs
All input properties are implicitly available as output properties. Additionally, the BandwidthSchedule resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- System
Data Pulumi.Azure Native. Data Box Edge. Outputs. System Data Response - Metadata pertaining to creation and last modification of BandwidthSchedule
- Type string
- The hierarchical type of the object.
- Id string
- The provider-assigned unique ID for this managed resource.
- System
Data SystemData Response - Metadata pertaining to creation and last modification of BandwidthSchedule
- Type string
- The hierarchical type of the object.
- id String
- The provider-assigned unique ID for this managed resource.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of BandwidthSchedule
- type String
- The hierarchical type of the object.
- id string
- The provider-assigned unique ID for this managed resource.
- system
Data SystemData Response - Metadata pertaining to creation and last modification of BandwidthSchedule
- type string
- The hierarchical type of the object.
- id str
- The provider-assigned unique ID for this managed resource.
- system_
data SystemData Response - Metadata pertaining to creation and last modification of BandwidthSchedule
- type str
- The hierarchical type of the object.
- id String
- The provider-assigned unique ID for this managed resource.
- system
Data Property Map - Metadata pertaining to creation and last modification of BandwidthSchedule
- type String
- The hierarchical type of the object.
Supporting Types
DayOfWeek, DayOfWeekArgs
- Sunday
- Sunday
- Monday
- Monday
- Tuesday
- Tuesday
- Wednesday
- Wednesday
- Thursday
- Thursday
- Friday
- Friday
- Saturday
- Saturday
- Day
Of Week Sunday - Sunday
- Day
Of Week Monday - Monday
- Day
Of Week Tuesday - Tuesday
- Day
Of Week Wednesday - Wednesday
- Day
Of Week Thursday - Thursday
- Day
Of Week Friday - Friday
- Day
Of Week Saturday - Saturday
- Sunday
- Sunday
- Monday
- Monday
- Tuesday
- Tuesday
- Wednesday
- Wednesday
- Thursday
- Thursday
- Friday
- Friday
- Saturday
- Saturday
- Sunday
- Sunday
- Monday
- Monday
- Tuesday
- Tuesday
- Wednesday
- Wednesday
- Thursday
- Thursday
- Friday
- Friday
- Saturday
- Saturday
- SUNDAY
- Sunday
- MONDAY
- Monday
- TUESDAY
- Tuesday
- WEDNESDAY
- Wednesday
- THURSDAY
- Thursday
- FRIDAY
- Friday
- SATURDAY
- Saturday
- "Sunday"
- Sunday
- "Monday"
- Monday
- "Tuesday"
- Tuesday
- "Wednesday"
- Wednesday
- "Thursday"
- Thursday
- "Friday"
- Friday
- "Saturday"
- Saturday
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - The type of identity that last modified the resource.
- created_
at str - The timestamp of resource creation (UTC).
- created_
by str - The identity that created the resource.
- created_
by_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:databoxedge:BandwidthSchedule bandwidth-1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0