az netappfiles volume bucket

Manage Bucket.

Manage Azure NetApp Files (ANF) Bucket Resources.

Commands

Name	Description	Type	Status
az netappfiles volume bucket create	Create a bucket for a volume. A bucket allows additional services, such as AI services, connect to the volume data contained in those buckets.	Core	GA
az netappfiles volume bucket delete	Delete a volume's bucket.	Core	GA
az netappfiles volume bucket generate-akv-credential	Generate the access key and secret key used for accessing the specified volume bucket and store in Azure Key Vault.	Core	GA
az netappfiles volume bucket generate-credential	Generate the access key and secret key used for accessing the specified volume bucket. Also return expiry date and time of key pair (in UTC).	Core	GA
az netappfiles volume bucket list	List all buckets belonging to a volume. Buckets allow additional services, such as AI services, connect to the volume data contained in those buckets.	Core	GA
az netappfiles volume bucket refresh-certificate	This operation will fetch the certificate from Azure Key Vault and install it on the bucket server.	Core	GA
az netappfiles volume bucket show	Get the details of the specified volume's bucket. A bucket allows additional services, such as AI services, connect to the volume data contained in those buckets.	Core	GA
az netappfiles volume bucket update	Update a bucket for a volume. A bucket allows additional services, such as AI services, connect to the volume data contained in those buckets.	Core	GA
az netappfiles volume bucket wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az netappfiles volume bucket create

Edit

Create a bucket for a volume. A bucket allows additional services, such as AI services, connect to the volume data contained in those buckets.

az netappfiles volume bucket create --account-name
                                    --bucket-name --name
                                    --pool-name
                                    --resource-group
                                    --volume-name
                                    [--acquire-policy-token]
                                    [--cert-conflict-action --on-certificate-conflict-action {Fail, Update}]
                                    [--cert-kv-uri --certificate-key-vault-uri]
                                    [--certificate-name]
                                    [--certificate-object]
                                    [--change-reference]
                                    [--credentials-key-vault-uri --creds-kv-uri]
                                    [--fqdn]
                                    [--group-id]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--path]
                                    [--permissions {ReadOnly, ReadWrite}]
                                    [--secret-name]
                                    [--user-id]
                                    [--username]

Examples

Buckets_CreateOrUpdate

az netappfiles volume bucket create --resource-group myRG --account-name account1 --pool-name pool1 --volume-name volume1 --bucket-name bucket1 --path /path --group-id 1000 --user-id 1001 --permissions ReadOnly --fqdn fullyqualified.domainname.com --certificate-object <REDACTED> --on-certificate-conflict-action Update

Required Parameters

--account-name -a

The name of the NetApp account.

--bucket-name --name -n

The name of the bucket.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--volume-name -v

The name of the volume.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cert-conflict-action --on-certificate-conflict-action

Action to take when there is a certificate conflict. Possible values include: 'Update', 'Fail'.

Property	Value
Parameter group:	Server Arguments
Accepted values:	Fail, Update

--cert-kv-uri --certificate-key-vault-uri

The base URI of the Azure Key Vault that is used when retrieving the bucket certificate.

Property	Value
Parameter group:	CertificateAkvDetails Arguments

--certificate-name

The name of the bucket server certificate stored in the Azure Key Vault.

Property	Value
Parameter group:	CertificateAkvDetails Arguments

--certificate-object

The base64-encoded contents of a PEM file, which includes both the bucket server's certificate and private key. It is generated by the end user and allows the user to access volume data in a read-only manner. Note: This is only used when Azure Key Vault is not configured. This property is mutually exclusive with the Azure Key Vault 'akv' properties. If value is blank it's asked from the tty.

Property	Value
Parameter group:	Server Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--credentials-key-vault-uri --creds-kv-uri

The base URI of the Azure Key Vault that is used when storing the bucket credentials.

Property	Value
Parameter group:	CredentialsAkvDetails Arguments

--fqdn

The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate.

Property	Value
Parameter group:	Server Arguments

--group-id

The NFS user's GID.

Property	Value
Parameter group:	NfsUser Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--path

The volume path mounted inside the bucket. The default is the root path '/' if no value is provided when the bucket is created.

Property	Value
Parameter group:	Properties Arguments
Default value:	/

--permissions

Access permissions for the bucket. Either ReadOnly or ReadWrite. The default is ReadOnly if no value is provided during bucket creation.

Property	Value
Parameter group:	Properties Arguments
Default value:	ReadOnly
Accepted values:	ReadOnly, ReadWrite

--secret-name

The name of the secret stored in Azure Key Vault. The associated key pair has the following structure: { "access_key_id": "<REDACTED>", "secret_access_key": "<REDACTED>" }.

