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

Edit

Create a volume group along with specified volumes.

az netappfiles volume-group create --account-name
                                   --group-name --name --volume-group-name
                                   --resource-group
                                   [--add-snapshot-capacity]
                                   [--application-identifier --sap-sid]
                                   [--application-type {ORACLE, SAP-HANA}]
                                   [--backup-nfsv3 {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--binary-size]
                                   [--binary-throughput]
                                   [--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]
                                   [--database-size]
                                   [--database-throughput]
                                   [--encryption-key-source {Microsoft.KeyVault, Microsoft.NetApp}]
                                   [--gp-rules]
                                   [--group-description]
                                   [--key-vault-private-endpoint-resource-id --kv-private-endpoint-id]
                                   [--___location]
                                   [--log-backup-repl-skd {_10minutely, daily, hourly}]
                                   [--log-backup-size]
                                   [--log-backup-src-id]
                                   [--log-backup-throughput]
                                   [--log-mirror-size]
                                   [--log-mirror-throughput]
                                   [--log-size]
                                   [--log-throughput]
                                   [--memory]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--number-of-hosts --number-of-hots]
                                   [--number-of-volumes]
                                   [--pool-name]
                                   [--ppg --proximity-placement-group]
                                   [--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]
                                   [--zones]

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 --zones 1 --application-type ORACLE --application-identifier OR2 --prefix ora

Required Parameters

--account-name -a

The name of the NetApp account.

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

The name of the volumeGroup.

--resource-group -g

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

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

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

Property	Value
Parameter group:	Volumes Arguments
Default value:	50

--application-identifier --sap-sid

Application specific identifier.

Property	Value
Parameter group:	GroupMetaData Arguments

--application-type

Application Type.

Property	Value
Parameter group:	GroupMetaData Arguments
Default value:	SAP-HANA
Accepted values:	ORACLE, SAP-HANA

--backup-nfsv3

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

Property	Value
Parameter group:	Backup Volume Properties Arguments
Default value:	False
Accepted values:	0, 1, f, false, n, no, t, true, y, yes

--binary-size

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

Property	Value
Parameter group:	Oracle Volumes Arguments

--binary-throughput

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

Property	Value
Parameter group:	Oracle Volumes Arguments

--data-backup-repl-skd

Replication Schedule for data backup volume.

Property	Value
Parameter group:	Data Backup Volume Arguments
Accepted values:	_10minutely, daily, hourly

--data-backup-size

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

Property	Value
Parameter group:	Data Backup Volume Arguments

--data-backup-src-id

ResourceId of the data backup source volume.

Property	Value
Parameter group:	Data Backup Volume Arguments

--data-backup-throughput

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

Property	Value
Parameter group:	Data Backup Volume Arguments

--data-repl-skd

Replication Schedule for data volume.

Property	Value
Parameter group:	Data Volume Arguments
Accepted values:	_10minutely, daily, hourly

--data-size

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

Property	Value
Parameter group:	Data Volume Arguments

--data-src-id

ResourceId of the data source volume.

Property	Value
Parameter group:	Data Volume Arguments

--data-throughput

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

Property	Value
Parameter group:	Data Volume Arguments

--database-size

Oracle database size in (TiB), used to auto compute storage size and throughput.

Property	Value
Parameter group:	Volume Group Oracle sizing Arguments
Default value:	100

--database-throughput

Oracle database throughput in (MiB/s), used to auto compute storage size and throughput.

Property	Value
Parameter group:	Volume Group Oracle sizing Arguments
Default value:	1

--encryption-key-source

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

Property	Value
Parameter group:	CMK Encryption Arguments
Default value:	Microsoft.NetApp
Accepted values:	Microsoft.KeyVault, Microsoft.NetApp

--gp-rules

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

Property	Value
Parameter group:	GroupMetaData Arguments

--group-description

Group Description.

Property	Value
Parameter group:	GroupMetaData Arguments

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

Property	Value
Parameter group:	CMK Encryption Arguments

--___location -l

Resource ___location.

Property	Value
Parameter group:	Body Arguments

--log-backup-repl-skd

Replication Schedule for Log backup volume.

Property	Value
Parameter group:	Log Volume Arguments
Accepted values:	_10minutely, daily, hourly

--log-backup-size

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

Property	Value
Parameter group:	Log Backup Volume Arguments

--log-backup-src-id

ResourceId of the log backup source volume.

Property	Value
Parameter group:	Log Backup Volume Arguments

--log-backup-throughput

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

Property	Value
Parameter group:	Log Backup Volume Arguments

--log-mirror-size

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

Property	Value
Parameter group:	Oracle Volumes Arguments

--log-mirror-throughput

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

Property	Value
Parameter group:	Oracle Volumes Arguments

--log-size

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

Property	Value
Parameter group:	Log Volume Arguments

--log-throughput

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

Property	Value
Parameter group:	Log Volume Arguments

