az netappfiles snapshot

Manage Azure NetApp Files (ANF) Snapshot Resources.

Commands

az netappfiles snapshot create	Create a new Azure NetApp Files (ANF) snapshot.
az netappfiles snapshot delete	Delete the specified ANF snapshot.
az netappfiles snapshot list	List the snapshots of an ANF volume.
az netappfiles snapshot policy	Manage Azure NetApp Files (ANF) Snapshot Policy Resources.
az netappfiles snapshot policy create	Create a new Azure NetApp Files (ANF) snapshot policy.
az netappfiles snapshot policy delete	Delete the specified ANF snapshot policy.
az netappfiles snapshot policy list	List the ANF snapshot policies for the specified account.
az netappfiles snapshot policy show	Get the specified ANF snapshot policy.
az netappfiles snapshot policy update	Update the specified ANF snapshot policy.
az netappfiles snapshot policy volumes	Get the all ANF volumes associated with snapshot policy.
az netappfiles snapshot policy wait	Wait for a snapshot policy operation.
az netappfiles snapshot restore-files	Restore specified files from the specified snapshot to the active filesystem.
az netappfiles snapshot show	Get the specified ANF snapshot.
az netappfiles snapshot update	Update a snapshot.
az netappfiles snapshot wait	Wait for a snapshot operation.

az netappfiles snapshot create

Create a new Azure NetApp Files (ANF) snapshot.

az netappfiles snapshot create --account-name
                               --name
                               --pool-name
                               --resource-group
                               --volume-name
                               [--location]
                               [--no-wait]

Examples

Create an ANF snapshot

az netappfiles snapshot create -g mygroup --account-name myaccname --pool-name mypoolname --volume-name myvolname --name mysnapname -l eastus

Required Parameters

--account-name -a

The name of the ANF account.

--name --snapshot-name -n -s

The name of the ANF snapshot.

--pool-name -p

The name of the ANF 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 ANF volume.

Optional Parameters

--location -l

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

--no-wait

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

default value: False

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.

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

Delete the specified ANF snapshot.

az netappfiles snapshot delete [--account-name]
                               [--ids]
                               [--name]
                               [--no-wait]
                               [--pool-name]
                               [--resource-group]
                               [--subscription]
                               [--volume-name]

Examples

Delete an ANF snapshot

az netappfiles snapshot delete -g mygroup --account-name myaccname --pool-name mypoolname --volume-name myvolname --name mysnapname

Optional Parameters

--account-name -a

The name of the ANF account.

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

--name --snapshot-name -n -s

The name of the ANF snapshot.

--no-wait

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

default value: False

--pool-name -p

The name of the ANF pool.

--resource-group -g

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

--subscription

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

--volume-name -v

The name of the ANF volume.

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.

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

List the snapshots of an ANF volume.

az netappfiles snapshot list --account-name
                             --pool-name
                             --resource-group
                             --volume-name

Examples

list the snapshots of an ANF volume

az netappfiles snapshot list -g mygroup --account-name myaccname --pool-name mypoolname --volume-name myvolname

Required Parameters

--account-name -a

The name of the ANF account.

--pool-name -p

The name of the ANF 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 ANF volume.

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.

--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 snapshot restore-files

Restore specified files from the specified snapshot to the active filesystem.

az netappfiles snapshot restore-files --file-paths
                                      [--account-name]
                                      [--destination-path]
                                      [--ids]
                                      [--name]
                                      [--no-wait]
                                      [--pool-name]
                                      [--resource-group]
                                      [--subscription]
                                      [--volume-name]

Examples

Restore files from snapshot

az netappfiles snapshot restore-files -g mygroup --account-name myaccname --pool-name mypoolname --volume-name myvolname --name mysnapname --file-paths myfilepaths

Required Parameters

--file-paths

Required. A space separated string of filed to be restored.

Optional Parameters

--account-name -a

The name of the ANF account.

--destination-path

Destination folder where the files will be restored.

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

--name --snapshot-name -n -s

The name of the ANF snapshot.

--no-wait

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

default value: False

--pool-name -p

The name of the ANF pool.

--resource-group -g

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

--subscription

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

--volume-name -v

The name of the ANF volume.

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.

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

Get the specified ANF snapshot.

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

Examples

Return the specified ANF snapshot

az netappfiles snapshot show -g mygroup --account-name myaccname --pool-name mypoolname --volume-name myvolname --name mysnapname

Optional Parameters

--account-name -a

The name of the ANF account.

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

--name --snapshot-name -n -s

The name of the ANF snapshot.

--pool-name -p

The name of the ANF pool.

--resource-group -g

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

--subscription

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

--volume-name -v

The name of the ANF volume.

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.

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

Update a snapshot.

Patch a snapshot.

az netappfiles snapshot update --body
                               [--account-name]
                               [--ids]
                               [--name]
                               [--no-wait]
                               [--pool-name]
                               [--resource-group]
                               [--subscription]
                               [--volume-name]

Required Parameters

--body

Snapshot object supplied in the body of the operation. Required.

Optional Parameters

--account-name -a

Name of the ANF account.

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

--name --snapshot-name -n -s

The name of the ANF snapshot.

--no-wait

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

default value: False

--pool-name -p

Name of the ANF pool.

--resource-group -g

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

--subscription

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

--volume-name -v

Name of the ANF volume.

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.

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

Wait for a snapshot operation.

az netappfiles snapshot wait [--account-name]
                             [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--name]
                             [--pool-name]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]
                             [--volume-name]

Optional Parameters

--account-name -a

Name of the ANF account.

--created

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

default value: False

--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

default value: False

--exists

Wait until the resource exists.

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.

--interval

Polling interval in seconds.

default value: 30

--name --snapshot-name -n -s

The name of the ANF snapshot.

--pool-name -p

Name of the ANF pool.

--resource-group -g

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

--subscription

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

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

default value: False

--volume-name -v

Name of the ANF volume.

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.

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