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:

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.
contactInformation	object	The contact details. Required.
currentStatus	object	Represents a single status change.
deliveryTrackingInfo	array	Tracking information for the package delivered to the customer whether it has an original or a replacement device.
kind	string	It specify the order api version.
orderHistory	array	List of status changes in the order.
orderId	string	It specify the order resource id.
returnTrackingInfo	array	Tracking information for the package returned from the customer whether it has an original or a replacement device.
serialNumber	string	Serial number of the device.
shipmentType	string	ShipmentType of the order. Known values are: "NotApplicable", "ShippedToCustomer", and "SelfPickup". (NotApplicable, ShippedToCustomer, SelfPickup)
shippingAddress	object	The shipping address.
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, resource_group_name, subscription_id		Gets a specific order by name. Gets a specific order by name.
create_or_update	insert	device_name, resource_group_name, subscription_id		Creates or updates an order. Creates or updates an order.
create_or_update	replace	device_name, resource_group_name, subscription_id		Creates or updates an order. Creates or updates an order.
delete	delete	device_name, resource_group_name, subscription_id		Deletes the order related to the device. Deletes the order related to the device.
list_by_data_box_edge_device	exec	device_name, resource_group_name, subscription_id		Lists all the orders related to a Data Box Edge/Data Box Gateway device. Lists all the orders related to a Data Box Edge/Data Box Gateway device.
list_dc_access_code	exec	device_name, resource_group_name, subscription_id		Gets the DCAccess Code. Gets the DCAccess Code.

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.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets a specific order by name. Gets a specific order by name.

SELECT
id,
name,
contactInformation,
currentStatus,
deliveryTrackingInfo,
kind,
orderHistory,
orderId,
returnTrackingInfo,
serialNumber,
shipmentType,
shippingAddress,
systemData,
type
FROM azure.data_box_edge.orders
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 an order. Creates or updates an order.

INSERT INTO azure.data_box_edge.orders (
properties,
device_name,
resource_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ device_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
kind,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: orders
props:
  - name: device_name
    value: "{{ device_name }}"
    description: Required parameter for the orders resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the orders resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the orders resource.
  - name: properties
    description: |
      The order properties.
    value:
      orderId: "{{ orderId }}"
      contactInformation:
        contactPerson: "{{ contactPerson }}"
        companyName: "{{ companyName }}"
        phone: "{{ phone }}"
        emailList:
          - "{{ emailList }}"
      shippingAddress:
        addressLine1: "{{ addressLine1 }}"
        addressLine2: "{{ addressLine2 }}"
        addressLine3: "{{ addressLine3 }}"
        postalCode: "{{ postalCode }}"
        city: "{{ city }}"
        state: "{{ state }}"
        country: "{{ country }}"
      currentStatus:
        status: "{{ status }}"
        updateDateTime: "{{ updateDateTime }}"
        comments: "{{ comments }}"
        trackingInformation:
          serialNumber: "{{ serialNumber }}"
          carrierName: "{{ carrierName }}"
          trackingId: "{{ trackingId }}"
          trackingUrl: "{{ trackingUrl }}"
        additionalOrderDetails: "{{ additionalOrderDetails }}"
      orderHistory:
        - status: "{{ status }}"
          updateDateTime: "{{ updateDateTime }}"
          comments: "{{ comments }}"
          trackingInformation:
            serialNumber: "{{ serialNumber }}"
            carrierName: "{{ carrierName }}"
            trackingId: "{{ trackingId }}"
            trackingUrl: "{{ trackingUrl }}"
          additionalOrderDetails: "{{ additionalOrderDetails }}"
      serialNumber: "{{ serialNumber }}"
      deliveryTrackingInfo:
        - serialNumber: "{{ serialNumber }}"
          carrierName: "{{ carrierName }}"
          trackingId: "{{ trackingId }}"
          trackingUrl: "{{ trackingUrl }}"
      returnTrackingInfo:
        - serialNumber: "{{ serialNumber }}"
          carrierName: "{{ carrierName }}"
          trackingId: "{{ trackingId }}"
          trackingUrl: "{{ trackingUrl }}"
      shipmentType: "{{ shipmentType }}"

REPLACE examples

create_or_update

Creates or updates an order. Creates or updates an order.

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

DELETE examples

delete

Deletes the order related to the device. Deletes the order related to the device.

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

Lifecycle Methods

list_by_data_box_edge_device

Lists all the orders related to a Data Box Edge/Data Box Gateway device. Lists all the orders related to a Data Box Edge/Data Box Gateway device.

EXEC azure.data_box_edge.orders.list_by_data_box_edge_device 
@device_name='{{ device_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_dc_access_code

Gets the DCAccess Code. Gets the DCAccess Code.

EXEC azure.data_box_edge.orders.list_dc_access_code 
@device_name='{{ device_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;