New-AzNetAppFilesVolumeGroup

Reference

Module:: Az.NetAppFiles

Creates a new Azure NetApp Files (ANF) VolumeGroup along with requisite volumes. Creating volume group will create all the volumes specified in request body implicitly. Once volumes are created using volume group, those will be treated as regular volumes thereafter.

Syntax

New-AzNetAppFilesVolumeGroup
   -ResourceGroupName <String>
   -Location <String>
   -AccountName <String>
   -PoolName <String>
   [-Name <String>]
   [-GroupDescription <String>]
   [-ApplicationType <String>]
   -ApplicationIdentifier <String>
   -ProximityPlacementGroup <String>
   -NodeMemory <Int32>
   [-CapacityOverhead <Int32>]
   [-StartingHostId <Int32>]
   [-HostCount <Int32>]
   [-SystemRole <String>]
   [-Prefix <String>]
   [-Vnet <String>]
   [-SubnetId <String>]
   [-DataSize <Int64>]
   [-DataPerformance <Int32>]
   [-LogSize <Int64>]
   [-LogPerformance <Int32>]
   [-SharedSize <Int64>]
   [-SharedPerformance <Int32>]
   [-DataBackupSize <Int64>]
   [-DataBackupPerformance <Int32>]
   [-LogBackupSize <Int64>]
   [-LogBackupPerformance <Int32>]
   [-HannaSystemReplication]
   [-DisasterRecoveryDestination]
   [-BackupProtocolType <String[]>]
   [-ExportPolicy <PSNetAppFilesVolumeExportPolicy>]
   [-GlobalPlacementRule <System.Collections.Generic.IList`1[Microsoft.Azure.Management.NetApp.Models.PlacementKeyValuePairs]>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzNetAppFilesVolumeGroup
   -PoolName <String>
   [-Name <String>]
   [-GroupDescription <String>]
   [-ApplicationType <String>]
   -ApplicationIdentifier <String>
   -ProximityPlacementGroup <String>
   -NodeMemory <Int32>
   [-CapacityOverhead <Int32>]
   [-StartingHostId <Int32>]
   [-HostCount <Int32>]
   [-SystemRole <String>]
   [-Prefix <String>]
   [-Vnet <String>]
   [-SubnetId <String>]
   [-DataSize <Int64>]
   [-DataPerformance <Int32>]
   [-LogSize <Int64>]
   [-LogPerformance <Int32>]
   [-SharedSize <Int64>]
   [-SharedPerformance <Int32>]
   [-DataBackupSize <Int64>]
   [-DataBackupPerformance <Int32>]
   [-LogBackupSize <Int64>]
   [-LogBackupPerformance <Int32>]
   [-HannaSystemReplication]
   [-DisasterRecoveryDestination]
   [-BackupProtocolType <String[]>]
   [-ExportPolicy <PSNetAppFilesVolumeExportPolicy>]
   [-GlobalPlacementRule <System.Collections.Generic.IList`1[Microsoft.Azure.Management.NetApp.Models.PlacementKeyValuePairs]>]
   [-Tag <Hashtable>]
   -AccountObject <PSNetAppFilesAccount>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzNetAppFilesVolumeGroup cmdlet creates an ANF VolumeGroup.

Examples

Example 1

New-AzNetAppFilesVolumeGroup -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolumeGroupName" -Location "westus2"  -GroupDescription "MyAnfVolumeGroup Description" -ApplicationIdentifier "SH1" -ProximityPlacementGroup "MyPPGResourceId" -Vnet "MyAnfVnet" -SystemRole "PRIMARY" -NodeMemory 100

This command creates the new "PRIMARY" ANF VolumeGroup "MyAnfVolumeGroup" within the Account "MyAnfAccount" using the proximityPlacementGroup "MyPPGResourceId", the vnet "MyAnfVnet", and NodeMemory of 100

Parameters

-AccountName

The name of the ANF account

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-AccountObject

The account for the new pool object

Type:	PSNetAppFilesAccount
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-ApplicationIdentifier

Application specific identifier, default SAP System ID SH1

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ApplicationType

Application Type, default SAP-HANA

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-BackupProtocolType

A hashtable array which represents the protocol types for Data Backup/Log Backup volumes default NFSv4.1, for other volume types nfsv4.1 will be used.

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CapacityOverhead

Capacity overhead %, Additional quota reserved for snapshots during best-practice sizing of data volume, default 50

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DataBackupPerformance

Specify throughput in MiB/s. If ommited DataBackupPerformance will be autocalculated or specify an integer value representing throughput.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DataBackupSize

