Share via

az netappfiles snapshot

  • Reference

Manage Azure NetApp Files (ANF) Snapshot Resources.

Commands

Name Description Type Status
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 snapshot create

Edit

Create the specified snapshot within the given volume.

az netappfiles snapshot create --account-name
                               --name
                               --pool-name
                               --resource-group
                               --volume-name
                               [--location]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]

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

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

The name of the snapshot.

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

--location -l

Resource location When not specified, the location of the resource group will be used.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
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 snapshot delete

Edit

Delete snapshot.

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

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

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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>.

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

--yes -y

Do not prompt for confirmation.

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.

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

Edit

List all snapshots associated with the 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 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.

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

Edit

Restore the 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 {0, 1, f, false, n, no, t, true, y, yes}]
                                      [--pool-name]
                                      [--resource-group]
                                      [--subscription]
                                      [--volume-name]

Examples

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

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

List of files to be restored Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Optional Parameters

--account-name -a

The name of the NetApp 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 snapshot.

--no-wait

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

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--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>.

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

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

Edit

Get details of the specified snapshot.

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

Examples

Get 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 NetApp 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 snapshot.

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

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

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

Edit

Update the specified snapshot within the given volume.

az netappfiles snapshot update [--account-name]
                               [--add]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--ids]
                               [--name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--pool-name]
                               [--remove]
                               [--resource-group]
                               [--set]
                               [--subscription]
                               [--volume-name]

Optional Parameters

--account-name -a

The name of the NetApp account.

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

--force-string

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

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.

--name --snapshot-name -n

The name of the snapshot.

--no-wait

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

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

The name of the capacity pool.

--remove

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

--resource-group -g

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

--set

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

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

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

Edit

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

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

The name of the NetApp 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 snapshot.

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

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

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

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.