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

vw_bandwidth_schedules

Name	Datatype	Description
id	text	The path ID that uniquely identifies the object.
name	text	The object name.
days	text	field from the properties object
deviceName	text	field from the properties object
rate_in_mbps	text	field from the properties object
resourceGroupName	text	field from the properties object
start	text	field from the properties object
stop	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
type	text	The hierarchical type of the object.

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 the resource.
type	string	The hierarchical type of the object.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	deviceName, name, resourceGroupName, subscriptionId	Gets the properties of the specified bandwidth schedule.
list_by_data_box_edge_device	SELECT	deviceName, resourceGroupName, subscriptionId	Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.
create_or_update	INSERT	deviceName, name, resourceGroupName, subscriptionId, data__properties	Creates or updates a bandwidth schedule.
delete	DELETE	deviceName, name, resourceGroupName, subscriptionId	Deletes the specified bandwidth schedule.

SELECT examples

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

vw_bandwidth_schedules

SELECT
id,
name,
days,
deviceName,
rate_in_mbps,
resourceGroupName,
start,
stop,
subscriptionId,
system_data,
type
FROM azure.data_box_edge.vw_bandwidth_schedules
WHERE deviceName = '{{ deviceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

bandwidth_schedules

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

INSERT example

Use the following StackQL query and manifest file to create a new bandwidth_schedules resource.

All Properties

/*+ create */
INSERT INTO azure.data_box_edge.bandwidth_schedules (
deviceName,
name,
resourceGroupName,
subscriptionId,
data__properties,
properties
)
SELECT 
'{{ deviceName }}',
'{{ name }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: properties
      value:
        - name: start
          value: string
        - name: stop
          value: string
        - name: rateInMbps
          value: integer
        - name: days
          value:
            - string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

DELETE example

Deletes the specified bandwidth_schedules resource.

/*+ delete */
DELETE FROM azure.data_box_edge.bandwidth_schedules
WHERE deviceName = '{{ deviceName }}'
AND name = '{{ name }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';