az netappfiles volume-group

Manage Azure NetApp Files (ANF) Volume Group Resources.

Commands

az netappfiles volume-group create	Create ANF Volume Groups.
az netappfiles volume-group delete	Delete a volume group.
az netappfiles volume-group list	Get a list of ANF Volume Groups.
az netappfiles volume-group show	Get the specified ANF Volume Group.
az netappfiles volume-group wait	Wait for a volume group to be created.

az netappfiles volume-group create

Create ANF Volume Groups.

az netappfiles volume-group create --account-name
                                   --group-name
                                   --pool-name
                                   --ppg
                                   --resource-group
                                   --sap-sid
                                   --vnet
                                   [--add-snapshot-capacity]
                                   [--backup-nfsv3]
                                   [--data-backup-repl-skd]
                                   [--data-backup-size]
                                   [--data-backup-src-id]
                                   [--data-backup-throughput]
                                   [--data-repl-skd]
                                   [--data-size]
                                   [--data-src-id]
                                   [--data-throughput]
                                   [--global-placement-rules]
                                   [--location]
                                   [--log-backup-repl-skd]
                                   [--log-backup-size]
                                   [--log-backup-src-id]
                                   [--log-backup-throughput]
                                   [--log-size]
                                   [--log-throughput]
                                   [--memory]
                                   [--no-wait]
                                   [--number-of-hots]
                                   [--prefix]
                                   [--shared-repl-skd]
                                   [--shared-size]
                                   [--shared-src-id]
                                   [--shared-throughput]
                                   [--start-host-id]
                                   [--subnet]
                                   [--system-role {DR, HA, PRIMARY}]
                                   [--tags]

Examples

Create ANF volume group

az netappfiles volume-group create -g mygroup --account-name myaccountname --pool-name mypoolname --volume-group-name myvolumegroupname --vnet myvnet --ppg myppg --sap-sid mysapsid

Required Parameters

--account-name -a

Name of the ANF account.

--group-name --volume-group-name

The name of the ANF volume group.

--pool-name -p

Name of the ANF pool.

--ppg

The resource id of the Proximity Placement Group for volume placement.

--resource-group -g

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

--sap-sid

The SAP system ID. Three characters long alpha-numeric string.

--vnet

The ARM Id or name of the vnet for the volumes.

Optional Parameters

--add-snapshot-capacity

Additional memory to store snapshots, must be specified as % of RAM (range 0-200). This is used to auto compute storage size.

default value: 50

--backup-nfsv3

Indicates if NFS Protocol version 3 is preferred for data backup and log backup volumes. Default is false.

--data-backup-repl-skd

Replication Schedule for data backup volume.

--data-backup-size

Capacity (in GiB) for data backup volumes. If not provided size will automatically be calculated.

--data-backup-src-id

ResourceId of the data backup source volume.

--data-backup-throughput

Throughput in MiB/s for data backup volumes. If not provided size will automatically be calculated.

--data-repl-skd

Replication Schedule for data volume.

--data-size

Capacity (in GiB) for data volumes. If not provided size will automatically be calculated.

--data-src-id

ResourceId of the data source volume.

--data-throughput

Throughput in MiB/s for data volumes. If not provided size will automatically be calculated.

--global-placement-rules --gp-rules

Application specific identifier of deployment rules for the volume group. Space-separated string in key=value format.

--location -l

ANF Location. If the resource group location is different than ANF location, ANF location needs to be specified.

--log-backup-repl-skd

Replication Schedule for log backup volume.

--log-backup-size

Capacity (in GiB) for log backup volumes. If not provided size will automatically be calculated.

--log-backup-src-id

ResourceId of the log backup source volume.

--log-backup-throughput

Throughput in MiB/s for log backup volumes. If not provided size will automatically be calculated.

--log-size

Capacity (in GiB) for log volumes. If not provided size will automatically be calculated.

--log-throughput

Throughput in MiB/s for log volumes. If not provided size will automatically be calculated.

--memory

SAP HANA memory in GiB (max 12000 GiB), used to auto compute storage size and throughput.

default value: 100

--no-wait

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

--number-of-hots

Total Number of SAP HANA host in this deployment (currently max 3 nodes can be configured).

default value: 1

--prefix

All volume names will be prefixed with the given text. The default values for prefix text depends on system role. For PRIMARY it will be "" and HA it will be "HA-".

--shared-repl-skd

Replication Schedule for shared volume.

--shared-size

Capacity (in GiB) for shared volume. If not provided size will automatically be calculated.

--shared-src-id

ResourceId of the shared source volume.

--shared-throughput

Throughput in MiB/s for shared volume. If not provided size will automatically be calculated.

--start-host-id

Starting SAP HANA Host ID. Host ID 1 indicates Master Host. Shared, Data Backup and Log Backup volumes are only provisioned for Master Host i.e. HostID == 1.

default value: 1

--subnet

The delegated Subnet name.

default value: default

--system-role

Type of role for the storage account. Primary indicates first of a SAP HANA Replication (HSR) setup or No HSR. High Availability (HA) specifies local scenario. Default is PRIMARY.

accepted values: DR, HA, PRIMARY

default value: PRIMARY

--tags

Space-separated tags in key=value format.

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

Delete a volume group.

Delete the specified volume group only if there are no volumes under volume group.

az netappfiles volume-group delete --account-name
                                   --group-name
                                   --resource-group
                                   [--no-wait]
                                   [--yes]

Required Parameters

--account-name -a

Name of the ANF account.

--group-name --volume-group-name

The name of the ANF volume group.

--resource-group -g

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

Optional Parameters

--no-wait

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

--yes -y

Do not prompt for confirmation.

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

Get a list of ANF Volume Groups.

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

Examples

Get a list of ANF volume groups

az netappfiles volume-group list -g mygroup --account-name myaccountname

Required Parameters

--account-name -a

Name of the ANF account.

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

Get the specified ANF Volume Group.

az netappfiles volume-group show --account-name
                                 --group-name
                                 --resource-group

Examples

Get an ANF volume group

az netappfiles volume-group show -g mygroup --account-name myaccountname --volume-group-name myvolumegroupname

Required Parameters

--account-name -a

Name of the ANF account.

--group-name --volume-group-name

The name of the ANF volume group.

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

Wait for a volume group to be created.

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

Required Parameters

--account-name -a

Name of the ANF account.

--group-name --volume-group-name

The name of the ANF volume group.

--resource-group -g

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

Optional Parameters

--created

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

--custom

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

--deleted

Wait until deleted.

--exists

Wait until the resource exists.

--interval

Polling interval in seconds.

default value: 30

--timeout

Maximum wait in seconds.

default value: 3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

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.