az databoxedge
This command group is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus
Support data box edge device and management.
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 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 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 update |
Modify a Data Box Edge/Data Box Gateway resource. |
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
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
The device name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az databoxedge list-sku
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
Specify $filter='location eq ' to filter on location.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az databoxedge show-job
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
The device name.
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.
The job name.
Name of resource group. You can configure the default group using az configure --defaults group=<name>
.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for