az databoxedge order

Manage order with databoxedge.

Commands

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

az databoxedge order create

Edit

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, AwaitingDrop, AwaitingFulfillment, AwaitingPickup, AwaitingPreparation, AwaitingReturnShipment, AwaitingShipment, CollectedAtMicrosoft, Declined, Delivered, LostDevice, PickupCompleted, ReplacementRequested, ReturnInitiated, Shipped, ShippedBack, Untracked}
                            [--address-line2]
                            [--address-line3]
                            [--comments]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

Examples

Create an order.

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

Required Parameters

--address-line1

The address line1.

Property	Value
Parameter group:	ShippingAddress Arguments

--city

The city name.

Property	Value
Parameter group:	ShippingAddress Arguments

--company-name

The name of the company.

Property	Value
Parameter group:	ContactInformation Arguments

--contact-person

The contact person name.

Property	Value
Parameter group:	ContactInformation Arguments

--country

The country name.

Property	Value
Parameter group:	ShippingAddress Arguments

--device-name -d

The order details of a device.

--email-list

The email list. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	ContactInformation Arguments

--phone

The phone number.

Property	Value
Parameter group:	ContactInformation Arguments

--postal-code

The postal code.

Property	Value
Parameter group:	ShippingAddress Arguments

--resource-group -g

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

--state

The state name.

Property	Value
Parameter group:	ShippingAddress Arguments

--status

Status of the order as per the allowed status types.

Property	Value
Parameter group:	CurrentStatus Arguments
Accepted values:	Arriving, AwaitingDrop, AwaitingFulfillment, AwaitingPickup, AwaitingPreparation, AwaitingReturnShipment, AwaitingShipment, CollectedAtMicrosoft, Declined, Delivered, LostDevice, PickupCompleted, ReplacementRequested, ReturnInitiated, Shipped, ShippedBack, Untracked

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--address-line2

The address line2.

Property	Value
Parameter group:	ShippingAddress Arguments

--address-line3

The address line3.

Property	Value
Parameter group:	ShippingAddress Arguments

--comments

Comments related to this status change.

Property	Value
Parameter group:	CurrentStatus Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az databoxedge order delete

Edit

Delete the order related to the device.

az databoxedge order delete [--device-name]
                            [--ids]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--resource-group]
                            [--subscription]
                            [--yes]

Examples

Delete the order related to the device.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--device-name -d

The order details of a device.

Property	Value
Parameter group:	Resource Id Arguments

--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.

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az databoxedge order list

Edit

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

az databoxedge order list --device-name
                          --resource-group
                          [--max-items]
                          [--next-token]

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 order details of a device.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--max-items

Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token argument of a subsequent command.

Property	Value
Parameter group:	Pagination Arguments

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Property	Value
Parameter group:	Pagination Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--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.

Property	Value
Default value:	False

az databoxedge order show

Edit

Get a specific order by name.

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

Examples

Get a specific order by name.

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--device-name -d

The order details of a device.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az databoxedge order update

Edit

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 {0, 1, f, false, n, no, t, true, y, yes}]
                            [--ids]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--phone]
                            [--postal-code]
                            [--remove]
                            [--resource-group]
                            [--set]
                            [--state]
                            [--status {Arriving, AwaitingDrop, AwaitingFulfillment, AwaitingPickup, AwaitingPreparation, AwaitingReturnShipment, AwaitingShipment, CollectedAtMicrosoft, Declined, Delivered, LostDevice, PickupCompleted, ReplacementRequested, ReturnInitiated, Shipped, ShippedBack, Untracked}]
                            [--subscription]

Examples

Update an order

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--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>.

Property	Value
Parameter group:	Generic Update Arguments

--address-line1

The address line1.

Property	Value
Parameter group:	ShippingAddress Arguments

--address-line2

The address line2.

Property	Value
Parameter group:	ShippingAddress Arguments

--address-line3

The address line3.

Property	Value
Parameter group:	ShippingAddress Arguments

--city

The city name.

Property	Value
Parameter group:	ShippingAddress Arguments

--comments

Comments related to this status change.

Property	Value
Parameter group:	CurrentStatus Arguments

--company-name

The name of the company.

Property	Value
Parameter group:	ContactInformation Arguments

--contact-person

The contact person name.

Property	Value
Parameter group:	ContactInformation Arguments

--country

The country name.

Property	Value
Parameter group:	ShippingAddress Arguments

--device-name -d

The order details of a device.

Property	Value
Parameter group:	Resource Id Arguments

--email-list

The email list. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	ContactInformation Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--ids

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--phone

The phone number.

Property	Value
Parameter group:	ContactInformation Arguments

--postal-code

The postal code.

Property	Value
Parameter group:	ShippingAddress Arguments

--remove

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

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--state

The state name.

Property	Value
Parameter group:	ShippingAddress Arguments

--status

Status of the order as per the allowed status types.

Property	Value
Parameter group:	CurrentStatus Arguments
Accepted values:	Arriving, AwaitingDrop, AwaitingFulfillment, AwaitingPickup, AwaitingPreparation, AwaitingReturnShipment, AwaitingShipment, CollectedAtMicrosoft, Declined, Delivered, LostDevice, PickupCompleted, ReplacementRequested, ReturnInitiated, Shipped, ShippedBack, Untracked

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

az databoxedge order wait

Edit

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

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--device-name -d

The order details of a device.

Property	Value
Parameter group:	Resource Id Arguments

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

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

--verbose

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

Property	Value
Default value:	False

Feedback

Was this page helpful?

Share via

az databoxedge order

Commands

az databoxedge order create

Examples

Required Parameters

Optional Parameters

az databoxedge order delete

Examples

Optional Parameters

az databoxedge order list

Examples

Required Parameters

Optional Parameters

az databoxedge order show

Examples

Optional Parameters

az databoxedge order update

Examples

Optional Parameters

az databoxedge order wait

Optional Parameters

Feedback