orders

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

Overview

Name	orders
Type	Resource
Id	azure_extras.edge_order.orders

Fields

The following fields are returned by SELECT queries:

get

Order resource object.

Name	Datatype	Description
properties	object	Order properties.

list_by_resource_group

List of orders available under the resource group.

Name	Datatype	Description
properties	object	Order properties.

list_by_subscription

List of orders available under the subscription.

Name	Datatype	Description
properties	object	Order properties.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, location, orderName		Get an order.
list_by_resource_group	select	subscriptionId, resourceGroupName	$skipToken, $top	List orders at resource group level.
list_by_subscription	select	subscriptionId	$skipToken, $top	List orders at subscription level.

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
location	string	The name of the Azure region.
orderName	string	The name of the order.
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.
$skipToken	string	$skipToken is supported on Get list of orders, which provides the next page in the list of orders.
$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.

SELECT examples

get

Get an order.

SELECT
properties
FROM azure_extras.edge_order.orders
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND location = '{{ location }}' -- required
AND orderName = '{{ orderName }}' -- required
;

list_by_resource_group

List orders at resource group level.

SELECT
properties
FROM azure_extras.edge_order.orders
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
;

list_by_subscription

List orders at subscription level.

SELECT
properties
FROM azure_extras.edge_order.orders
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
;