--memory

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

Property	Value
Parameter group:	Volume Group SAP-HANA sizing Arguments
Default value:	100

--no-wait

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

Property	Value
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).

Property	Value
Parameter group:	Volume Group SAP-HANA sizing Arguments
Default value:	1

--number-of-volumes

Total Number of Oracle data volumes (currently min 2 and max 8 nodes can be configured).

Property	Value
Parameter group:	Volume Group Oracle sizing Arguments

--pool-name -p

Name of the ANF capacity pool.

Property	Value
Parameter group:	Volumes Arguments

--ppg --proximity-placement-group

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

Property	Value
Parameter group:	Volumes Arguments

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

Property	Value
Parameter group:	Volumes Arguments

--shared-repl-skd

Replication Schedule for shared volume.

Property	Value
Parameter group:	Shared Volume Arguments
Accepted values:	_10minutely, daily, hourly

--shared-size

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

Property	Value
Parameter group:	Shared Volume Arguments

--shared-src-id

ResourceId of the shared source volume.

Property	Value
Parameter group:	Shared Volume Arguments

--shared-throughput

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

Property	Value
Parameter group:	Shared Volume Arguments

--smb-access

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

Property	Value
Parameter group:	Volumes Arguments
Accepted values:	Disabled, Enabled

--smb-browsable

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

Property	Value
Parameter group:	Volumes Arguments
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.

Property	Value
Parameter group:	Volumes Arguments
Default value:	1

--subnet

The delegated Subnet name.

Property	Value
Parameter group:	Volumes Arguments
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.

Property	Value
Parameter group:	Volumes Arguments
Default value:	PRIMARY
Accepted values:	DR, HA, PRIMARY

--tags

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

Property	Value
Parameter group:	Body Arguments

--vnet

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

Property	Value
Parameter group:	Volumes Arguments

--volumes

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

Property	Value
Parameter group:	Properties Arguments

--zones

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

Property	Value
Parameter group:	Body Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az netappfiles volume-group delete

Edit

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

az netappfiles volume-group delete [--account-name]
                                   [--group-name --name --volume-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

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

The name of the volumeGroup.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--yes -y

Do not prompt for confirmation.

Property	Value
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az netappfiles volume-group list

Edit

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.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

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

Property	Value
Default value:	False

az netappfiles volume-group show

Edit

Get details of the specified volume group.

az netappfiles volume-group show [--account-name]
                                 [--group-name --name --volume-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

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

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

The name of the volumeGroup.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az netappfiles volume-group update

Edit

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 --name --volume-group-name]
                                   [--ids]
                                   [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                   [--remove]
                                   [--resource-group]
                                   [--set]
                                   [--subscription]
                                   [--volumes]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

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

Property	Value
Parameter group:	Generic Update Arguments

--force-string

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

Property	Value
Parameter group:	Generic Update Arguments
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.

Property	Value
Parameter group:	Properties Arguments

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

The name of the volumeGroup.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--no-wait

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

Property	Value
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 <indexToRemove> OR --remove propertyToRemove.

Property	Value
Parameter group:	Generic Update Arguments

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--set

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

Property	Value
Parameter group:	Generic Update Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--volumes

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

Property	Value
Parameter group:	Properties Arguments

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

az netappfiles volume-group wait

Edit

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 --name --volume-group-name]
                                 [--ids]
                                 [--interval]
                                 [--resource-group]
                                 [--subscription]
                                 [--timeout]
                                 [--updated]

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--account-name -a

The name of the NetApp account.

Property	Value
Parameter group:	Resource Id Arguments

--created

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

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--custom

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

Property	Value
Parameter group:	Wait Condition Arguments

--deleted

Wait until deleted.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

--exists

Wait until the resource exists.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

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

The name of the volumeGroup.

Property	Value
Parameter group:	Resource Id Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--resource-group -g

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

Property	Value
Parameter group:	Resource Id Arguments

--subscription

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

Property	Value
Parameter group:	Resource Id Arguments

--timeout

Maximum wait in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	3600

--updated

Wait until updated with provisioningState at 'Succeeded'.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	False

Global Parameters

--debug

Increase logging verbosity to show all debug logs.

Property	Value
Default value:	False

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property	Value
Default value:	False

--output -o

Output format.

Property	Value
Default value:	json
Accepted values:	json, jsonc, none, table, tsv, yaml, yamlc

--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property	Value
Default value:	False

Feedback

Was this page helpful?

Share via

az netappfiles volume-group

Commands

az netappfiles volume-group create

Examples

Required Parameters

Optional Parameters

az netappfiles volume-group delete

Examples

Optional Parameters

az netappfiles volume-group list

Examples

Required Parameters

az netappfiles volume-group show

Examples

Optional Parameters

az netappfiles volume-group update

Optional Parameters

az netappfiles volume-group wait

Optional Parameters

Feedback