orders

Creates, updates, deletes, gets or lists an orders resource.

Overview

Name	orders
Type	Resource
Id	azure.data_box_edge.orders

Fields

The following fields are returned by SELECT queries:

list_by_data_box_edge_device

Lists all the orders for the Data Box Edge Device

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
kind	string	It specify the order api version.
properties	object	The order properties.
systemData	object	Metadata pertaining to creation and last modification of Order
type	string	The hierarchical type of the object.

get

The order details of a device.

Name	Datatype	Description
id	string	The path ID that uniquely identifies the object.
name	string	The object name.
kind	string	It specify the order api version.
properties	object	The order properties.
systemData	object	Metadata pertaining to creation and last modification of Order
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
list_by_data_box_edge_device	select	deviceName, subscriptionId, resourceGroupName
get	select	deviceName, subscriptionId, resourceGroupName
create_or_update	insert	deviceName, subscriptionId, resourceGroupName
delete	delete	deviceName, subscriptionId, resourceGroupName

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.
resourceGroupName	string	The resource group name.
subscriptionId	string	The subscription ID.

SELECT examples

list_by_data_box_edge_device

Lists all the orders for the Data Box Edge Device

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

get

The order details of a device.

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

INSERT examples

create_or_update

No description available.

INSERT INTO azure.data_box_edge.orders (
data__properties,
deviceName,
subscriptionId,
resourceGroupName
)
SELECT 
'{{ properties }}',
'{{ deviceName }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}'
RETURNING
id,
name,
kind,
properties,
systemData,
type
;

Manifest

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

DELETE examples

delete

No description available.

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