Share via

az databoxedge device

  • Preview
  • Reference

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Manage device with databoxedge.

Commands

Name Description Type Status
az databoxedge device create

Create a Data Box Edge/Data Box Gateway resource.

 Core Preview
az databoxedge device delete

Delete the Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge device download-update

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

 Core Preview
az databoxedge device get-extended-information

Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.

 Core Preview
az databoxedge device install-update

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

 Core Preview
az databoxedge device list

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

 Core Preview
az databoxedge device scan-for-update

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

 Core Preview
az databoxedge device share

Manage device share.

 Core Preview
az databoxedge device share create

Create share on the device.

 Core Preview
az databoxedge device share delete

Delete the share on the Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge device share list

List all the shares in a Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge device share show

Show share.

 Core Preview
az databoxedge device share update

Update share on the device.

 Core Preview
az databoxedge device show

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

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

 Core Preview
az databoxedge device storage-account

Manage device storage account.

 Core Preview
az databoxedge device storage-account-credential

Manage device storage account credential.

 Core Preview
az databoxedge device storage-account-credential create

Create the storage account credential.

 Core Preview
az databoxedge device storage-account-credential delete

Delete the storage account credential.

 Core Preview
az databoxedge device storage-account-credential list

List all the storage account credentials in a Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge device storage-account-credential show

Get the properties of the specified storage account credential.

 Core Preview
az databoxedge device storage-account-credential update

Update the storage account credential.

 Core Preview
az databoxedge device storage-account container

Manage device storage account container.

 Core Preview
az databoxedge device storage-account container create

Create container on the device.

 Core Preview
az databoxedge device storage-account container delete

Delete the container on the Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge device storage-account container list

List all the containers of a storage account in a Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge device storage-account container show

Show container.

 Core Preview
az databoxedge device storage-account container update

Update container on the device.

 Core Preview
az databoxedge device storage-account create

Create storage account on the device.

 Core Preview
az databoxedge device storage-account delete

Delete storage account on the Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge device storage-account list

List all the storage accounts in a Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge device storage-account show

Show storage account.

 Core Preview
az databoxedge device storage-account update

Update storage account on the device.

 Core Preview
az databoxedge device update

Modify a Data Box Edge/Data Box Gateway resource.

 Core Preview
az databoxedge device user

Manage device user.

 Core Preview
az databoxedge device user create

Create user on a Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge device user delete

Delete the user on a databox edge/gateway device.

 Core Preview
az databoxedge device user list

List all the users registered on a Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge device user show

Show user.

 Core Preview
az databoxedge device user update

Update user on a Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge device wait

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

 Core Preview

az databoxedge device create

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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.

Default value: False
--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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Delete the Data Box Edge/Data Box Gateway device.

az databoxedge device delete [--device-name]
                             [--ids]
                             [--no-wait]
                             [--resource-group]
                             [--subscription]
                             [--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.

Default value: False
--resource-group -g

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

--subscription

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

--yes -y

Do not prompt for confirmation.

Default value: False
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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

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.

Default value: False
--resource-group -g

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

--subscription

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

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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 get-extended-information

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.

az databoxedge device get-extended-information [--device-name]
                                               [--ids]
                                               [--resource-group]
                                               [--subscription]

Examples

Get extended information

az databoxedge device get-extended information --device-name name -g rg

Optional Parameters

--device-name

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

--subscription

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

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

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.

Default value: False
--resource-group -g

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

--subscription

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

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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]
                                      [--subscription]

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.

Default value: False
--resource-group -g

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

--subscription

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

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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

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

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

--subscription

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

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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]
                                          [--subscription]

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

--subscription

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

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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Modify a Data Box Edge/Data Box Gateway resource.

az databoxedge device update [--device-name]
                             [--ids]
                             [--resource-group]
                             [--subscription]
                             [--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>.

--subscription

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

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

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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

Edit
Preview

Command group 'databoxedge' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

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]
                           [--subscription]
                           [--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'.

Default value: False
--custom

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

--deleted

Wait until deleted.

Default value: False
--device-name --name -n

The device name.

--exists

Wait until the resource exists.

Default value: False
--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>.

--subscription

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

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
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.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--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.