az netappfiles cache

Manage Cache resources.

Manage Azure NetApp Files (ANF) Cache Resources.

Commands

Name	Description	Type	Status
az netappfiles cache create	Create the specified Cache within the Capacity Pool.	Core	GA
az netappfiles cache delete	Delete the specified cache.	Core	GA
az netappfiles cache list	List all Caches within the Capacity Pool.	Core	GA
az netappfiles cache list-peering-passphrase	This operation will list the cluster peering command, cluster peering passphrase and the vserver peering command.	Core	GA
az netappfiles cache pool-change	Moves Cache to another Capacity Pool.	Core	GA
az netappfiles cache reset-smb-password	Resets the SMB password for the cache.	Core	GA
az netappfiles cache show	Get the details of the specified Cache.	Core	GA
az netappfiles cache update	Update the specified Cache within the Capacity Pool.	Core	GA
az netappfiles cache wait	Place the CLI in a waiting state until a condition is met.	Core	GA

az netappfiles cache create

Create the specified Cache within the Capacity Pool.

az netappfiles cache create --account-name
                            --cache-name --name
                            --cache-subnet-id --cache-subnet-resource-id
                            --encryption-key-source {Microsoft.KeyVault, Microsoft.NetApp}
                            --file-path
                            --peer-addresses
                            --peer-cluster-name
                            --peer-volume-name
                            --peer-vserver-name
                            --peering-subnet-id --peering-subnet-resource-id
                            --pool-name
                            --resource-group
                            --size
                            [--acquire-policy-token]
                            [--change-reference]
                            [--cifs-change-notifications --cifs-change-notify {Disabled, Enabled}]
                            [--export-policy-rules --rules]
                            [--global-file-locking {Disabled, Enabled}]
                            [--kerberos {Disabled, Enabled}]
                            [--key-vault-private-endpoint-resource-id --kv-private-endpoint-id]
                            [--ldap {Disabled, Enabled}]
                            [--ldap-server-type {ActiveDirectory, OpenLDAP}]
                            [--location]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--protocol-types]
                            [--smb-access-based-enumeration --smb-access-enumeration {Disabled, Enabled}]
                            [--smb-encryption {Disabled, Enabled}]
                            [--smb-non-browsable {Disabled, Enabled}]
                            [--tags]
                            [--throughput-mibps]
                            [--write-back {Disabled, Enabled}]
                            [--zones]

Examples

Caches_CreateOrUpdate

az netappfiles cache create --resource-group myRG --account-name account1 --pool-name pool1 --cache-name cache1 --location eastus --file-path cache-west-us2-01 --size 107374182400 --ldap Enabled --ldap-server-type OpenLDAP --cache-subnet-resource-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/cacheVnet/subnets/cacheSubnet1 --peering-subnet-resource-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/icLifVnet/subnets/peeringSubnet1 --encryption-key-source Microsoft.NetApp --origin-cluster-information "{peer-cluster-name:cluster1,peer-addresses:[192.0.2.10,192.0.2.11],peer-vserver-name:vserver1,peer-volume-name:originvol1}"

Required Parameters

--account-name -a

The name of the NetApp account.

--cache-name --name -n

The name of the cache resource.

--cache-subnet-id --cache-subnet-resource-id

The Azure Resource URI for a delegated cache subnet that will be used to allocate data IPs.

Property	Value
Parameter group:	Properties Arguments

--encryption-key-source

Source of key used to encrypt data in the cache. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Microsoft.KeyVault, Microsoft.NetApp

--file-path

The file path of the Cache.

Property	Value
Parameter group:	Properties Arguments

--peer-addresses

ONTAP Intercluster LIF IP addresses. One IP address per cluster node is required Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	OriginClusterInformation Arguments

--peer-cluster-name

ONTAP cluster name of external cluster hosting the origin volume. Must match the exact cluster name.

Property	Value
Parameter group:	OriginClusterInformation Arguments

--peer-volume-name

External origin volume name associated to this cache.

Property	Value
Parameter group:	OriginClusterInformation Arguments

--peer-vserver-name

External Vserver (SVM) name name of the SVM hosting the origin volume.

Property	Value
Parameter group:	OriginClusterInformation Arguments

--peering-subnet-id --peering-subnet-resource-id

The Azure Resource URI for a delegated subnet that will be used for ANF Intercluster Interface IP addresses.

Property	Value
Parameter group:	Properties Arguments

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

--size

Maximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB.

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.

--acquire-policy-token

Acquiring an Azure Policy token automatically for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--change-reference

The related change reference ID for this resource operation.

Property	Value
Parameter group:	Global Policy Arguments

--cifs-change-notifications --cifs-change-notify

Flag indicating whether a CIFS change notification is enabled for the cache.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--export-policy-rules --rules

Export policy rule Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	ExportPolicy Arguments

--global-file-locking

Flag indicating whether the global file lock is enabled for the cache.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--kerberos

Describe if a cache is Kerberos enabled.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--key-vault-private-endpoint-resource-id --kv-private-endpoint-id

The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.

Property	Value
Parameter group:	Properties Arguments

--ldap

Specifies whether LDAP is enabled or not for flexcache volume.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--ldap-server-type

Specifies the type of LDAP server for flexcache volume.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	ActiveDirectory, OpenLDAP

--location -l

The geo-location where the resource lives When not specified, the location of the resource group will be used.

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

--protocol-types

Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--smb-access-based-enumeration --smb-access-enumeration

Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Property	Value
Parameter group:	SmbSettings Arguments
Accepted values:	Disabled, Enabled

