az edgeorder order-item
Note
This reference is part of the edgeorder extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az edgeorder order-item command. Learn more about extensions.
Manage order item with edgeorder sub group order-item.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az edgeorder order-item cancel |
Cancel order item. |
Extension | GA |
| az edgeorder order-item 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. |
Extension | GA |
| az edgeorder order-item delete |
Delete an order item. |
Extension | GA |
| az edgeorder order-item list |
List order item at resource group level. And List order item at subscription level. |
Extension | GA |
| az edgeorder order-item return |
Return order item. |
Extension | GA |
| az edgeorder order-item show |
Get an order item. |
Extension | GA |
| az edgeorder order-item update |
Update the properties of an existing order item. |
Extension | GA |
| az edgeorder order-item wait |
Place the CLI in a waiting state until a condition of the order-item is met. |
Extension | GA |
az edgeorder order-item cancel
Cancel order item.
az edgeorder order-item cancel --reason
[--ids]
[--name]
[--resource-group]
[--subscription]Examples
CancelOrderItem
az edgeorder order-item cancel --reason "Order cancelled" --name "TestOrderItemName1" --resource-group "TestRG"Required Parameters
Reason for cancellation.
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the order item.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az edgeorder order-item 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.
az edgeorder order-item create --name
--order-item-resource
--resource-group
[--no-wait]Examples
CreateOrderItem
az edgeorder order-item create --name "TestOrderItemName01" --order-item-resource "{\"location\":\"eastus\",\"tags\":{\"carrot\":\"vegetable\",\"mango\":\"fruit\"},\"orderItemDetails\":{\"orderItemType\":\"Purchase\",\"preferences\":{\"transportPreferences\":{\"preferredShipmentType\":\"MicrosoftManaged\"}},\"productDetails\":{\"hierarchyInformation\":{\"configurationName\":\"edgep_base\",\"productFamilyName\":\"azurestackedge\",\"productLineName\":\"azurestackedge\",\"productName\":\"azurestackedgegpu\"}}},\"addressDetails\":{\"forwardAddress\":{\"contactDetails\":{\"contactName\":\"Petr Cech\",\"emailList\":[\"ssemmail@microsoft.com\",\"vishwamdir@microsoft.com\"],\"phone\":\"3213131190\",\"phoneExtension\":\"\"},\"shippingAddress\":{\"addressType\":\"None\",\"city\":\"San Francisco\",\"companyName\":\"Microsoft\",\"country\":\"US\",\"postalCode\":\"94107\",\"stateOrProvince\":\"CA\",\"streetAddress1\":\"16 TOWNSEND ST\",\"streetAddress2\":\"UNIT 1\"}}},\"orderId\":\"/subscriptions/fa68082f-8ff7-4a25-95c7-ce9da541242f/resourceGroups/TestRG/providers/Microsoft.EdgeOrder/locations/eastus/orders/TestOrderItemName01\"}" --resource-group "TestRG"Required Parameters
The name of the order item.
Order item details from request body. Expected value: json-string/json-file/@json-file.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Do not wait for the long-running operation to finish.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az edgeorder order-item delete
Delete an order item.
az edgeorder order-item delete [--ids]
[--name]
[--no-wait]
[--resource-group]
[--subscription]
[--yes]Examples
DeleteOrderItemByName
az edgeorder order-item delete --name "TestOrderItemName01" --resource-group "TestRG"Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the order item.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az edgeorder order-item list
List order item at resource group level. And List order item at subscription level.
az edgeorder order-item list [--expand]
[--filter]
[--resource-group]
[--skip-token]Examples
ListOrderItemsAtResourceGroupLevel
az edgeorder order-item list --resource-group "TestRG"ListOrderItemsAtSubscriptionLevel
az edgeorder order-item listOptional Parameters
$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.
$filter is supported to filter based on order id. Filter supports only equals operation.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
$skipToken is supported on Get list of order items, which provides the next page in the list of order items.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az edgeorder order-item return
Return order item.
az edgeorder order-item return --return-reason
[--contact-details]
[--ids]
[--name]
[--no-wait]
[--resource-group]
[--service-tag]
[--shipping-address]
[--shipping-box-required {false, true}]
[--subscription]Examples
ReturnOrderItem
az edgeorder order-item return --name "TestOrderName1" --resource-group "TestRG" --return-reason "Order returned"Required Parameters
Return Reason.
Optional Parameters
Contact details for the address.
Usage: --contact-details contact-name=XX phone=XX phone-extension=XX mobile=XX email-list=XX
contact-name: Required. Contact name of the person. phone: Required. Phone number of the contact person. phone-extension: Phone extension number of the contact person. mobile: Mobile number of the contact person. email-list: Required. List of Email-ids to be notified about job progress.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the order item.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Service tag (located on the bottom-right corner of the device).
Shipping details for the address.
Usage: --shipping-address street-address1=XX street-address2=XX street-address3=XX city=XX state-or-province=XX country=XX postal-code=XX zip-extended-code=XX company-name=XX address-type=XX
street-address1: Required. Street Address line 1. street-address2: Street Address line 2. street-address3: Street Address line 3. city: Name of the City. state-or-province: Name of the State or Province. country: Required. Name of the Country. postal-code: Postal code. zip-extended-code: Extended Zip Code. company-name: Name of the company. address-type: Type of address.
Shipping Box required.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az edgeorder order-item show
Get an order item.
az edgeorder order-item show [--expand]
[--ids]
[--name]
[--resource-group]
[--subscription]Examples
GetOrderItemByName
az edgeorder order-item show --name "TestOrderItemName01" --resource-group "TestRG"Optional Parameters
$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.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the order item.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az edgeorder order-item update
Update the properties of an existing order item.
az edgeorder order-item update [--contact-details]
[--encryption-preferences]
[--ids]
[--if-match]
[--mgmt-preferences]
[--name]
[--no-wait]
[--notif-email-list]
[--notif-preferences]
[--resource-group]
[--shipping-address]
[--subscription]
[--tags]
[--transport-preferences]Examples
UpdateOrderItem
az edgeorder order-item update --name "TestOrderItemName01" --contact-details contact-name="Updated contact name" email-list="testemail@microsoft.com" phone="2222200000" --transport-preferences preferred-shipment-type="CustomerManaged" --tags ant="insect" pigeon="bird" tiger="animal" --resource-group "TestRG"Optional Parameters
Contact details for the address.
Usage: --contact-details contact-name=XX phone=XX phone-extension=XX mobile=XX email-list=XX
contact-name: Required. Contact name of the person. phone: Required. Phone number of the contact person. phone-extension: Phone extension number of the contact person. mobile: Mobile number of the contact person. email-list: Required. List of Email-ids to be notified about job progress.
Preferences related to the Encryption.
Usage: --encryption-preferences double-encryption-status=XX
double-encryption-status: Double encryption status as entered by the customer. It is compulsory to give this parameter if the 'Deny' or 'Disabled' policy is configured.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
Defines the If-Match condition. The patch will be performed only if the ETag of the order on the server matches this value.
Preferences related to the Management resource.
Usage: --mgmt-preferences preferred-management-resource-id=XX
preferred-management-resource-id: Customer preferred Management resource ARM ID.
The name of the order item.
Do not wait for the long-running operation to finish.
Additional notification email list.
Notification preferences.
Usage: --notif-preferences stage-name=XX send-notification=XX
stage-name: Required. Name of the stage. send-notification: Required. Notification is required or not.
Multiple actions can be specified by using more than one --notification-preferences argument.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Shipping details for the address.
Usage: --shipping-address street-address1=XX street-address2=XX street-address3=XX city=XX state-or-province=XX country=XX postal-code=XX zip-extended-code=XX company-name=XX address-type=XX
street-address1: Required. Street Address line 1. street-address2: Street Address line 2. street-address3: Street Address line 3. city: Name of the City. state-or-province: Name of the State or Province. country: Required. Name of the Country. postal-code: Postal code. zip-extended-code: Extended Zip Code. company-name: Name of the company. address-type: Type of address.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.
Preferences related to the shipment logistics of the order.
Usage: --transport-preferences preferred-shipment-type=XX
preferred-shipment-type: Required. Indicates Shipment Logistics type that the customer preferred.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az edgeorder order-item wait
Place the CLI in a waiting state until a condition of the order-item is met.
az edgeorder order-item wait --order-item-name
--resource-group
[--created]
[--custom]
[--deleted]
[--exists]
[--expand]
[--interval]
[--timeout]
[--updated]Required Parameters
The name of the order item.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
$expand is supported on device details, forward shipping details and reverse shipping details parameters.
Polling interval in seconds.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for