az netappfiles

Reference

Note

This command group has commands that are defined in both Azure CLI and at least one extension. Install each extension to benefit from its extended capabilities. Learn more about extensions.

Manage Azure NetApp Files (ANF) Resources.

Commands

Name	Description	Type	Status
az netappfiles account	Manage Azure NetApp Files (ANF) Account Resources.	Core and Extension	GA
az netappfiles account ad	Manage Azure NetApp Files (ANF) Account active directories.	Core	GA
az netappfiles account ad add	Add an active directory to the account.	Core	GA
az netappfiles account ad list	List the active directories of an account.	Core	GA
az netappfiles account ad remove	Remove an active directory from the account.	Core	GA
az netappfiles account ad show	Get the specified ANF active directory.	Core	GA
az netappfiles account ad update	Updates an active directory to the account.	Core	GA
az netappfiles account ad wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az netappfiles account backup-policy	Manage Azure NetApp Files (ANF) Bakup Policy Resources.	Core	GA
az netappfiles account backup-policy create	Create a backup policy for Netapp Account.	Core	GA
az netappfiles account backup-policy delete	Delete backup policy.	Core	GA
az netappfiles account backup-policy list	List backup policies for Netapp Account.	Core	GA
az netappfiles account backup-policy show	Get a particular backup Policy.	Core	GA
az netappfiles account backup-policy update	Update a backup policy for Netapp Account.	Core	GA
az netappfiles account backup-policy wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az netappfiles account backup-vault	Manage Azure NetApp Files (ANF) BackupVault Resources.	Core and Extension	GA
az netappfiles account backup-vault backup	Manage Azure NetApp Files (ANF) Backup Resources.	Core and Extension	GA
az netappfiles account backup-vault backup create	Create a backup under the Backup Vault.	Core	GA
az netappfiles account backup-vault backup create (netappfiles-preview extension)	Create a backup under the Backup Vault.	Extension	Preview
az netappfiles account backup-vault backup delete	Delete a Backup under the Backup Vault.	Core	GA
az netappfiles account backup-vault backup delete (netappfiles-preview extension)	Delete a Backup under the Backup Vault.	Extension	Preview
az netappfiles account backup-vault backup list	List all backups Under a Backup Vault.	Core	GA
az netappfiles account backup-vault backup list (netappfiles-preview extension)	List all backups Under a Backup Vault.	Extension	Preview
az netappfiles account backup-vault backup restore-file	Restore the specified files from the specified backup to the active filesystem.	Core	GA
az netappfiles account backup-vault backup restore-file (netappfiles-preview extension)	Restore the specified files from the specified backup to the active filesystem.	Extension	Preview
az netappfiles account backup-vault backup show	Get the specified Backup under Backup Vault.	Core	GA
az netappfiles account backup-vault backup show (netappfiles-preview extension)	Get the specified Backup under Backup Vault.	Extension	Preview
az netappfiles account backup-vault backup update	Update a backup under the Backup Vault.	Core	GA
az netappfiles account backup-vault backup update (netappfiles-preview extension)	Update a backup under the Backup Vault.	Extension	Preview
az netappfiles account backup-vault backup wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az netappfiles account backup-vault backup wait (netappfiles-preview extension)	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az netappfiles account backup-vault create	Create the specified Backup Vault in the NetApp account.	Core	GA
az netappfiles account backup-vault create (netappfiles-preview extension)	Create the specified Backup Vault in the NetApp account.	Extension	Preview
az netappfiles account backup-vault delete	Delete the specified Backup Vault.	Core	GA
az netappfiles account backup-vault delete (netappfiles-preview extension)	Delete the specified Backup Vault.	Extension	Preview
az netappfiles account backup-vault list	List and describe all Backup Vaults in the NetApp account.	Core	GA
az netappfiles account backup-vault list (netappfiles-preview extension)	List and describe all Backup Vaults in the NetApp account.	Extension	Preview
az netappfiles account backup-vault show	Get the Backup Vault.	Core	GA
az netappfiles account backup-vault show (netappfiles-preview extension)	Get the Backup Vault.	Extension	Preview
az netappfiles account backup-vault update	Update the specified Backup Vault in the NetApp account.	Core	GA
az netappfiles account backup-vault update (netappfiles-preview extension)	Update the specified Backup Vault in the NetApp account.	Extension	Preview
az netappfiles account backup-vault wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az netappfiles account backup-vault wait (netappfiles-preview extension)	Place the CLI in a waiting state until a condition is met.	Extension	Preview
az netappfiles account create	Create the specified NetApp account within the resource group.	Core	GA
az netappfiles account delete	Delete the specified NetApp account.	Core	GA
az netappfiles account list	List and describe all NetApp accounts in the subscription.	Core	GA
az netappfiles account migrate-backup	Migrate the backups under a NetApp account to backup vault.	Core	GA
az netappfiles account renew-credentials	Renew identity credentials that are used to authenticate to key vault, for customer-managed key encryption. If encryption.identity.principalId does not match identity.principalId, running this operation will fix it.	Core	GA
az netappfiles account show	Get the NetApp account.	Core	GA
az netappfiles account update	Update the specified NetApp account within the resource group.	Core	GA
az netappfiles account wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az netappfiles check-file-path-availability	Check if a file path is available.	Core	GA
az netappfiles check-name-availability	Check if a resource name is available.	Core	GA
az netappfiles check-quota-availability	Check if a quota is available.	Core	GA
az netappfiles pool	Manage Azure NetApp Files (ANF) Capacity Pool Resources.	Core	GA
az netappfiles pool create	Create a capacity pool.	Core	GA
az netappfiles pool delete	Delete the specified capacity pool.	Core	GA
az netappfiles pool list	List all capacity pools in the NetApp Account.	Core	GA
az netappfiles pool show	Get details of the specified capacity pool.	Core	GA
az netappfiles pool update	Update a capacity pool.	Core	GA
az netappfiles pool wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az netappfiles query-network-sibling-set	Describe a network sibling set.	Core	GA
az netappfiles quota-limit	Get quota limits.	Core	GA
az netappfiles quota-limit list	List the default and current limits for quotas.	Core	GA
az netappfiles quota-limit show	Get the default and current subscription quota limit.	Core	GA
az netappfiles resource	Provides operations for Azure NetApp Files (ANF) Account Resources.	Core	GA
az netappfiles resource query-region-info	Provides storage to network proximity and logical zone mapping information.	Core	GA
az netappfiles resource region-info	Provides region specific information.	Core	GA
az netappfiles resource region-info default	Provides region specific information.	Core	GA
az netappfiles resource region-info default show	Get storage to network proximity and logical zone mapping information.	Core	GA
az netappfiles resource region-info list	List region specific information.	Core	GA
az netappfiles snapshot	Manage Azure NetApp Files (ANF) Snapshot Resources.	Core	GA
az netappfiles snapshot create	Create the specified snapshot within the given volume.	Core	GA
az netappfiles snapshot delete	Delete snapshot.	Core	GA
az netappfiles snapshot list	List all snapshots associated with the volume.	Core	GA
az netappfiles snapshot policy	Manage Azure NetApp Files (ANF) Snapshot Policy Resources.	Core	GA
az netappfiles snapshot policy create	Create a snapshot policy.	Core	GA
az netappfiles snapshot policy delete	Delete snapshot policy.	Core	GA
az netappfiles snapshot policy list	List snapshot policy.	Core	GA
az netappfiles snapshot policy show	Get a snapshot Policy.	Core	GA
az netappfiles snapshot policy update	Update a snapshot policy.	Core	GA
az netappfiles snapshot policy volumes	List volumes associated with snapshot policy.	Core	GA
az netappfiles snapshot policy wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az netappfiles snapshot restore-files	Restore the specified files from the specified snapshot to the active filesystem.	Core	GA
az netappfiles snapshot show	Get details of the specified snapshot.	Core	GA
az netappfiles snapshot update	Update the specified snapshot within the given volume.	Core	GA
az netappfiles snapshot wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az netappfiles subvolume	Manage Azure NetApp Files (ANF) Subvolume Resources.	Core	GA
az netappfiles subvolume create	Create a subvolume in the path or clones the subvolume mentioned in the parentPath.	Core	GA
az netappfiles subvolume delete	Delete subvolume.	Core	GA
az netappfiles subvolume list	List a list of the subvolumes in the volume.	Core	GA
az netappfiles subvolume metadata	Manage Azure NetApp Files (ANF) Subvolume Metadata.	Core	GA
az netappfiles subvolume metadata show	Get details of the specified subvolume.	Core	GA
az netappfiles subvolume show	Get the path associated with the subvolumeName provided.	Core	GA
az netappfiles subvolume update	Update a subvolume in the path or clones the subvolume mentioned in the parentPath.	Core	GA
az netappfiles subvolume wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az netappfiles update-network-sibling-set	Update the network features of a network sibling set.	Core	GA
az netappfiles volume	Manage Azure NetApp Files (ANF) Volume Resources.	Core and Extension	GA
az netappfiles volume-group	Manage Azure NetApp Files (ANF) Volume Group Resources.	Core	GA
az netappfiles volume-group create	Create a volume group along with specified volumes.	Core	GA
az netappfiles volume-group delete	Delete the specified volume group only if there are no volumes under volume group.	Core	GA
az netappfiles volume-group list	List all volume groups for given account.	Core	GA
az netappfiles volume-group show	Get details of the specified volume group.	Core	GA
az netappfiles volume-group update	Update a volume group along with specified volumes.	Core	GA
az netappfiles volume-group wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az netappfiles volume break-file-locks	Break all the file locks on a volume.	Core	GA
az netappfiles volume create	Create or Update a volume.	Core	GA
az netappfiles volume create (netappfiles-preview extension)	Create or Update a volume.	Extension	Preview
az netappfiles volume delete	Delete the specified volume.	Core	GA
az netappfiles volume export-policy	Manage Azure NetApp Files (ANF) Volume export policies.	Core	GA
az netappfiles volume export-policy add	Add a new rule to the export policy for a volume.	Core	GA
az netappfiles volume export-policy list	List the export policy rules for a volume.	Core	GA
az netappfiles volume export-policy remove	Remove a rule from the export policy for a volume by rule index. The current rules can be obtained by performing the subgroup list command.	Core	GA
az netappfiles volume export-policy show	Show the export policy rule for a volume.	Core	GA
az netappfiles volume export-policy update	Update the export policy rule for a volume.	Core	GA
az netappfiles volume export-policy wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az netappfiles volume finalize-relocation	Finalizes the relocation of the volume and cleans up the old volume.	Core	GA
az netappfiles volume get-groupid-list-for-ldapuser	Returns the list of group Ids for a specific LDAP User.	Core	GA
az netappfiles volume latest-backup-status	Get the latest backup status of a volume.	Core and Extension	GA
az netappfiles volume latest-backup-status current	Get the latest backup status of the current volume.	Core and Extension	GA
az netappfiles volume latest-backup-status current show	Get the latest status of the backup for a volume.	Core	GA
az netappfiles volume latest-backup-status current show (netappfiles-preview extension)	Get the latest status of the backup for a volume.	Extension	Preview
az netappfiles volume latest-restore-status	Get the latest backup status of a volume.	Core	GA
az netappfiles volume latest-restore-status current	Get the latest restore status of a volume.	Core	GA
az netappfiles volume latest-restore-status current show	Get the latest status of the restore for a volume.	Core	GA
az netappfiles volume list	List all volumes within the capacity pool.	Core	GA
az netappfiles volume list (netappfiles-preview extension)	List all volumes within the capacity pool.	Extension	Preview
az netappfiles volume migrate-backup	Migrate the backups under volume to backup vault.	Core	Preview
az netappfiles volume migrate-backup (netappfiles-preview extension)	Migrate the backups under volume to backup vault.	Extension	Preview
az netappfiles volume pool-change	Moves volume to another pool.	Core	GA
az netappfiles volume populate-availability-zone	This operation will populate availability zone information for a volume.	Core	GA
az netappfiles volume quota-rule	Manage Azure NetApp Files (ANF) Volume Quota Rules Resources.	Core	GA
az netappfiles volume quota-rule create	Create the specified quota rule within the given volume.	Core	GA
az netappfiles volume quota-rule delete	Delete quota rule.	Core	GA
az netappfiles volume quota-rule list	List all quota rules associated with the volume.	Core	GA
az netappfiles volume quota-rule show	Get details of the specified quota rule.	Core	GA
az netappfiles volume quota-rule update	Update the specified quota rule within the given volume.	Core	GA
az netappfiles volume quota-rule wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az netappfiles volume relocate	Relocates volume to a new stamp.	Core	GA
az netappfiles volume replication	Manage Azure NetApp Files (ANF) Volume replication.	Core	GA
az netappfiles volume replication approve	Authorize source volume replication.	Core	GA
az netappfiles volume replication list	List all replications for a specified volume.	Core	GA
az netappfiles volume replication re-initialize	Re-Initializes the replication connection on the destination volume.	Core	GA
az netappfiles volume replication reestablish	Re-establish a previously deleted replication between 2 volumes that have a common ad-hoc or policy-based snapshots.	Core	GA
az netappfiles volume replication remove	Delete the replication connection on the destination volume, and send release to the source replication.	Core	GA
az netappfiles volume replication resume	Resync the connection on the destination volume. If the operation is ran on the source volume it will reverse-resync the connection and sync from destination to source.	Core	GA
az netappfiles volume replication status	Get the status of the replication.	Core	GA
az netappfiles volume replication suspend	Suspend/Break the replication connection on the destination volume.	Core	GA
az netappfiles volume reset-cifs-pw	Reset cifs password from volume.	Core	GA
az netappfiles volume revert	Revert a volume to the snapshot specified in the body.	Core	GA
az netappfiles volume revert-relocation	Reverts the volume relocation process, cleans up the new volume and starts using the former-existing volume.	Core	GA
az netappfiles volume show	Get the details of the specified volume.	Core	GA
az netappfiles volume show (netappfiles-preview extension)	Get the details of the specified volume.	Extension	Preview
az netappfiles volume update	Update the specified volume within the capacity pool.	Core	GA
az netappfiles volume update (netappfiles-preview extension)	Update the specified volume within the capacity pool.	Extension	Preview
az netappfiles volume wait	Place the CLI in a waiting state until a condition is met.	Core	GA
az netappfiles volume wait (netappfiles-preview extension)	Place the CLI in a waiting state until a condition is met.	Extension	Preview

