az fileshare
Note
This reference is part of the fileshares extension for the Azure CLI (version 2.75.0 or higher). The extension will automatically install the first time you run an az fileshare command. Learn more about extensions.
Manage Azure File Shares.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az fileshare check-name-availability |
Implements local CheckNameAvailability operations. |
Extension | GA |
| az fileshare create |
Create a file share. |
Extension | GA |
| az fileshare delete |
Delete a FileShare. |
Extension | GA |
| az fileshare get-provisioning-recommendation |
Get file shares provisioning parameters recommendation. |
Extension | GA |
| az fileshare limits-show |
Get file share limits and provisioning constants. |
Extension | GA |
| az fileshare list |
List FileShare resources by subscription ID. |
Extension | GA |
| az fileshare private-endpoint-connection |
Manage private endpoint connections for file shares. |
Extension | GA |
| az fileshare private-endpoint-connection approve |
Approve a private endpoint connection for a file share. |
Extension | GA |
| az fileshare private-endpoint-connection delete |
Delete the specified private endpoint connection associated with the file share. |
Extension | GA |
| az fileshare private-endpoint-connection list |
List a PrivateEndpointConnection List. |
Extension | GA |
| az fileshare private-endpoint-connection reject |
Reject a private endpoint connection for a file share. |
Extension | GA |
| az fileshare private-endpoint-connection show |
Get the specified private endpoint connection associated with the file share. |
Extension | GA |
| az fileshare private-endpoint-connection update |
Update the state of specified private endpoint connection associated with the file share. |
Extension | GA |
| az fileshare private-endpoint-connection wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az fileshare private-link-resource |
Manage private link resources for file shares. |
Extension | GA |
| az fileshare private-link-resource list |
List the private link resources that need to be created for a file share. |
Extension | GA |
| az fileshare private-link-resource show |
Get the private link resources that need to be created for a file share. |
Extension | GA |
| az fileshare show |
Get a FileShare. |
Extension | GA |
| az fileshare snapshot |
Manage file share snapshots. |
Extension | GA |
| az fileshare snapshot create |
Create a FileShareSnapshot. |
Extension | GA |
| az fileshare snapshot delete |
Delete a FileShareSnapshot. |
Extension | GA |
| az fileshare snapshot list |
List FileShareSnapshot by FileShare. |
Extension | GA |
| az fileshare snapshot show |
Get a FileShareSnapshot. |
Extension | GA |
| az fileshare snapshot update |
Update a FileShareSnapshot. |
Extension | GA |
| az fileshare snapshot wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
| az fileshare update |
Update a FileShare. |
Extension | GA |
| az fileshare usage-show |
Get file share usage data. |
Extension | GA |
| az fileshare wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az fileshare check-name-availability
Implements local CheckNameAvailability operations.
az fileshare check-name-availability --name
[--acquire-policy-token]
[--change-reference]
[--ids]
[--location]
[--subscription]
Examples
Check name availability for a file share
az fileshare check-name-availability --location westus --name myfileshare
Required Parameters
The name of the resource for which availability needs to be checked.
| Property | Value |
|---|---|
| Parameter group: | Body Arguments |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy 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 |
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
| 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 fileshare create
Create a file share.
az fileshare create --name --resource-name
--resource-group
[--acquire-policy-token]
[--allowed-subnets]
[--change-reference]
[--location]
[--media-tier {SSD}]
[--mount-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--protocol {NFS}]
[--provisioned-io-per-sec --provisioned-iops]
[--provisioned-storage-GiB --provisioned-storage-gi-b --storage-gib]
[--provisioned-throughput-MiB --provisioned-throughput-mi-b-per-sec --throughput-mibps]
[--public-network-access {Disabled, Enabled}]
[--redundancy {Local, Zone}]
[--root-squash {AllSquash, NoRootSquash, RootSquash}]
[--tags]
Examples
Create a file share with NFS protocol
az fileshare create --name MyFileShare --resource-group MyRG --location eastus --provisioned-storage-GiB 1024 --provisioned-iops 3000 --provisioned-throughput-MiB 125 --protocol NFS --redundancy Local
Required Parameters
The resource name of the file share, as seen by the administrator through Azure Resource Manager.
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.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Space-separated list of subnet resource IDs that are allowed access. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The geo-location where the resource lives When not specified, the location of the resource group will be used.
| Property | Value |
|---|---|
| Parameter group: | Resource Arguments |
The storage media tier of the file share.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | SSD |
The name of the file share as seen by the end user when mounting the share, such as in a URI or UNC format in their operating system.
| Property | Value |
|---|---|
| Parameter group: | Properties 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 |
The file sharing protocol for this file share.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | NFS |
The provisioned IO / sec of the share.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The provisioned throughput / sec of the share.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Gets or sets allow or disallow public network access to azure managed file share.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Disabled, Enabled |
The chosen redundancy level of the file share.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Local, Zone |
Root squash defines how root users on clients are mapped to the NFS share.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | AllSquash, NoRootSquash, RootSquash |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Resource 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.
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 fileshare delete
Delete a FileShare.
az fileshare delete [--acquire-policy-token]
[--change-reference]
[--ids]
[--name --resource-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--resource-group]
[--subscription]
[--yes]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy 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 |
The resource name of the file share, as seen by the administrator through Azure Resource Manager.
| 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 fileshare get-provisioning-recommendation
Get file shares provisioning parameters recommendation.
az fileshare get-provisioning-recommendation --provisioned-storage-GiB --provisioned-storage-gi-b --storage-gib
[--acquire-policy-token]
[--change-reference]
[--ids]
[--location]
[--subscription]
Examples
Get provisioning recommendations for a file share
az fileshare get-provisioning-recommendation --location eastus --provisioned-storage-GiB 1024
Required Parameters
The desired provisioned storage size of the share in GiB. Will be use to calculate the values of remaining provisioning parameters.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy 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 |
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
| 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 fileshare limits-show
Get file share limits and provisioning constants.
az fileshare limits-show [--acquire-policy-token]
[--change-reference]
[--ids]
[--location]
[--subscription]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy 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 |
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
| 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 fileshare list
List FileShare resources by subscription ID.
az fileshare list [--max-items]
[--next-token]
[--resource-group]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 fileshare show
Get a FileShare.
az fileshare show [--ids]
[--name --resource-name]
[--resource-group]
[--subscription]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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 |
The resource name of the file share, as seen by the administrator through Azure Resource Manager.
| 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 fileshare update
Update a FileShare.
az fileshare update [--acquire-policy-token]
[--allowed-subnets]
[--change-reference]
[--ids]
[--name --resource-name]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--provisioned-io-per-sec --provisioned-iops]
[--provisioned-storage-GiB --provisioned-storage-gi-b --storage-gib]
[--provisioned-throughput-MiB --provisioned-throughput-mi-b-per-sec --throughput-mibps]
[--public-network-access {Disabled, Enabled}]
[--resource-group]
[--root-squash {AllSquash, NoRootSquash, RootSquash}]
[--subscription]
[--tags]
Examples
Update the provisioned storage of a file share
az fileshare update --name MyFileShare --resource-group MyRG --provisioned-storage-GiB 2048
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
Space-separated list of subnet resource IDs that are allowed access. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy 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 |
The resource name of the file share, as seen by the administrator through Azure Resource Manager.
| 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 |
The provisioned IO / sec of the share.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The provisioned storage size of the share in GiB (1 GiB is 1024^3 bytes or 1073741824 bytes). A component of the file share's bill is the provisioned storage, regardless of the amount of used storage.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
The provisioned throughput / sec of the share.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
Gets or sets allow or disallow public network access to azure managed file share.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | Disabled, Enabled |
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
| Property | Value |
|---|---|
| Parameter group: | Resource Id Arguments |
Root squash defines how root users on clients are mapped to the NFS share.
| Property | Value |
|---|---|
| Parameter group: | Properties Arguments |
| Accepted values: | AllSquash, NoRootSquash, RootSquash |
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 |
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
| Property | Value |
|---|---|
| Parameter group: | Properties 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 fileshare usage-show
Get file share usage data.
az fileshare usage-show [--acquire-policy-token]
[--change-reference]
[--ids]
[--location]
[--subscription]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy 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 |
Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.
| 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 fileshare wait
Place the CLI in a waiting state until a condition is met.
az fileshare wait [--acquire-policy-token]
[--change-reference]
[--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name --resource-name]
[--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.
Acquiring an Azure Policy token automatically for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
The related change reference ID for this resource operation.
| Property | Value |
|---|---|
| Parameter group: | Global Policy Arguments |
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 |
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 |
The resource name of the file share, as seen by the administrator through Azure Resource Manager.
| 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 |
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 |