1. Packages
  2. Azure Native
  3. API Docs
  4. databoxedge
  5. BandwidthSchedule
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

azure-native.databoxedge.BandwidthSchedule

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi

    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

    The BandwidthSchedule resource accepts the following input properties:

    Days List<Union<string, Pulumi.AzureNative.DataBoxEdge.DayOfWeek>>
    The days of the week when this schedule is applicable.
    DeviceName string
    The device name.
    RateInMbps int
    The bandwidth rate in Mbps.
    ResourceGroupName string
    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.
    DeviceName string
    The device name.
    RateInMbps int
    The bandwidth rate in Mbps.
    ResourceGroupName string
    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,DayOfWeek>>
    The days of the week when this schedule is applicable.
    deviceName String
    The device name.
    rateInMbps Integer
    The bandwidth rate in Mbps.
    resourceGroupName String
    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 | DayOfWeek)[]
    The days of the week when this schedule is applicable.
    deviceName string
    The device name.
    rateInMbps number
    The bandwidth rate in Mbps.
    resourceGroupName string
    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, DayOfWeek]]
    The days of the week when this schedule is applicable.
    device_name str
    The device name.
    rate_in_mbps int
    The bandwidth rate in Mbps.
    resource_group_name str
    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.
    deviceName String
    The device name.
    rateInMbps Number
    The bandwidth rate in Mbps.
    resourceGroupName String
    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.
    SystemData Pulumi.AzureNative.DataBoxEdge.Outputs.SystemDataResponse
    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.
    SystemData SystemDataResponse
    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.
    systemData SystemDataResponse
    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.
    systemData SystemDataResponse
    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 SystemDataResponse
    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.
    systemData 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
    DayOfWeekSunday
    Sunday
    DayOfWeekMonday
    Monday
    DayOfWeekTuesday
    Tuesday
    DayOfWeekWednesday
    Wednesday
    DayOfWeekThursday
    Thursday
    DayOfWeekFriday
    Friday
    DayOfWeekSaturday
    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

    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    CreatedAt string
    The timestamp of resource creation (UTC).
    CreatedBy string
    The identity that created the resource.
    CreatedByType string
    The type of identity that created the resource.
    LastModifiedAt string
    The timestamp of resource last modification (UTC)
    LastModifiedBy string
    The identity that last modified the resource.
    LastModifiedByType string
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    The type of identity that last modified the resource.
    createdAt string
    The timestamp of resource creation (UTC).
    createdBy string
    The identity that created the resource.
    createdByType string
    The type of identity that created the resource.
    lastModifiedAt string
    The timestamp of resource last modification (UTC)
    lastModifiedBy string
    The identity that last modified the resource.
    lastModifiedByType string
    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_type str
    The type of identity that created the resource.
    last_modified_at str
    The timestamp of resource last modification (UTC)
    last_modified_by str
    The identity that last modified the resource.
    last_modified_by_type str
    The type of identity that last modified the resource.
    createdAt String
    The timestamp of resource creation (UTC).
    createdBy String
    The identity that created the resource.
    createdByType String
    The type of identity that created the resource.
    lastModifiedAt String
    The timestamp of resource last modification (UTC)
    lastModifiedBy String
    The identity that last modified the resource.
    lastModifiedByType String
    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
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.50.1 published on Tuesday, Jul 16, 2024 by Pulumi