az netappfiles check-file-path-availability

Edit

Check if a file path is available.

az netappfiles check-file-path-availability --name
                                            --subnet-id
                                            [--ids]
                                            [--location]
                                            [--subscription]

Required Parameters

--name

File path to verify.

--subnet-id

The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes.

Optional Parameters

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

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az netappfiles check-name-availability

Edit

Check if a resource name is available.

az netappfiles check-name-availability --name
                                       --resource-group
                                       --type {Microsoft.NetApp/netAppAccounts, Microsoft.NetApp/netAppAccounts/capacityPools, Microsoft.NetApp/netAppAccounts/capacityPools/volumes, Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots}
                                       [--ids]
                                       [--location]
                                       [--subscription]

Required Parameters

--name

Resource name to verify.

--resource-group -g

Resource group name.

--type

Resource type used for verification.

Accepted values: Microsoft.NetApp/netAppAccounts, Microsoft.NetApp/netAppAccounts/capacityPools, Microsoft.NetApp/netAppAccounts/capacityPools/volumes, Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots

Optional Parameters

--ids

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az netappfiles check-quota-availability

Edit

Check if a quota is available.

az netappfiles check-quota-availability --name
                                        --resource-group
                                        --type {Microsoft.NetApp/netAppAccounts, Microsoft.NetApp/netAppAccounts/capacityPools, Microsoft.NetApp/netAppAccounts/capacityPools/volumes, Microsoft.NetApp/netAppAccounts/capacityPools/volumes/snapshots}
                                        [--ids]
                                        [--location]
                                        [--subscription]