Property	Value
Parameter group:	CredentialsAkvDetails Arguments

--user-id

The NFS user's UID.

Property	Value
Parameter group:	NfsUser Arguments

--username

The CIFS user's username.

Property	Value
Parameter group:	CifsUser 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 netappfiles volume bucket delete

Edit

Delete a volume's bucket.

az netappfiles volume bucket delete [--account-name]
                                    [--acquire-policy-token]
                                    [--bucket-name --name]
                                    [--change-reference]
                                    [--ids]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--pool-name]
                                    [--resource-group]
                                    [--subscription]
                                    [--volume-name]
                                    [--yes]

Examples

Buckets_Delete

az netappfiles volume bucket delete --resource-group myRG --account-name account1 --pool-name pool1 --volume-name volume1 --bucket-name bucket1

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--bucket-name --name -n

The name of the bucket.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy 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

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

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

--volume-name -v

The name of the volume.

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

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

az netappfiles volume bucket generate-akv-credential

Edit

Generate the access key and secret key used for accessing the specified volume bucket and store in Azure Key Vault.

az netappfiles volume bucket generate-akv-credential [--account-name]
                                                     [--acquire-policy-token]
                                                     [--bucket-name]
                                                     [--change-reference]
                                                     [--ids]
                                                     [--key-pair-expiry-days]
                                                     [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                     [--pool-name]
                                                     [--resource-group]
                                                     [--subscription]
                                                     [--volume-name]

Examples

Buckets_GenerateAkvCredentials

az netappfiles volume bucket generate-akv-credential --resource-group myRG --account-name account1 --pool-name pool1 --volume-name volume1 --bucket-name bucket1 --key-pair-expiry-days 3

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--bucket-name -b -n

The name of the bucket.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--key-pair-expiry-days

The number of days from now until the newly generated Access and Secret key pair will expire.

Property	Value
Parameter group:	Body Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

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

--volume-name -v

The name of the volume.

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

az netappfiles volume bucket generate-credential

Edit

Generate the access key and secret key used for accessing the specified volume bucket. Also return expiry date and time of key pair (in UTC).

az netappfiles volume bucket generate-credential [--account-name]
                                                 [--acquire-policy-token]
                                                 [--bucket-name]
                                                 [--change-reference]
                                                 [--ids]
                                                 [--key-pair-expiry-days]
                                                 [--pool-name]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--volume-name]

Examples

Buckets_GenerateCredentials

az netappfiles volume bucket generate-credential --resource-group myRG --account-name account1 --pool-name pool1 --volume-name volume1 --bucket-name bucket1 --key-pair-expiry-days 3

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--bucket-name -b -n

The name of the bucket.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--key-pair-expiry-days

The number of days from now until the newly generated Access and Secret key pair will expire.

Property	Value
Parameter group:	Body Arguments

--pool-name -p

The name of the capacity pool.

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

--volume-name -v

The name of the volume.

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

az netappfiles volume bucket list

Edit

List all buckets belonging to a volume. Buckets allow additional services, such as AI services, connect to the volume data contained in those buckets.

az netappfiles volume bucket list --account-name
                                  --pool-name
                                  --resource-group
                                  --volume-name
                                  [--max-items]
                                  [--next-token]

Examples

Buckets_List

az netappfiles volume bucket list --resource-group myRG --account-name account1 --pool-name pool1 --volume-name volume1

Required Parameters

--account-name -a

The name of the NetApp account.

--pool-name -p

The name of the capacity pool.

--resource-group -g

Name of resource group. You can configure the default group using az configure --defaults group=<name>.

--volume-name -v

The name of the volume.

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 netappfiles volume bucket refresh-certificate

Edit

This operation will fetch the certificate from Azure Key Vault and install it on the bucket server.

az netappfiles volume bucket refresh-certificate [--account-name]
                                                 [--acquire-policy-token]
                                                 [--bucket-name]
                                                 [--change-reference]
                                                 [--ids]
                                                 [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--pool-name]
                                                 [--resource-group]
                                                 [--subscription]
                                                 [--volume-name]

Examples

Buckets_RefreshCertificate

az netappfiles volume bucket refresh-certificate --resource-group myRG --account-name account1 --pool-name pool1 --volume-name volume1 --bucket-name bucket1

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--bucket-name -b -n

The name of the bucket.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--pool-name -p

The name of the capacity pool.

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

--volume-name -v

The name of the volume.

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

az netappfiles volume bucket show

Edit

Get the details of the specified volume's bucket. A bucket allows additional services, such as AI services, connect to the volume data contained in those buckets.

az netappfiles volume bucket show [--account-name]
                                  [--bucket-name --name]
                                  [--ids]
                                  [--pool-name]
                                  [--resource-group]
                                  [--subscription]
                                  [--volume-name]

