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]
[--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 mysapsidCreate 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 DEVRequired Parameters
The name of the NetApp account.
The name of the volumeGroup.
The resource id of the Proximity Placement Group for volume placement.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Optional Parameters
Additional memory to store snapshots, must be specified as % of RAM (range 0-200). This is used to auto compute storage size. Default: 50.
Application specific identifier.
Application Type.
Indicates if NFS Protocol version 3 is preferred for data backup and log backup volumes. Default is False.
Replication Schedule for data backup volume.
Capacity (in GiB) for data backup volumes. If not provided size will automatically be calculated.
ResourceId of the data backup source volume.
Throughput in MiB/s for data backup volumes. If not provided size will automatically be calculated.
Replication Schedule for data volume.
Capacity (in GiB) for data volumes. If not provided size will automatically be calculated.
ResourceId of the data source volume.
Throughput in MiB/s for data volumes. If not provided size will automatically be calculated.
Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'.
Application specific placement rules for the volume group. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Group Description.
The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.
Resource location.
Replication Schedule for Log backup volume.
Capacity (in GiB) for log backup volumes. If not provided size will automatically be calculated.
ResourceId of the log backup source volume.
Throughput in MiB/s for log backup volumes. If not provided size will automatically be calculated.
Capacity (in GiB) for log volumes. If not provided size will automatically be calculated.
Throughput in MiB/s for log volumes. If not provided size will automatically be calculated.
System (SAP HANA) memory in GiB (max 12000 GiB), used to auto compute storage size and throughput.
Do not wait for the long-running operation to finish.
Total Number of system (SAP HANA) host in this deployment (currently max 3 nodes can be configured).
Name of the ANF capacity pool.
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-".
Replication Schedule for shared volume.
Capacity (in GiB) for shared volumes. If not provided size will automatically be calculated.
ResourceId of the shared source volume.
Throughput in MiB/s for shared volumes. If not provided size will automatically be calculated.
Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume.
Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume.
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.
The delegated Subnet name.
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.
Resource tags. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The ARM Id or name of the vnet for the volumes.
List of volumes from group Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Availability Zone Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 myvolumegroupnameOptional Parameters
The name of the NetApp account.
The name of the volumeGroup.
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.
Do not wait for the long-running operation to finish.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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-groupExamples
Get a list of ANF volume groups
az netappfiles volume-group list -g mygroup --account-name myaccountnameRequired Parameters
The name of the NetApp account.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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 myvolumegroupnameOptional Parameters
The name of the NetApp account.
The name of the volumeGroup.
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 of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
The name of the NetApp account.
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>.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Volume group details Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The name of the volumeGroup.
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.
Do not wait for the long-running operation to finish.
Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Update an object by specifying a property path and value to set. Example: --set property1.property2=.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
List of volumes from group Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
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
The name of the NetApp account.
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
The name of the volumeGroup.
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.
Polling interval in seconds.
Name of resource group. You can configure the default group using az configure --defaults group=<name>.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for