Required Parameters

--name

Name of the resource to verify.

--resource-group -g

Resource group name.

--type

Resource type used for verification.

Optional Parameters

--ids

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az netappfiles query-network-sibling-set

Edit

Describe a network sibling set.

Get details of the specified network sibling set.

az netappfiles query-network-sibling-set --network-sibling-set-id
                                         --subnet-id
                                         [--ids]
                                         [--location]
                                         [--subscription]

Examples

Query network sibling set

az netappfiles query-network-sibling-set -l westus2 --network-sibling-set-id {SIBLIING_SET_ID} --subnet-id {SUBNET_ID}

Required Parameters

--network-sibling-set-id

Network Sibling Set ID for a group of volumes sharing networking resources in a subnet.

--subnet-id

The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes. Example /subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.Network/virtualNetworks/testVnet/subnets/{mySubnet}.

Optional Parameters

--ids

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

az netappfiles update-network-sibling-set

Edit

Update the network features of a network sibling set.

Update the network features of the specified network sibling set.

az netappfiles update-network-sibling-set --network-sibling-set-id
                                          --network-sibling-set-state-id
                                          --subnet-id
                                          [--ids]
                                          [--location]
                                          [--network-features {Basic, Standard}]
                                          [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                          [--subscription]

Examples

Update Network sibling set

az -l westus2 --network-sibling-set-id {SIBLIING_SET_ID} --subnet-id {SUBNET_ID} --network-sibling-set-state-id {SIBLING_SET_STATE_ID} --network-features Standard

Required Parameters

--network-sibling-set-id

Network Sibling Set ID for a group of volumes sharing networking resources in a subnet.

--network-sibling-set-state-id --state-id

Network sibling set state Id identifying the current state of the sibling set.

--subnet-id

Optional Parameters

--ids

--location -l

Location. Values from: az account list-locations. You can configure the default location using az configure --defaults location=<location>.

--network-features

Network features available to the volume.

Accepted values: Basic, Standard

Default value: Basic

--no-wait

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

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

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc

Default value: json

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

Share via

az netappfiles

Commands

az netappfiles check-file-path-availability

Required Parameters

Optional Parameters

az netappfiles check-name-availability

Required Parameters

Optional Parameters

az netappfiles check-quota-availability

Required Parameters

Optional Parameters

az netappfiles query-network-sibling-set

Examples

Required Parameters

Optional Parameters

az netappfiles update-network-sibling-set

Examples

Required Parameters

Optional Parameters

Feedback

Additional resources