bandwidth_schedules

Creates, updates, deletes, gets or lists a bandwidth_schedules resource.

Overview

Name	bandwidth_schedules
Type	Resource
Id	azure.data_box_edge.bandwidth_schedules

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
days	array	The days of the week when this schedule is applicable. Required.
rateInMbps	integer	The bandwidth rate in Mbps. Required.
start	string	The start time of the schedule in UTC. Required.
stop	string	The stop time of the schedule in UTC. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_data_box_edge_device

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
days	array	The days of the week when this schedule is applicable. Required.
rateInMbps	integer	The bandwidth rate in Mbps. Required.
start	string	The start time of the schedule in UTC. Required.
stop	string	The stop time of the schedule in UTC. Required.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	device_name, name, resource_group_name, subscription_id		Gets the properties of the specified bandwidth schedule.
list_by_data_box_edge_device	select	device_name, resource_group_name, subscription_id		Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.
create_or_update	insert	device_name, name, resource_group_name, subscription_id, properties		Creates or updates a bandwidth schedule.
create_or_update	replace	device_name, name, resource_group_name, subscription_id, properties		Creates or updates a bandwidth schedule.
delete	delete	device_name, name, resource_group_name, subscription_id		Deletes the specified bandwidth schedule.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
device_name	string	The device name. Required.
name	string	The bandwidth schedule name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the properties of the specified bandwidth schedule.

SELECT
id,
name,
days,
rateInMbps,
start,
stop,
systemData,
type
FROM azure.data_box_edge.bandwidth_schedules
WHERE device_name = '{{ device_name }}' -- required
AND name = '{{ name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_data_box_edge_device

Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.

SELECT
id,
name,
days,
rateInMbps,
start,
stop,
systemData,
type
FROM azure.data_box_edge.bandwidth_schedules
WHERE device_name = '{{ device_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a bandwidth schedule.

INSERT INTO azure.data_box_edge.bandwidth_schedules (
properties,
device_name,
name,
resource_group_name,
subscription_id
)
SELECT 
'{{ properties }}' /* required */,
'{{ device_name }}',
'{{ name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: bandwidth_schedules
props:
  - name: device_name
    value: "{{ device_name }}"
    description: Required parameter for the bandwidth_schedules resource.
  - name: name
    value: "{{ name }}"
    description: Required parameter for the bandwidth_schedules resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the bandwidth_schedules resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the bandwidth_schedules resource.
  - name: properties
    description: |
      The properties of the bandwidth schedule. Required.
    value:
      start: "{{ start }}"
      stop: "{{ stop }}"
      rateInMbps: {{ rateInMbps }}
      days:
        - "{{ days }}"

REPLACE examples

create_or_update

Creates or updates a bandwidth schedule.

REPLACE azure.data_box_edge.bandwidth_schedules
SET 
properties = '{{ properties }}'
WHERE 
device_name = '{{ device_name }}' --required
AND name = '{{ name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND properties = '{{ properties }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Deletes the specified bandwidth schedule.

DELETE FROM azure.data_box_edge.bandwidth_schedules
WHERE device_name = '{{ device_name }}' --required
AND name = '{{ name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;