Share via

az databoxedge

  • Preview
  • Reference

This command group 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 alert

Manage alert with databoxedge.

 Core Preview
az databoxedge alert list

Get all the alerts for a Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge alert show

Get an alert by name.

 Core Preview
az databoxedge bandwidth-schedule

Manage bandwidth schedule with databoxedge.

 Core Preview
az databoxedge bandwidth-schedule create

Create a bandwidth schedule.

 Core Preview
az databoxedge bandwidth-schedule delete

Delete the specified bandwidth schedule.

 Core Preview
az databoxedge bandwidth-schedule list

Get all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.

 Core Preview
az databoxedge bandwidth-schedule show

Get the properties of the specified bandwidth schedule.

 Core Preview
az databoxedge bandwidth-schedule update

Update a bandwidth schedule.

 Core Preview
az databoxedge bandwidth-schedule wait

Place the CLI in a waiting state until a condition of the databoxedge bandwidth-schedule is met.

 Core Preview
az databoxedge device

Manage device with databoxedge.

 Core Preview
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 list-node

Get all the nodes currently configured under this Data Box Edge device.

 Core Preview
az databoxedge list-sku

List all the available Skus in the region and information related to them.

 Core Preview
az databoxedge order

Manage order with databoxedge.

 Core Preview
az databoxedge order create

Create an order.

 Core Preview
az databoxedge order delete

Delete the order related to the device.

 Core Preview
az databoxedge order list

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

 Core Preview
az databoxedge order show

Get a specific order by name.

 Core Preview
az databoxedge order update

Update an order.

 Core Preview
az databoxedge order wait

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

 Core Preview
az databoxedge show-job

Get the details of a specified job on a Data Box Edge/Data Box Gateway device.

 Core Preview

az databoxedge list-node

Edit
Preview

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

Get all the nodes currently configured under this Data Box Edge device.

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

Examples

Get all the nodes currently configured under this Data Box Edge device.

az databoxedge list-node --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.

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

Edit
Preview

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

List all the available Skus in the region and information related to them.

az databoxedge list-sku [--filter]

Examples

List all the available Skus in the region and information related to them.

az databoxedge list-sku

Optional Parameters

--filter

Specify $filter='location eq ' to filter on location.

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

Edit
Preview

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

Get the details of a specified job on a Data Box Edge/Data Box Gateway device.

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

Examples

Get the details of a specified job on a Data Box Edge/Data Box Gateway device.

az databoxedge show-job --name "159a00c7-8543-4343-9435-263ac87df3bb" --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.

--name -n

The job name.

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