Microsoft.DataBoxEdge dataBoxEdgeDevices/bandwidthSchedules

Bicep resource definition

The dataBoxEdgeDevices/bandwidthSchedules resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2023-12-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    days: [
      'string'
    ]
    rateInMbps: int
    start: 'string'
    stop: 'string'
  }
}

Property Values

Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules

Name Description Value
name The resource name string (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: dataBoxEdgeDevices
properties The properties of the bandwidth schedule. BandwidthScheduleProperties (required)

BandwidthScheduleProperties

Name Description Value
days The days of the week when this schedule is applicable. String array containing any of:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday' (required)
rateInMbps The bandwidth rate in Mbps. int (required)
start The start time of the schedule in UTC. string (required)
stop The stop time of the schedule in UTC. string (required)

ARM template resource definition

The dataBoxEdgeDevices/bandwidthSchedules resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules resource, add the following JSON to your template.

{
  "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules",
  "apiVersion": "2023-12-01",
  "name": "string",
  "properties": {
    "days": [ "string" ],
    "rateInMbps": "int",
    "start": "string",
    "stop": "string"
  }
}

Property Values

Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules

Name Description Value
apiVersion The api version '2023-12-01'
name The resource name string (required)
properties The properties of the bandwidth schedule. BandwidthScheduleProperties (required)
type The resource type 'Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules'

BandwidthScheduleProperties

Name Description Value
days The days of the week when this schedule is applicable. String array containing any of:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday' (required)
rateInMbps The bandwidth rate in Mbps. int (required)
start The start time of the schedule in UTC. string (required)
stop The stop time of the schedule in UTC. string (required)

Usage Examples

Terraform (AzAPI provider) resource definition

The dataBoxEdgeDevices/bandwidthSchedules resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2023-12-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      days = [
        "string"
      ]
      rateInMbps = int
      start = "string"
      stop = "string"
    }
  }
}

Property Values

Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules

Name Description Value
name The resource name string (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: dataBoxEdgeDevices
properties The properties of the bandwidth schedule. BandwidthScheduleProperties (required)
type The resource type "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules@2023-12-01"

BandwidthScheduleProperties

Name Description Value
days The days of the week when this schedule is applicable. String array containing any of:
'Friday'
'Monday'
'Saturday'
'Sunday'
'Thursday'
'Tuesday'
'Wednesday' (required)
rateInMbps The bandwidth rate in Mbps. int (required)
start The start time of the schedule in UTC. string (required)
stop The stop time of the schedule in UTC. string (required)
  • Last updated on