az netappfiles volume-group

Manage Azure NetApp Files (ANF) Volume Group Resources.

Commands

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

Create a volume group along with specified volumes.

az netappfiles volume-group create --account-name
                                   --group-name
                                   --ppg
                                   --resource-group
                                   [--add-snapshot-capacity]
                                   [--application-identifier]
                                   [--application-type {ORACLE, SAP-HANA}]
                                   [--backup-nfsv3 {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--data-backup-repl-skd {_10minutely, daily, hourly}]
                                   [--data-backup-size]
                                   [--data-backup-src-id]
                                   [--data-backup-throughput]
                                   [--data-repl-skd {_10minutely, daily, hourly}]
                                   [--data-size]
                                   [--data-src-id]
                                   [--data-throughput]
                                   [--encryption-key-source {Microsoft.KeyVault, Microsoft.NetApp}]
                                   [--gp-rules]
                                   [--group-description]
                                   [--key-vault-private-endpoint-resource-id]
                                   [--location]
                                   [--log-backup-repl-skd {_10minutely, daily, hourly}]
                                   [--log-backup-size]
                                   [--log-backup-src-id]
                                   [--log-backup-throughput]
                                   [--log-size]
                                   [--log-throughput]
                                   [--memory]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--number-of-hosts]
                                   [--pool-name]
                                   [--prefix]
                                   [--shared-repl-skd {_10minutely, daily, hourly}]
                                   [--shared-size]
                                   [--shared-src-id]
                                   [--shared-throughput]
                                   [--smb-access {Disabled, Enabled}]
                                   [--smb-browsable {Disabled, Enabled}]
                                   [--start-host-id]
                                   [--subnet]
                                   [--system-role {DR, HA, PRIMARY}]
                                   [--tags]
                                   [--vnet]
                                   [--volumes]

Examples

Create ANF volume group for SAP

az netappfiles volume-group create -g mygroup --account-name myaccountname --pool-name mypoolname --volume-group-name myvolumegroupname --vnet myvnet --ppg myppg --application-type SAP-HANA --application-identifier mysapsid

Create ANF volume group for Oracle

az netappfiles volume-group create -g mygroup --account-name myaccountname --pool-name mypoolname --volume-group-name myvolumegroupname --vnet myvnet --ppg myppg --application-type ORACLE --application-identifier DEV

Required Parameters

--account-name -a

The name of the NetApp account.

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

The name of the volumeGroup.

--ppg --proximity-placement-group

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

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

default value: 50
--application-identifier --sap-sid

Application specific identifier.

--application-type

Application Type.

accepted values: ORACLE, SAP-HANA
default value: SAP-HANA
--backup-nfsv3

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
default value: False
--data-backup-repl-skd

Replication Schedule for data backup volume.

accepted values: _10minutely, daily, hourly
--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.

accepted values: _10minutely, daily, hourly
--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.

--encryption-key-source

Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'.

accepted values: Microsoft.KeyVault, Microsoft.NetApp
default value: Microsoft.NetApp
--gp-rules

Application specific placement rules for the volume group. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--group-description

Group Description.

--key-vault-private-endpoint-resource-id --kv-private-endpoint-id

The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.

--location -l

Resource location.

--log-backup-repl-skd

Replication Schedule for Log backup volume.

accepted values: _10minutely, daily, hourly
--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

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--number-of-hosts --number-of-hots

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

default value: 1
--pool-name -p

Name of the ANF capacity pool.

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

accepted values: _10minutely, daily, hourly
--shared-size

Capacity (in GiB) for shared volumes. 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 volumes. If not provided size will automatically be calculated.

--smb-access

Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.

accepted values: Disabled, Enabled
--smb-browsable

Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.

accepted values: Disabled, Enabled
--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. Allowed values: DR, HA, PRIMARY.

accepted values: DR, HA, PRIMARY
default value: PRIMARY
--tags

Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--vnet

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

--volumes

List of volumes from group Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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

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

Examples

Delete an ANF volume group

az netappfiles volume-group create -g mygroup --account-name myaccountname --pool-name mypoolname --volume-group-name myvolumegroupname

Optional Parameters

--account-name -a

The name of the NetApp account.

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

The name of the volumeGroup.

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

--no-wait

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

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

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

List all volume groups for given account.

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

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

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

Get details of the specified volume group.

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

Examples

Get an ANF volume group

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

Optional Parameters

--account-name -a

The name of the NetApp account.

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

The name of the volumeGroup.

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

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

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 volume-group update

Update a volume group along with specified volumes.

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

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
--group-meta-data

Volume group details Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

The name of the volumeGroup.

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

--no-wait

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

accepted values: 0, 1, f, false, n, no, t, true, y, yes
--remove

Remove a property or an element from a list. Example: --remove property.list 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=.

--subscription

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

--volumes

List of volumes from group Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

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

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

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

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

The name of the volumeGroup.

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

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.