az databoxedge order

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Manage order with databoxedge.

Commands

az databoxedge order create	Create an order.
az databoxedge order delete	Delete the order related to the device.
az databoxedge order list	List all the orders related to a Data Box Edge/Data Box Gateway device.
az databoxedge order show	Get a specific order by name.
az databoxedge order update	Update an order.
az databoxedge order wait	Place the CLI in a waiting state until a condition of the databoxedge order is met.

az databoxedge order create

Create an order.

az databoxedge order create --address-line1
                            --city
                            --company-name
                            --contact-person
                            --country
                            --device-name
                            --email-list
                            --phone
                            --postal-code
                            --resource-group
                            --state
                            --status {Arriving, AwaitingFulfilment, AwaitingPreparation, AwaitingReturnShipment, AwaitingShipment, CollectedAtMicrosoft, Declined, Delivered, LostDevice, ReplacementRequested, ReturnInitiated, Shipped, ShippedBack, Untracked}
                            [--address-line2]
                            [--address-line3]
                            [--comments]
                            [--no-wait]

Examples

Create an order.

az databoxedge order create --device-name "testedgedevice" --company-name "Microsoft" --contact-person "John Mcclane" --email-list "john@microsoft.com" --phone "(800) 426-9400" --address-line1 "Microsoft Corporation" --address-line2 "One Microsoft Way" --address-line3 "Redmond" --city "WA" --country "United States" --postal-code "98052" --state "WA" --status Untracked --resource-group "GroupForEdgeAutomation"

Required Parameters

--address-line1

The address line1.

--city

The city name.

--company-name

The name of the company.

--contact-person

The contact person name.

--country

The country name.

--device-name -d

The order details of a device.

--email-list

The email list.

--phone

The phone number.

--postal-code

The postal code.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--state

The state name.

--status

Status of the order as per the allowed status types.

accepted values: Arriving, AwaitingFulfilment, AwaitingPreparation, AwaitingReturnShipment, AwaitingShipment, CollectedAtMicrosoft, Declined, Delivered, LostDevice, ReplacementRequested, ReturnInitiated, Shipped, ShippedBack, Untracked

Optional Parameters

--address-line2

The address line2.

--address-line3

The address line3.

--comments

Comments related to this status change.

--no-wait

Do not wait for the long-running operation to finish.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databoxedge order delete

Delete the order related to the device.

az databoxedge order delete [--device-name]
                            [--ids]
                            [--no-wait]
                            [--resource-group]
                            [--yes]

Examples

Delete the order related to the device.

az databoxedge order delete --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation"

Optional Parameters

--device-name -d

The device name.

--ids

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.

--no-wait

Do not wait for the long-running operation to finish.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--yes -y

Do not prompt for confirmation.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databoxedge order list

List all the orders related to a Data Box Edge/Data Box Gateway device.

az databoxedge order list --device-name
                          --resource-group

Examples

List all the orders related to a Data Box Edge/Data Box Gateway device.

az databoxedge order list --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation"

Required Parameters

--device-name -d

The device name.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databoxedge order show

Get a specific order by name.

az databoxedge order show [--device-name]
                          [--ids]
                          [--resource-group]

Examples

Get a specific order by name.

az databoxedge order show --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation"

Optional Parameters

--device-name -d

The device name.

--ids

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.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databoxedge order update

Update an order.

az databoxedge order update [--add]
                            [--address-line1]
                            [--address-line2]
                            [--address-line3]
                            [--city]
                            [--comments]
                            [--company-name]
                            [--contact-person]
                            [--country]
                            [--device-name]
                            [--email-list]
                            [--force-string]
                            [--ids]
                            [--no-wait]
                            [--phone]
                            [--postal-code]
                            [--remove]
                            [--resource-group]
                            [--set]
                            [--state]
                            [--status {Arriving, AwaitingFulfilment, AwaitingPreparation, AwaitingReturnShipment, AwaitingShipment, CollectedAtMicrosoft, Declined, Delivered, LostDevice, ReplacementRequested, ReturnInitiated, Shipped, ShippedBack, Untracked}]

Examples

Update an order

az databoxedge order update --phone "(800) 426-9432"

Optional Parameters

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

--address-line1

The address line1.

--address-line2

The address line2.

--address-line3

The address line3.

--city

The city name.

--comments

Comments related to this status change.

--company-name

The name of the company.

--contact-person

The contact person name.

--country

The country name.

--device-name -d

The order details of a device.

--email-list

The email list.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

--ids

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.

--no-wait

Do not wait for the long-running operation to finish.

--phone

The phone number.

--postal-code

The postal code.

--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--state

The state name.

--status

Status of the order as per the allowed status types.

accepted values: Arriving, AwaitingFulfilment, AwaitingPreparation, AwaitingReturnShipment, AwaitingShipment, CollectedAtMicrosoft, Declined, Delivered, LostDevice, ReplacementRequested, ReturnInitiated, Shipped, ShippedBack, Untracked

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az databoxedge order wait

Place the CLI in a waiting state until a condition of the databoxedge order is met.

az databoxedge order wait [--created]
                          [--custom]
                          [--deleted]
                          [--device-name]
                          [--exists]
                          [--ids]
                          [--interval]
                          [--resource-group]
                          [--timeout]
                          [--updated]

Examples

Pause executing next line of CLI script until the databoxedge order is successfully created.

az databoxedge order wait --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" --created

Pause executing next line of CLI script until the databoxedge order is successfully updated.

az databoxedge order wait --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" --updated

Pause executing next line of CLI script until the databoxedge order is successfully deleted.

az databoxedge order wait --device-name "testedgedevice" --resource-group "GroupForEdgeAutomation" --deleted

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

--device-name -d

The device name.

--exists

Wait until the resource exists.

--ids

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.

--interval

Polling interval in seconds.

default value: 30

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.