az databoxedge device

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 device with databoxedge.

Commands

az databoxedge device create	Create a Data Box Edge/Data Box Gateway resource.
az databoxedge device delete	Delete the Data Box Edge/Data Box Gateway device.
az databoxedge device download-update	Download the updates on a Data Box Edge/Data Box Gateway device.
az databoxedge device install-update	Install the updates on the Data Box Edge/Data Box Gateway device.
az databoxedge device list	Get all the Data Box Edge/Data Box Gateway devices in a resource group or in a subscription.
az databoxedge device scan-for-update	Scan for updates on a Data Box Edge/Data Box Gateway device.
az databoxedge device show	Get the properties of the Data Box Edge/Data Box Gateway device.
az databoxedge device show-update-summary	Get information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.
az databoxedge device update	Modify a Data Box Edge/Data Box Gateway resource.
az databoxedge device wait	Place the CLI in a waiting state until a condition of the databoxedge device is met.

az databoxedge device create

Create a Data Box Edge/Data Box Gateway resource.

az databoxedge device create --device-name
                             --resource-group
                             [--description]
                             [--etag]
                             [--friendly-name]
                             [--location]
                             [--model-description]
                             [--no-wait]
                             [--sku {EP2_128_1T4_Mx1_W, EP2_256_2T4_W, EP2_64_1VPU_W, Edge, EdgeMR_Mini, EdgePR_Base, EdgePR_Base_UPS, EdgeP_Base, EdgeP_High, GPU, Gateway, Management, RCA_Large, RCA_Small, RDC, TCA_Large, TCA_Small, TDC, TEA_1Node, TEA_1Node_Heater, TEA_1Node_UPS, TEA_1Node_UPS_Heater, TEA_4Node_Heater, TEA_4Node_UPS_Heater, TMA}]
                             [--status {Disconnected, Maintenance, NeedsAttention, Offline, Online, PartiallyDisconnected, ReadyToSetup}]
                             [--tags]

Examples

Create a Data Box Edge resource.

az databoxedge device create --location "eastus" --sku "Edge" --name "testedgedevice" --resource-group "GroupForEdgeAutomation"

Required Parameters

--device-name --name -n

The device name.

--resource-group -g

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

Optional Parameters

--description

The Description of the Data Box Edge/Gateway device.

--etag

The etag for the devices.

--friendly-name

The Data Box Edge/Gateway device name.

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--model-description

The description of the Data Box Edge/Gateway device model.

--no-wait

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

--sku

The SKU type.

accepted values: EP2_128_1T4_Mx1_W, EP2_256_2T4_W, EP2_64_1VPU_W, Edge, EdgeMR_Mini, EdgePR_Base, EdgePR_Base_UPS, EdgeP_Base, EdgeP_High, GPU, Gateway, Management, RCA_Large, RCA_Small, RDC, TCA_Large, TCA_Small, TDC, TEA_1Node, TEA_1Node_Heater, TEA_1Node_UPS, TEA_1Node_UPS_Heater, TEA_4Node_Heater, TEA_4Node_UPS_Heater, TMA

--status

The status of the Data Box Edge/Gateway device.

accepted values: Disconnected, Maintenance, NeedsAttention, Offline, Online, PartiallyDisconnected, ReadyToSetup

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 device delete

Delete the Data Box Edge/Data Box Gateway device.

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

Examples

Delete the Data Box Edge/Data Box Gateway device.

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

Optional Parameters

--device-name --name -n

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 device download-update

Download the updates on a Data Box Edge/Data Box Gateway device.

az databoxedge device download-update [--device-name]
                                      [--ids]
                                      [--no-wait]
                                      [--resource-group]

Examples

Download the updates on a Data Box Edge/Data Box Gateway device.

az databoxedge device download-update --name "testedgedevice" --resource-group "GroupForEdgeAutomation"

Optional Parameters

--device-name --name -n

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

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 device install-update

Install the updates on the Data Box Edge/Data Box Gateway device.

az databoxedge device install-update [--device-name]
                                     [--ids]
                                     [--no-wait]
                                     [--resource-group]

Examples

Install the updates on the Data Box Edge/Data Box Gateway device.

az databoxedge device install-update --name "testedgedevice" --resource-group "GroupForEdgeAutomation"

Optional Parameters

--device-name --name -n

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

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 device list

Get all the Data Box Edge/Data Box Gateway devices in a resource group or in a subscription.

az databoxedge device list [--expand]
                           [--resource-group]

Examples

Get all the Data Box Edge/Data Box Gateway devices in a resource group.

az databoxedge device list --resource-group "GroupForEdgeAutomation"

Get all the Data Box Edge/Data Box Gateway devices in a subscription.

az databoxedge device list

Optional Parameters

--expand

Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.

--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 device scan-for-update

Scan for updates on a Data Box Edge/Data Box Gateway device.

az databoxedge device scan-for-update [--device-name]
                                      [--ids]
                                      [--no-wait]
                                      [--resource-group]

Examples

Scan for updates on a Data Box Edge/Data Box Gateway device.

az databoxedge device scan-for-update --name "testedgedevice" --resource-group "GroupForEdgeAutomation"

Optional Parameters

--device-name --name -n

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

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 device show

Get the properties of the Data Box Edge/Data Box Gateway device.

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

Examples

Get the properties of the Data Box Edge/Data Box Gateway device.

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

Optional Parameters

--device-name --name -n

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 device show-update-summary

Get information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.

az databoxedge device show-update-summary [--device-name]
                                          [--ids]
                                          [--resource-group]

Examples

Get update summary of the device.

az databoxedge device show-update-summary --name "testedgedevice" --resource-group "GroupForEdgeAutomation"

Optional Parameters

--device-name --name -n

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 device update

Modify a Data Box Edge/Data Box Gateway resource.

az databoxedge device update [--device-name]
                             [--ids]
                             [--resource-group]
                             [--tags]

Examples

Modify a Data Box Edge/Data Box Gateway resource.

az databoxedge device update --name "testedgedevice" --tags Key1="value1" Key2="value2" --resource-group "GroupForEdgeAutomation"

Optional Parameters

--device-name --name -n

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

--tags

Space-separated tags: key[=value] [key[=value] ...]. Use "" to clear existing tags.

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 device wait

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

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

Examples

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

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

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

az databoxedge device wait --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 --name -n

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.