order_items

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

Overview

Name	order_items
Type	Resource
Id	azure_extras.edge_order.order_items

Fields

The following fields are returned by SELECT queries:

get

Order item object.

Name	Datatype	Description
identity	object	Msi identity of the resource
location	string	The geo-location where the resource lives
properties	object	Order item properties.
tags	object	Resource tags.

list_by_resource_group

List of order items available under the resource group.

Name	Datatype	Description
identity	object	Msi identity of the resource
location	string	The geo-location where the resource lives
properties	object	Order item properties.
tags	object	Resource tags.

list_by_subscription

List of order items available under the subscription.

Name	Datatype	Description
identity	object	Msi identity of the resource
location	string	The geo-location where the resource lives
properties	object	Order item properties.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, orderItemName	$expand	Get an order item.
list_by_resource_group	select	subscriptionId, resourceGroupName	$filter, $expand, $skipToken, $top	List order items at resource group level.
list_by_subscription	select	subscriptionId	$filter, $expand, $skipToken, $top	List order items at subscription level.
create	insert	subscriptionId, resourceGroupName, orderItemName, data__properties		Create an order item. Existing order item cannot be updated with this api and should instead be updated with the Update order item API.
update	update	subscriptionId, resourceGroupName, orderItemName	If-Match	Update the properties of an existing order item.
delete	delete	subscriptionId, resourceGroupName, orderItemName		Delete an order item.
cancel	exec	subscriptionId, resourceGroupName, orderItemName, reason		Cancel order item.
return	exec	subscriptionId, resourceGroupName, orderItemName, returnReason		Return 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
orderItemName	string	The name of the order item.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$expand	string	$expand is supported on parent device details, device details, forward shipping details and reverse shipping details parameters. Each of these can be provided as a comma separated list. Parent Device Details for order item provides details on the devices of the product, Device Details for order item provides details on the devices of the child configurations of the product, Forward and Reverse Shipping details provide forward and reverse shipping details respectively.
$filter	string	$filter is supported to filter based on order id and order Item Type. Filter supports only equals operation.
$skipToken	string	$skipToken is supported on Get list of order items, which provides the next page in the list of order items.
$top	integer (int32)	$top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.
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.

SELECT examples

get

Get an order item.

SELECT
identity,
location,
properties,
tags
FROM azure_extras.edge_order.order_items
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND orderItemName = '{{ orderItemName }}' -- required
AND $expand = '{{ $expand }}'
;

list_by_resource_group

List order items at resource group level.

SELECT
identity,
location,
properties,
tags
FROM azure_extras.edge_order.order_items
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $filter = '{{ $filter }}'
AND $expand = '{{ $expand }}'
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
;

list_by_subscription

List order items at subscription level.

SELECT
identity,
location,
properties,
tags
FROM azure_extras.edge_order.order_items
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $expand = '{{ $expand }}'
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
;

INSERT examples

create

Create 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.edge_order.order_items (
data__tags,
data__location,
data__properties,
data__identity,
subscriptionId,
resourceGroupName,
orderItemName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}' /* required */,
'{{ identity }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ orderItemName }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: order_items
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the order_items resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the order_items resource.
    - name: orderItemName
      value: string
      description: Required parameter for the order_items resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Order item properties.
    - name: identity
      value: object
      description: |
        Msi identity of the resource

UPDATE examples

update

Update the properties of an existing order item.

UPDATE azure_extras.edge_order.order_items
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}',
data__identity = '{{ identity }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND orderItemName = '{{ orderItemName }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

Delete an order item.

DELETE FROM azure_extras.edge_order.order_items
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND orderItemName = '{{ orderItemName }}' --required
;

Lifecycle Methods

cancel

Cancel order item.

EXEC azure_extras.edge_order.order_items.cancel 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@orderItemName='{{ orderItemName }}' --required 
@@json=
'{
"reason": "{{ reason }}"
}'
;

return

Return order item.

EXEC azure_extras.edge_order.order_items.return 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@orderItemName='{{ orderItemName }}' --required 
@@json=
'{
"returnAddress": "{{ returnAddress }}", 
"returnReason": "{{ returnReason }}", 
"serviceTag": "{{ serviceTag }}", 
"shippingBoxRequired": {{ shippingBoxRequired }}
}'
;