New-AzNetAppFilesVolume

Is this page helpful?

Any additional feedback?

Feedback will be sent to Microsoft: By pressing the submit button, your feedback will be used to improve Microsoft products and services. Privacy policy.

Module:

Az.NetAppFiles

Creates a new Azure NetApp Files (ANF) volume.

Syntax

New-AzNetAppFilesVolume
   -ResourceGroupName <String>
   -Location <String>
   -AccountName <String>
   -PoolName <String>
   -Name <String>
   -UsageThreshold <Int64>
   -SubnetId <String>
   -CreationToken <String>
   [-VolumeType <String>]
   -ServiceLevel <String>
   [-SnapshotId <String>]
   [-ExportPolicy <PSNetAppFilesVolumeExportPolicy>]
   [-ReplicationObject <PSNetAppFilesReplicationObject>]
   [-Snapshot <PSNetAppFilesVolumeSnapshot>]
   [-SnapshotPolicyId <String>]
   [-Backup <PSNetAppFilesVolumeBackupProperties>]
   [-ProtocolType <String[]>]
   [-SnapshotDirectoryVisible]
   [-BackupId <String>]
   [-SecurityStyle <String>]
   [-ThroughputMibps <Double>]
   [-KerberosEnabled]
   [-SmbEncryption]
   [-SmbContinuouslyAvailable]
   [-LdapEnabled]
   [-CoolAccess]
   [-CoolnessPeriod <Int32>]
   [-UnixPermissions <String>]
   [-AvsDataStore <String>]
   [-IsDefaultQuotaEnabled]
   [-DefaultUserQuotaInKiB <Int64>]
   [-DefaultGroupQuotaInKiB <Int64>]
   [-NetworkFeature <String>]
   [-CapacityPoolResourceId <String>]
   [-ProximityPlacementGroup <String>]
   [-VolumeSpecName <String>]
   [-PlacementRule <System.Collections.Generic.IList`1[Microsoft.Azure.Commands.NetAppFiles.Models.PSKeyValuePairs]>]
   [-Tag <Hashtable>]
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

New-AzNetAppFilesVolume
   -Name <String>
   -UsageThreshold <Int64>
   -SubnetId <String>
   -CreationToken <String>
   -ServiceLevel <String>
   [-ExportPolicy <PSNetAppFilesVolumeExportPolicy>]
   [-ReplicationObject <PSNetAppFilesReplicationObject>]
   [-Snapshot <PSNetAppFilesVolumeSnapshot>]
   [-SnapshotPolicyId <String>]
   [-Backup <PSNetAppFilesVolumeBackupProperties>]
   [-ProtocolType <String[]>]
   [-SnapshotDirectoryVisible]
   [-SecurityStyle <String>]
   [-ThroughputMibps <Double>]
   [-KerberosEnabled]
   [-SmbEncryption]
   [-SmbContinuouslyAvailable]
   [-LdapEnabled]
   [-CoolAccess]
   [-CoolnessPeriod <Int32>]
   [-UnixPermissions <String>]
   [-AvsDataStore <String>]
   [-IsDefaultQuotaEnabled]
   [-DefaultUserQuotaInKiB <Int64>]
   [-DefaultGroupQuotaInKiB <Int64>]
   [-NetworkFeature <String>]
   [-CapacityPoolResourceId <String>]
   [-ProximityPlacementGroup <String>]
   [-VolumeSpecName <String>]
   [-PlacementRule <System.Collections.Generic.IList`1[Microsoft.Azure.Commands.NetAppFiles.Models.PSKeyValuePairs]>]
   [-Tag <Hashtable>]
   -PoolObject <PSNetAppFilesPool>
   [-DefaultProfile <IAzureContextContainer>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The New-AzNetAppFilesVolume cmdlet creates an ANF volume.

Examples

Example 1: Create an ANF volume

New-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume" -Location "westus2" -CreationToken "MyAnfVolume" -UsageThreshold 1099511627776 -ServiceLevel "Premium" -SubnetId "/subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyVnetName/subnets/MySubNetName"

Location          : westus2
Id                : /subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.NetApp/netAppAccounts/MyAnfAccount/capacityPools/MyAnfPool/volumes/MyAnfVolume
Name              : MyAnfAccount/MyAnfPool/MyAnfVolume
Type              : Microsoft.NetApp/netAppAccounts/capacityPools/volumes
Tags              :
FileSystemId      : 3e2773a7-2a72-d003-0637-1a8b1fa3eaaf
CreationToken     : MyAnfVolume
ServiceLevel      : Premium
UsageThreshold    : 1099511627776
ProvisioningState : Succeeded
SubnetId          : /subscriptions/f557b96d-2308-4a18-aae1-b8f7e7e70cc7/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyVnetName/subnets/default

This command creates the new ANF volume "MyAnfVolume" within the pool "MyAnfPool".

Parameters

-AccountName

The name of the ANF account

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

-AvsDataStore

Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose (Enabled, Disabled)

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

-Backup

A hashtable array which represents the backup object

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

-BackupId

Backup ID. UUID v4 or resource identifier used to identify the Backup

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

-CapacityPoolResourceId

Pool Resource Id used in case of creating a volume through volume group.

Type:	String
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

-CoolAccess

Specifies whether Cool Access(tiering) is enabled for the volume (default false).

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

-CoolnessPeriod

Specifies the number of days after which data that is not accessed by clients will be tiered (minimum 7, maximum 63).

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

-CreationToken

A unique file path for the volume

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

-DefaultGroupQuotaInKiB

Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.

Type:	Nullable<T>[Int64]
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

-DefaultUserQuotaInKiB

Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.

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

-ExportPolicy

A hashtable array which represents the export policy

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

-IsDefaultQuotaEnabled

Specifies if default quota is enabled for the volume

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

-KerberosEnabled

Describe if a volume is Kerberos Enabled

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

-LdapEnabled

Specifies whether LDAP is enabled or not for a given NFS volume.

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

-Location

The location of the resource

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

-Name

The name of the ANF volume

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

-NetworkFeature

Basic network, or Standard features available to the volume (Basic, Standard).

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

-PlacementRule

Application specific placement rules for the particular volume.

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

-PoolName

The name of the ANF pool

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

-PoolObject

The pool for the new volume object

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

-ProtocolType

A hashtable array which represents the export policy

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

-ProximityPlacementGroup

Proximity placement group associated with the volume.

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

-ReplicationObject

A hashtable array which represents the replication object

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

-ResourceGroupName

The resource group of the ANF account

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

-SecurityStyle

The security style of volume. Possible values include: 'ntfs', 'unix'

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

-ServiceLevel

The service level of the ANF volume

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

-SmbContinuouslyAvailable

Enables continuously available share property for SMB volume. Only applicable for SMB volume.

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

-SmbEncryption

Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume.

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

-Snapshot

A hashtable array which represents the snapshot object

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

-SnapshotDirectoryVisible

If enabled (true) the volume will contain a read-only .snapshot directory which provides access to each of the volume's snapshots (default to true)

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

-SnapshotId

Create volume from a snapshot. UUID v4 or resource identifier used to identify the Snapshot

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

-SnapshotPolicyId

Snapshot Policy ResourceId used to apply a snapshot policy to the volume

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

-SubnetId

The Azure Resource URI for a delegated subnet

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

-Tag

A hashtable which represents resource tags

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

-ThroughputMibps

Maximum throughput in Mibps that can be achieved by this volume

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

-UnixPermissions

UNIX permissions for NFS volume accepted in octal 4 digit format. First digit selects the set user ID(4), set group ID (2) and sticky (1) attributes. Second digit selects permission for the owner of the file: read (4), write (2) and execute (1). Third selects permissions for other users in the same group. the fourth for other users not in the group. 0755 - gives read/write/execute permissions to owner and read/execute to group and other users.

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

-UsageThreshold

The maximum storage quota allowed for a file system in bytes

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

-VolumeSpecName

Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log.

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

-VolumeType

The type of the ANF volume

Type:	String
Position:	Named
Default value:	None
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
Accept pipeline input:	False
Accept wildcard characters:	False

Inputs

PSNetAppFilesPool

Outputs

PSNetAppFilesVolume