Examples

Buckets_Get

az netappfiles volume bucket show --resource-group myRG --account-name account1 --pool-name pool1 --volume-name volume1 --bucket-name bucket1

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--bucket-name --name -n

The name of the bucket.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--pool-name -p

The name of the capacity pool.

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

--volume-name -v

The name of the volume.

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

az netappfiles volume bucket update

Edit

Update a bucket for a volume. A bucket allows additional services, such as AI services, connect to the volume data contained in those buckets.

az netappfiles volume bucket update [--account-name]
                                    [--acquire-policy-token]
                                    [--add]
                                    [--bucket-name --name]
                                    [--cert-conflict-action --on-certificate-conflict-action {Fail, Update}]
                                    [--cert-kv-uri --certificate-key-vault-uri]
                                    [--certificate-name]
                                    [--certificate-object]
                                    [--change-reference]
                                    [--credentials-key-vault-uri --creds-kv-uri]
                                    [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--fqdn]
                                    [--group-id]
                                    [--ids]
                                    [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                    [--permissions {ReadOnly, ReadWrite}]
                                    [--pool-name]
                                    [--remove]
                                    [--resource-group]
                                    [--secret-name]
                                    [--set]
                                    [--subscription]
                                    [--user-id]
                                    [--username]
                                    [--volume-name]

Examples

Buckets_CreateOrUpdate

az netappfiles volume bucket update --resource-group myRG --account-name account1 --pool-name pool1 --volume-name volume1 --bucket-name bucket1 --group-id 1000 --user-id 1001 --permissions ReadOnly --fqdn fullyqualified.domainname.com --certificate-object <REDACTED> --on-certificate-conflict-action Update

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--add

Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>.

Property	Value
Parameter group:	Generic Update Arguments

--bucket-name --name -n

The name of the bucket.

Property	Value
Parameter group:	Resource Id Arguments

--cert-conflict-action --on-certificate-conflict-action

Action to take when there is a certificate conflict. Possible values include: 'Update', 'Fail'.

Property	Value
Parameter group:	Server Arguments
Accepted values:	Fail, Update

--cert-kv-uri --certificate-key-vault-uri

The base URI of the Azure Key Vault that is used when retrieving the bucket certificate.

Property	Value
Parameter group:	CertificateAkvDetails Arguments

--certificate-name

The name of the bucket server certificate stored in the Azure Key Vault.

Property	Value
Parameter group:	CertificateAkvDetails Arguments

--certificate-object

Property	Value
Parameter group:	Server Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--credentials-key-vault-uri --creds-kv-uri

The base URI of the Azure Key Vault that is used when storing the bucket credentials.

Property	Value
Parameter group:	CredentialsAkvDetails Arguments

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Property	Value
Parameter group:	Generic Update Arguments
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--fqdn

The host part of the bucket URL, resolving to the bucket IP address and allowed by the server certificate.

Property	Value
Parameter group:	Server Arguments

--group-id

The NFS user's GID.

Property	Value
Parameter group:	NfsUser Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

Do not wait for the long-running operation to finish.

Property	Value
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--permissions

Access permissions for the bucket. Either ReadOnly or ReadWrite. The default is ReadOnly if no value is provided during bucket creation.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	ReadOnly, ReadWrite

--pool-name -p

The name of the capacity pool.

Property	Value
Parameter group:	Resource Id Arguments

--remove

Remove a property or an element from a list. Example: --remove property.list <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update 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

--secret-name

The name of the secret stored in Azure Key Vault. The associated key pair has the following structure: { "access_key_id": "<REDACTED>", "secret_access_key": "<REDACTED>" }.

Property	Value
Parameter group:	CredentialsAkvDetails Arguments

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>.

Property	Value
Parameter group:	Generic Update 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

--user-id

The NFS user's UID.

Property	Value
Parameter group:	NfsUser Arguments

--username

The CIFS user's username.

Property	Value
Parameter group:	CifsUser Arguments

--volume-name -v

The name of the volume.

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

az netappfiles volume bucket wait

Edit

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

az netappfiles volume bucket wait [--account-name]
                                  [--acquire-policy-token]
                                  [--bucket-name --name]
                                  [--change-reference]
                                  [--created]
                                  [--custom]
                                  [--deleted]
                                  [--exists]
                                  [--ids]
                                  [--interval]
                                  [--pool-name]
                                  [--resource-group]
                                  [--subscription]
                                  [--timeout]
                                  [--updated]
                                  [--volume-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.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--bucket-name --name -n

The name of the bucket.

Property	Value
Parameter group:	Resource Id Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--pool-name -p

The name of the capacity pool.

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

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--volume-name -v

The name of the volume.

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?