az databoxedge device
Manage device with databoxedge.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| 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 device create
Create a Data Box Edge/Data Box Gateway resource.
az databoxedge device create --device-name --name
--resource-group
[--description]
[--etag]
[--friendly-name]
[--location]
[--model-description]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--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
The device name.
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.
The Description of the Data Box Edge/Gateway device.
The etag for the devices.
The Data Box Edge/Gateway device name.
The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed. When not specified, the location of the resource group will be used.
The description of the Data Box Edge/Gateway device model.
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
SKU name.
| Property | Value |
|---|---|
| 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 |
The status of the Data Box Edge/Gateway device.
| Property | Value |
|---|---|
| Accepted values: | Disconnected, Maintenance, NeedsAttention, Offline, Online, PartiallyDisconnected, ReadyToSetup |
The list of tags that describe the device. These tags can be used to view and group this device (across resource groups). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
az databoxedge device delete
Delete the Data Box Edge/Data Box Gateway device.
az databoxedge device delete [--device-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The device name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Do not prompt for confirmation.
| Property | Value |
|---|---|
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az databoxedge device download-update
Downloads the updates on a Data Box Edge/Data Box Gateway device.
az databoxedge device download-update [--device-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The device name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az databoxedge device get-extended-information
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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The device name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az databoxedge device install-update
Installs the updates on the Data Box Edge/Data Box Gateway device.
az databoxedge device install-update [--device-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Install the updates on the Data Box Edge/Data Box Gateway device.
az databoxedge device install-update --device-name testedgedevice --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.
The device name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az databoxedge device list
List all the Data Box Edge/Data Box Gateway devices in a subscription.
az databoxedge device list [--expand]
[--max-items]
[--next-token]
[--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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Specify $expand=details to populate additional fields related to the resource or Specify $skipToken=token to populate the next page in the list.
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 |
Token to specify where to start paginating. This is the token value from a previously truncated response.
| Property | Value |
|---|---|
| Parameter group: | Pagination Arguments |
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.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
| Property | Value |
|---|---|
| Default value: | False |
az databoxedge device scan-for-update
Scans for updates on a Data Box Edge/Data Box Gateway device.
az databoxedge device scan-for-update [--device-name --name]
[--ids]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
Examples
Scan for updates on a Data Box Edge/Data Box Gateway device.
az databoxedge device scan-for-update --device-name testedgedevice --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.
The device name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Do not wait for the long-running operation to finish.
| Property | Value |
|---|---|
| Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az databoxedge device show
Get the properties of the Data Box Edge/Data Box Gateway device.
az databoxedge device show [--device-name --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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The device name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
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 --name]
[--ids]
[--resource-group]
[--subscription]
Examples
Get update summary of the device.
az databoxedge device show-update-summary --device-name testedgedevice --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.
The device name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az databoxedge device update
Update a Data Box Edge/Data Box Gateway resource.
az databoxedge device update [--device-name --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
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
The device name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
The tags attached to the Data Box Edge/Gateway resource. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |
az databoxedge device wait
Place the CLI in a waiting state until a condition is met.
az databoxedge device wait [--created]
[--custom]
[--deleted]
[--device-name --name]
[--exists]
[--ids]
[--interval]
[--resource-group]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Wait until created with 'provisioningState' at 'Succeeded'.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
Wait until deleted.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
The device name.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Wait until the resource exists.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
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 |
Polling interval in seconds.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | 30 |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
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 |
Maximum wait in seconds.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
| Property | Value |
|---|---|
| Parameter group: | Wait Condition Arguments |
| Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
| Property | Value |
|---|---|
| Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
| Property | Value |
|---|---|
| Default value: | False |
Output format.
| Property | Value |
|---|---|
| Default value: | json |
| Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
| Property | Value |
|---|---|
| Default value: | False |