az netappfiles volume export-policy

  • Reference

Manage Azure NetApp Files (ANF) Volume export policies.

Commands

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

Wait for a volume export-policy operation.

 Core GA

az netappfiles volume export-policy add

Edit

Add a new rule to the export policy for a volume.

az netappfiles volume export-policy add --allowed-clients
                                        --cifs {false, true}
                                        --nfsv3 {false, true}
                                        --nfsv41 {false, true}
                                        --unix-read-only {false, true}
                                        --unix-read-write {false, true}
                                        [--account-name]
                                        [--chown-mode]
                                        [--has-root-access {false, true}]
                                        [--ids]
                                        [--kerberos5-r]
                                        [--kerberos5-rw]
                                        [--kerberos5i-r]
                                        [--kerberos5i-rw]
                                        [--kerberos5p-r]
                                        [--kerberos5p-rw]
                                        [--name]
                                        [--no-wait]
                                        [--pool-name]
                                        [--resource-group]
                                        [--rule-index]
                                        [--subscription]

Examples

Add an export policy rule for the ANF volume

az netappfiles volume export-policy add -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname --allowed-clients "1.2.3.0/24" --rule-index 2 --unix-read-only true --unix-read-write false --cifs false --nfsv3 true --nfsv41 false

Required Parameters

--allowed-clients

Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names).

--cifs

Indication that CIFS protocol is allowed.

accepted values: false, true
--nfsv3

Indication that NFSv3 protocol is allowed.

accepted values: false, true
--nfsv41

Indication that NFSv4.1 protocol is allowed.

accepted values: false, true
--unix-read-only

Indication of read only access.

accepted values: false, true
--unix-read-write

Indication of read and write access.

accepted values: false, true

Optional Parameters

--account-name -a

The name of the ANF account.

--chown-mode

This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own. Possible values include- Restricted, Unrestricted. Default value- Restricted.

--has-root-access

Vol Has root access to volume.

accepted values: false, true
--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.

--kerberos5-r

Kerberos5 Read only access.

--kerberos5-rw

Kerberos5 Read and write access.

--kerberos5i-r

Kerberos5i Read only access.

--kerberos5i-rw

Kerberos5i Read and write access.

--kerberos5p-r

Kerberos5p Read only access.

--kerberos5p-rw

Kerberos5p Read and write access.

--name --volume-name -n -v

The name of the ANF volume.

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

--rule-index

Order index. No number can be repeated. Max 6 rules.

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

--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 volume export-policy list

Edit

List the export policy rules for a volume.

az netappfiles volume export-policy list --account-name
                                         --name
                                         --pool-name
                                         --resource-group

Examples

List the export policy rules for an ANF volume

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

Required Parameters

--account-name -a

The name of the ANF account.

--name --volume-name -n -v

The name of the ANF volume.

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

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 volume export-policy remove

Edit

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.

az netappfiles volume export-policy remove --rule-index
                                           [--account-name]
                                           [--add]
                                           [--force-string]
                                           [--ids]
                                           [--name]
                                           [--no-wait]
                                           [--pool-name]
                                           [--remove]
                                           [--resource-group]
                                           [--set]
                                           [--subscription]

Examples

Remove an export policy rule for an ANF volume

az netappfiles volume export-policy remove -g mygroup --account-name myaccname --pool-name mypoolname --name myvolname --rule-index 4

Required Parameters

--rule-index

Order index. Range 1 to 6.

Optional Parameters

--account-name -a

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

default value: []
--force-string

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

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.

--name --volume-name -n -v

The name of the ANF volume.

--no-wait

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

default value: False
--pool-name -p

The name of the ANF pool.

--remove

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

default value: []
--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=.

default value: []
--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.

--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 volume export-policy wait

Edit

Wait for a volume export-policy operation.

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

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 --volume-name -n -v

Name of the ANF volume.

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