--smb-encryption

Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache.

Property	Value
Parameter group:	SmbSettings Arguments
Accepted values:	Disabled, Enabled

--smb-non-browsable

Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Property	Value
Parameter group:	SmbSettings Arguments
Accepted values:	Disabled, Enabled

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body Arguments

--throughput-mibps

Maximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache.

Property	Value
Parameter group:	Properties Arguments

--write-back

Flag indicating whether writeback is enabled for the cache.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--zones

The availability zones. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body 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 cache delete

Delete the specified cache.

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

Examples

Caches_Delete

az netappfiles cache delete --resource-group myRG --account-name account1 --pool-name pool1 --cache-name cache1

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

--cache-name --name -n

The name of the cache resource.

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

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

List all Caches within the Capacity Pool.

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

Examples

Caches_List

az netappfiles cache list --resource-group myRG --account-name account1 --pool-name pool1

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

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 cache list-peering-passphrase

This operation will list the cluster peering command, cluster peering passphrase and the vserver peering command.

az netappfiles cache list-peering-passphrase [--account-name]
                                             [--acquire-policy-token]
                                             [--cache-name]
                                             [--change-reference]
                                             [--ids]
                                             [--pool-name]
                                             [--resource-group]
                                             [--subscription]

Examples

Caches_ListPeeringPassphrases

az netappfiles cache list-peering-passphrase --resource-group myRG --account-name account1 --pool-name pool1 --cache-name cache-1

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

--cache-name -c

The name of the cache resource.

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

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

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 cache pool-change

Moves Cache to another Capacity Pool.

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

Examples

Caches_PoolChange

az netappfiles cache pool-change --resource-group myRG --account-name account1 --pool-name pool1 --cache-name cache1 --new-pool-resource-id /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool2

Required Parameters

--new-pool-resource-id

Resource id of the pool to move volume to.

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.

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

--cache-name -c

The name of the cache resource.

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

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 cache reset-smb-password

Resets the SMB password for the cache.

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

Examples

Caches_ResetSmbPassword

az netappfiles cache reset-smb-password --resource-group myResourceGroup --account-name account1 --pool-name pool1 --cache-name cache1

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

--cache-name -c

The name of the cache resource.

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

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

Get the details of the specified Cache.

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

Examples

Caches_Get

az netappfiles cache show --resource-group myRG --account-name account1 --pool-name pool1 --cache-name cache1

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

--cache-name --name -n

The name of the cache resource.

Property	Value
Parameter group:	Resource Id Arguments

--ids

One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.

Property	Value
Parameter group:	Resource Id Arguments

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

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 cache update

Update the specified Cache within the Capacity Pool.

az netappfiles cache update [--account-name]
                            [--acquire-policy-token]
                            [--add]
                            [--cache-name --name]
                            [--change-reference]
                            [--cifs-change-notifications --cifs-change-notify {Disabled, Enabled}]
                            [--export-policy-rules --rules]
                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                            [--ids]
                            [--key-vault-private-endpoint-resource-id --kv-private-endpoint-id]
                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                            [--pool-name]
                            [--protocol-types]
                            [--remove]
                            [--resource-group]
                            [--set]
                            [--size]
                            [--smb-access-based-enumeration --smb-access-enumeration {Disabled, Enabled}]
                            [--smb-encryption {Disabled, Enabled}]
                            [--smb-non-browsable {Disabled, Enabled}]
                            [--subscription]
                            [--tags]
                            [--throughput-mibps]
                            [--write-back {Disabled, Enabled}]

Examples

Caches_CreateOrUpdate

az netappfiles cache update --resource-group myRG --account-name account1 --pool-name pool1 --cache-name cache1 --size 107374182400

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

--cache-name --name -n

The name of the cache resource.

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

--cifs-change-notifications --cifs-change-notify

Flag indicating whether a CIFS change notification is enabled for the cache.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

--export-policy-rules --rules

Export policy rule Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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

--key-vault-private-endpoint-resource-id --kv-private-endpoint-id

The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.

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

--protocol-types

Set of supported protocol types, which include NFSv3, NFSv4 and SMB protocol Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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

--size

Maximum storage quota allowed for a file system in bytes. Valid values are in the range 50GiB to 1PiB. Values expressed in bytes as multiples of 1GiB.

Property	Value
Parameter group:	Properties Arguments

--smb-access-based-enumeration --smb-access-enumeration

Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Property	Value
Parameter group:	SmbSettings Arguments
Accepted values:	Disabled, Enabled

--smb-encryption

Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol cache.

Property	Value
Parameter group:	SmbSettings Arguments
Accepted values:	Disabled, Enabled

--smb-non-browsable

Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.

Property	Value
Parameter group:	SmbSettings Arguments
Accepted values:	Disabled, Enabled

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

--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Body Arguments

--throughput-mibps

Maximum throughput in MiB/s that can be achieved by this cache volume and this will be accepted as input only for manual qosType cache.

Property	Value
Parameter group:	Properties Arguments

--write-back

Flag indicating whether writeback is enabled for the cache.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	Disabled, Enabled

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 cache wait

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

az netappfiles cache wait [--account-name]
                          [--acquire-policy-token]
                          [--cache-name --name]
                          [--change-reference]
                          [--created]
                          [--custom]
                          [--deleted]
                          [--exists]
                          [--ids]
                          [--interval]
                          [--pool-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.

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

--cache-name --name -n

The name of the cache resource.

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

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

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

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