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

The bandwidth schedule.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
properties	object	The properties of the bandwidth schedule.
systemData	object	Metadata pertaining to creation and last modification of BandwidthSchedule
type	string	The hierarchical type of the object.

list_by_data_box_edge_device

The collection of bandwidth schedules.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
properties	object	The properties of the bandwidth schedule.
systemData	object	Metadata pertaining to creation and last modification of BandwidthSchedule
type	string	The hierarchical type of the object.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	deviceName, name, subscriptionId, resourceGroupName		Gets the properties of the specified bandwidth schedule.
list_by_data_box_edge_device	select	deviceName, subscriptionId, resourceGroupName		Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.
create_or_update	insert	deviceName, name, subscriptionId, resourceGroupName, data__properties		Creates or updates a bandwidth schedule.
delete	delete	deviceName, name, subscriptionId, resourceGroupName		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
deviceName	string	The device name.
name	string	The bandwidth schedule name.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription ID.

SELECT examples

get

Gets the properties of the specified bandwidth schedule.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_box_edge.bandwidth_schedules
WHERE deviceName = '{{ deviceName }}' -- required
AND name = '{{ name }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_data_box_edge_device

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

SELECT
id,
name,
properties,
systemData,
type
FROM azure.data_box_edge.bandwidth_schedules
WHERE deviceName = '{{ deviceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a bandwidth schedule.

INSERT INTO azure.data_box_edge.bandwidth_schedules (
data__properties,
deviceName,
name,
subscriptionId,
resourceGroupName
)
SELECT 
'{{ properties }}' /* required */,
'{{ deviceName }}',
'{{ name }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: bandwidth_schedules
  props:
    - name: deviceName
      value: string
      description: Required parameter for the bandwidth_schedules resource.
    - name: name
      value: string
      description: Required parameter for the bandwidth_schedules resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the bandwidth_schedules resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the bandwidth_schedules resource.
    - name: properties
      value: object
      description: |
        The properties of the bandwidth schedule.

DELETE examples

delete

Deletes the specified bandwidth schedule.

DELETE FROM azure.data_box_edge.bandwidth_schedules
WHERE deviceName = '{{ deviceName }}' --required
AND name = '{{ name }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
;