orders

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

Overview

Name	orders
Type	Resource
Id	azure.data_box_edge.orders

Fields

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	Order properties.
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, resourceGroupName, subscriptionId
list_by_data_box_edge_device	SELECT	deviceName, resourceGroupName, subscriptionId
create_or_update	INSERT	deviceName, resourceGroupName, subscriptionId
delete	DELETE	deviceName, resourceGroupName, subscriptionId

SELECT examples

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

INSERT example

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

All Properties

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

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: kind
      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
    - name: properties
      value:
        - name: orderId
          value: string
        - name: contactInformation
          value:
            - name: contactPerson
              value: string
            - name: companyName
              value: string
            - name: phone
              value: string
            - name: emailList
              value:
                - string
        - name: shippingAddress
          value:
            - name: addressLine1
              value: string
            - name: addressLine2
              value: string
            - name: addressLine3
              value: string
            - name: postalCode
              value: string
            - name: city
              value: string
            - name: state
              value: string
            - name: country
              value: string
        - name: currentStatus
          value:
            - name: status
              value: string
            - name: updateDateTime
              value: string
            - name: comments
              value: string
            - name: trackingInformation
              value:
                - name: serialNumber
                  value: string
                - name: carrierName
                  value: string
                - name: trackingId
                  value: string
                - name: trackingUrl
                  value: string
            - name: additionalOrderDetails
              value: object
        - name: orderHistory
          value:
            - - name: status
                value: string
              - name: updateDateTime
                value: string
              - name: comments
                value: string
              - name: additionalOrderDetails
                value: object
        - name: serialNumber
          value: string
        - name: deliveryTrackingInfo
          value:
            - - name: serialNumber
                value: string
              - name: carrierName
                value: string
              - name: trackingId
                value: string
              - name: trackingUrl
                value: string
        - name: returnTrackingInfo
          value:
            - - name: serialNumber
                value: string
              - name: carrierName
                value: string
              - name: trackingId
                value: string
              - name: trackingUrl
                value: string
        - name: shipmentType
          value: string

DELETE example

Deletes the specified orders resource.

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