order_items

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

Overview

Name	order_items
Type	Resource
Id	azure_extras.edgeorder.order_items

Fields

The following fields are returned by SELECT queries:

get_order_item_by_name

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
addressDetails	object	Represents shipping and return address for order item. Required.
location	string	The geo-location where the resource lives. Required.
orderId	string	Id of the order to which order item belongs to. Required.
orderItemDetails	object	Represents order item details. Required.
startTime	string (date-time)	Start time of order item.
systemData	object	Represents resource creation and update time.
tags	object	Resource tags.
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_order_item_by_name	select	order_item_name, resource_group_name, subscription_id	$expand	Gets an order item.
create_order_item	insert	order_item_name, resource_group_name, subscription_id, location, properties		Creates an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item API.
update_order_item	update	order_item_name, resource_group_name, subscription_id	If-Match	Updates the properties of an existing order item.
delete_order_item_by_name	exec	order_item_name, resource_group_name, subscription_id		Deletes an order item.

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
order_item_name	string	The name of the order item. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$expand	string	$expand is supported on device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Device Details for order item provides details on the devices of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively. Default value is None.
If-Match	string	Defines the If-Match condition. The patch will be performed only if the ETag of the order on the server matches this value. Default value is None.

SELECT examples

get_order_item_by_name

Gets an order item.

SELECT
id,
name,
addressDetails,
location,
orderId,
orderItemDetails,
startTime,
systemData,
tags,
type
FROM azure_extras.edgeorder.order_items
WHERE order_item_name = '{{ order_item_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $expand = '{{ $expand }}'
;

INSERT examples

create_order_item

Creates an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item API.

INSERT INTO azure_extras.edgeorder.order_items (
tags,
location,
properties,
order_item_name,
resource_group_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ order_item_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: order_items
props:
  - name: order_item_name
    value: "{{ order_item_name }}"
    description: Required parameter for the order_items resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the order_items resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the order_items resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    value:
      orderItemDetails:
        productDetails:
          displayInfo:
            productFamilyDisplayName: "{{ productFamilyDisplayName }}"
            configurationDisplayName: "{{ configurationDisplayName }}"
          hierarchyInformation:
            productFamilyName: "{{ productFamilyName }}"
            productLineName: "{{ productLineName }}"
            productName: "{{ productName }}"
            configurationName: "{{ configurationName }}"
          count: {{ count }}
          productDoubleEncryptionStatus: "{{ productDoubleEncryptionStatus }}"
          deviceDetails:
            - serialNumber: "{{ serialNumber }}"
              managementResourceId: "{{ managementResourceId }}"
              managementResourceTenantId: "{{ managementResourceTenantId }}"
        orderItemType: "{{ orderItemType }}"
        currentStage:
          stageStatus: "{{ stageStatus }}"
          stageName: "{{ stageName }}"
          displayName: "{{ displayName }}"
          startTime: "{{ startTime }}"
        orderItemStageHistory:
          - stageStatus: "{{ stageStatus }}"
            stageName: "{{ stageName }}"
            displayName: "{{ displayName }}"
            startTime: "{{ startTime }}"
        preferences:
          notificationPreferences:
            - stageName: "{{ stageName }}"
              sendNotification: {{ sendNotification }}
          transportPreferences:
            preferredShipmentType: "{{ preferredShipmentType }}"
          encryptionPreferences:
            doubleEncryptionStatus: "{{ doubleEncryptionStatus }}"
          managementResourcePreferences:
            preferredManagementResourceId: "{{ preferredManagementResourceId }}"
        forwardShippingDetails:
          carrierName: "{{ carrierName }}"
          carrierDisplayName: "{{ carrierDisplayName }}"
          trackingId: "{{ trackingId }}"
          trackingUrl: "{{ trackingUrl }}"
        reverseShippingDetails:
          sasKeyForLabel: "{{ sasKeyForLabel }}"
          carrierName: "{{ carrierName }}"
          carrierDisplayName: "{{ carrierDisplayName }}"
          trackingId: "{{ trackingId }}"
          trackingUrl: "{{ trackingUrl }}"
        notificationEmailList:
          - "{{ notificationEmailList }}"
        cancellationReason: "{{ cancellationReason }}"
        cancellationStatus: "{{ cancellationStatus }}"
        deletionStatus: "{{ deletionStatus }}"
        returnReason: "{{ returnReason }}"
        returnStatus: "{{ returnStatus }}"
        managementRpDetails:
          resourceProviderNamespace: "{{ resourceProviderNamespace }}"
        managementRpDetailsList:
          - resourceProviderNamespace: "{{ resourceProviderNamespace }}"
        error:
          code: "{{ code }}"
          message: "{{ message }}"
          target: "{{ target }}"
          details:
            - code: "{{ code }}"
              message: "{{ message }}"
              target: "{{ target }}"
              details: "{{ details }}"
              additionalInfo: "{{ additionalInfo }}"
          additionalInfo:
            - type: "{{ type }}"
              info: "{{ info }}"
      addressDetails:
        forwardAddress:
          shippingAddress:
            streetAddress1: "{{ streetAddress1 }}"
            streetAddress2: "{{ streetAddress2 }}"
            streetAddress3: "{{ streetAddress3 }}"
            city: "{{ city }}"
            stateOrProvince: "{{ stateOrProvince }}"
            country: "{{ country }}"
            postalCode: "{{ postalCode }}"
            zipExtendedCode: "{{ zipExtendedCode }}"
            companyName: "{{ companyName }}"
            addressType: "{{ addressType }}"
          contactDetails:
            contactName: "{{ contactName }}"
            phone: "{{ phone }}"
            phoneExtension: "{{ phoneExtension }}"
            mobile: "{{ mobile }}"
            emailList:
              - "{{ emailList }}"
          addressValidationStatus: "{{ addressValidationStatus }}"
        returnAddress:
          shippingAddress:
            streetAddress1: "{{ streetAddress1 }}"
            streetAddress2: "{{ streetAddress2 }}"
            streetAddress3: "{{ streetAddress3 }}"
            city: "{{ city }}"
            stateOrProvince: "{{ stateOrProvince }}"
            country: "{{ country }}"
            postalCode: "{{ postalCode }}"
            zipExtendedCode: "{{ zipExtendedCode }}"
            companyName: "{{ companyName }}"
            addressType: "{{ addressType }}"
          contactDetails:
            contactName: "{{ contactName }}"
            phone: "{{ phone }}"
            phoneExtension: "{{ phoneExtension }}"
            mobile: "{{ mobile }}"
            emailList:
              - "{{ emailList }}"
          addressValidationStatus: "{{ addressValidationStatus }}"
      orderId: "{{ orderId }}"

UPDATE examples

update_order_item

Updates the properties of an existing order item.

UPDATE azure_extras.edgeorder.order_items
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
order_item_name = '{{ order_item_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

Lifecycle Methods

delete_order_item_by_name

Deletes an order item.

EXEC azure_extras.edgeorder.order_items.delete_order_item_by_name 
@order_item_name='{{ order_item_name }}' --required, 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;