Specify capacity (in GiB). If ommited DataSize will be autocalculated or specify an integer value representing size.

Type:	Nullable<T>[Int64]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DataPerformance

Specify throughput in MiB/s. If ommited DataPerformance will be autocalculated or specify and integer value representing throughput.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DataSize

Specify capacity (in GiB). If ommited DataSize will be autocalculated or specify an integer value representing size.

Type:	Nullable<T>[Int64]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-DisasterRecoveryDestination

Create volume groups for DR, using ANF Cross Region Replication, scenario allows volumes to be replicated between different regions using SnapMirror

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExportPolicy

A hashtable array which represents the export policy, which should be common to all volumes.

Type:	PSNetAppFilesVolumeExportPolicy
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-GlobalPlacementRule

Application specific placement rules for the volume group

Type:	IList<T>[PlacementKeyValuePairs]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-GroupDescription

Group Description, example Primary for SH1-{HostId} (default)

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HannaSystemReplication

HANA System Replication (HSR): Replication between the same SID instance on hosts in the same region, or differerent regions. This could be Scale-Up or Scale-Out configurations.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HostCount

Number of SAP HANA hosts. Total Number of SAP HANA hosts for single or multiplehost scenarios. Defaults to 50 for single-host setups. Currently at max 3 nodes can be configured.

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Location

The location of the resource

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-LogBackupPerformance

Specify throughput in MiB/s. If ommited LogBackupPerformance will be autocalculated or specify an integer value representing throughput.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LogBackupSize

Specify capacity (in GiB). If ommited DataSize will be autocalculated or specify an integer value representing size.

Type:	Nullable<T>[Int64]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LogPerformance

Specify throughput in MiB/s. If ommited LogPerformance will be autocalculated or specify and integer value representing throughput.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LogSize

Specify capacity (in GiB). If ommited LogSize will be autocalculated or specify an integer value representing size.

Type:	Nullable<T>[Int64]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Name

The name of the ANF VolumeGroup, example SAP-HANA-SH00001. Defaults to SAP-HANA-{HostId}, where the {HostId} pattern in the name will be replaced by a 5 digit host ID that begins at 1 for the Single-host and counts up for the subsequent Multiple-host, host

Type:	String
Aliases:	VolumeGroupName
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-NodeMemory

SAP node memory (GiB), Memory on SAP compute host

Type:	Int32
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-PoolName

Default capacity pool for volumes, use a manual QoS type capacity pool

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-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 empty and HA it will be "HA - "

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProximityPlacementGroup

Default proximity placement group, for data, log, and if present the shared volume, in all volume groups. Specifies that the data, log, and shared volumes are to be created close to the VMs

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

The resource group of the ANF VolumeGroup

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SharedPerformance

Specify throughput in MiB/s. If ommited SharedPerformance will be autocalculated or specify and integer value representing throughput.

Type:	Nullable<T>[Int32]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SharedSize

Specify capacity (in GiB). If ommited SharedSize will be autocalculated or specify an integer value representing size.

Type:	Nullable<T>[Int64]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-StartingHostId

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

Type:	Int32
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SubnetId

Default delegated subnet, for all volume groups

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-SystemRole

The role of the system, Primary SAP system, HANA System Replication(HSR) or DataRecovery destination for ANF Cross-region replication (CRR)

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tag

A hashtable which represents resource tags

Type:	Hashtable
Aliases:	Tags
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Vnet

Default virtual network, for all volume groups

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PSNetAppFilesAccount

Outputs

PSNetAppFilesVolumeGroupDetail

Share via

New-AzNetAppFilesVolumeGroup

Syntax

Description

Examples

Example 1

Parameters

-AccountName

-AccountObject

-ApplicationIdentifier

-ApplicationType

-BackupProtocolType

-CapacityOverhead

-Confirm

-DataBackupPerformance

-DataBackupSize

-DataPerformance

-DataSize

-DefaultProfile

-DisasterRecoveryDestination

-ExportPolicy

-GlobalPlacementRule

-GroupDescription

-HannaSystemReplication

-HostCount

-Location

-LogBackupPerformance

-LogBackupSize

-LogPerformance

-LogSize

-Name

-NodeMemory

-PoolName

-Prefix

-ProximityPlacementGroup

-ResourceGroupName

-SharedPerformance

-SharedSize

-StartingHostId

-SubnetId

-SystemRole

-Tag

-Vnet

-WhatIf

Inputs

Outputs

Related Links

Additional resources