az databoxedge

Manage device with databoxedge.

Commands

Name	Description	Type	Status
az databoxedge alert	Manage Alert.	Core	GA
az databoxedge alert list	List all the alerts for a Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge alert show	Get an alert by name.	Core	GA
az databoxedge bandwidth-schedule	Manage Bandwidth Schedule.	Core	GA
az databoxedge bandwidth-schedule create	Create a bandwidth schedule.	Core	GA
az databoxedge bandwidth-schedule delete	Delete the specified bandwidth schedule.	Core	GA
az databoxedge bandwidth-schedule list	List all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge bandwidth-schedule show	Get the properties of the specified bandwidth schedule.	Core	GA
az databoxedge bandwidth-schedule update	Update a bandwidth schedule.	Core	GA
az databoxedge bandwidth-schedule wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az databoxedge device	Manage device with databoxedge.	Core	GA
az databoxedge device create	Create a Data Box Edge/Data Box Gateway resource.	Core	GA
az databoxedge device delete	Delete the Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge device download-update	Downloads the updates on a Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge device get-extended-information	Gets additional information for the specified Azure Stack Edge/Data Box Gateway device.	Core	GA
az databoxedge device install-update	Installs the updates on the Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge device list	List all the Data Box Edge/Data Box Gateway devices in a subscription.	Core	GA
az databoxedge device scan-for-update	Scans for updates on a Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge device share	Manage device share.	Core	GA
az databoxedge device share create	Create share on the device.	Core	GA
az databoxedge device share delete	Delete the share on the Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge device share list	List all the shares in a Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge device share show	Show share.	Core	GA
az databoxedge device share update	Update share on the device.	Core	GA
az databoxedge device show	Get the properties of the Data Box Edge/Data Box Gateway device.	Core	GA
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	GA
az databoxedge device storage-account	Manage device storage account.	Core	GA
az databoxedge device storage-account-credential	Manage device storage account credential.	Core	GA
az databoxedge device storage-account-credential create	Create the storage account credential.	Core	GA
az databoxedge device storage-account-credential delete	Delete the storage account credential.	Core	GA
az databoxedge device storage-account-credential list	List all the storage account credentials in a Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge device storage-account-credential show	Get the properties of the specified storage account credential.	Core	GA
az databoxedge device storage-account-credential update	Update the storage account credential.	Core	GA
az databoxedge device storage-account container	Manage device storage account container.	Core	GA
az databoxedge device storage-account container create	Create container on the device.	Core	GA
az databoxedge device storage-account container delete	Delete the container on the Data Box Edge/Data Box Gateway device.	Core	GA
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	GA
az databoxedge device storage-account container show	Show container.	Core	GA
az databoxedge device storage-account container update	Update container on the device.	Core	GA
az databoxedge device storage-account create	Create storage account on the device.	Core	GA
az databoxedge device storage-account delete	Delete storage account on the Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge device storage-account list	List all the storage accounts in a Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge device storage-account show	Show storage account.	Core	GA
az databoxedge device storage-account update	Update storage account on the device.	Core	GA
az databoxedge device update	Update a Data Box Edge/Data Box Gateway resource.	Core	GA
az databoxedge device user	Manage device user.	Core	GA
az databoxedge device user create	Create user on a Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge device user delete	Delete the user on a databox edge/gateway device.	Core	GA
az databoxedge device user list	List all the users registered on a Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge device user show	Show user.	Core	GA
az databoxedge device user update	Update user on a Data Box Edge/Data Box Gateway device.	Core	GA
az databoxedge device wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az databoxedge list-node	List all the nodes currently configured under this Data Box Edge device.	Core	GA
az databoxedge list-sku	List all the available Skus and information related to them.	Core	GA
az databoxedge order	Manage order with databoxedge.	Core	GA
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 show-job	Get the details of a specified job on a Data Box Edge/Data Box Gateway device.	Core	GA

az databoxedge list-node

Edit

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

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

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

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

Edit

List all the available Skus and information related to them.

az databoxedge list-sku [--max-items]
                        [--next-token]

Examples

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

az databoxedge list-sku

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

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

Edit

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 --device-name testedgedevice --name 12345678-1234-1234-1234-123456789012 --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 device name.

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

--name -n

The job name.

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

Feedback

Was this page helpful?

Share via

az databoxedge

Commands

az databoxedge list-node

Examples

Required Parameters

Optional Parameters

az databoxedge list-sku

Examples

Optional Parameters

az databoxedge show-job

Examples

Optional Parameters

Feedback