New-AzNetAppFilesVolume
Creates a new Azure NetApp Files (ANF) volume.
Syntax
ByFieldsParameterSet (Default)
New-AzNetAppFilesVolume
-ResourceGroupName <String>
-Location <String>
-AccountName <String>
-PoolName <String>
-Name <String>
-UsageThreshold <Int64>
-SubnetId <String>
-CreationToken <String>
-ServiceLevel <String>
[-VolumeType <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>]
[-CoolAccessRetrievalPolicy <String>]
[-CoolAccessTieringPolicy <String>]
[-UnixPermission <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]>]
[-EnableSubvolume]
[-Zone <String[]>]
[-EncryptionKeySource <String>]
[-KeyVaultPrivateEndpointResourceId <String>]
[-DeleteBaseSnapshot]
[-SmbAccessBasedEnumeration <String>]
[-SmbNonBrowsable <String>]
[-IsLargeVolume]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByParentObjectParameterSet
New-AzNetAppFilesVolume
-Name <String>
-UsageThreshold <Int64>
-SubnetId <String>
-CreationToken <String>
-ServiceLevel <String>
-PoolObject <PSNetAppFilesPool>
[-ExportPolicy <PSNetAppFilesVolumeExportPolicy>]
[-ReplicationObject <PSNetAppFilesReplicationObject>]
[-Snapshot <PSNetAppFilesVolumeSnapshot>]
[-SnapshotPolicyId <String>]
[-Backup <PSNetAppFilesVolumeBackupProperties>]
[-ProtocolType <String[]>]
[-SnapshotDirectoryVisible]
[-SecurityStyle <String>]
[-ThroughputMibps <Double>]
[-KerberosEnabled]
[-SmbEncryption]
[-SmbContinuouslyAvailable]
[-LdapEnabled]
[-CoolAccess]
[-CoolnessPeriod <Int32>]
[-CoolAccessRetrievalPolicy <String>]
[-CoolAccessTieringPolicy <String>]
[-UnixPermission <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]>]
[-EnableSubvolume]
[-Zone <String[]>]
[-EncryptionKeySource <String>]
[-KeyVaultPrivateEndpointResourceId <String>]
[-DeleteBaseSnapshot]
[-SmbAccessBasedEnumeration <String>]
[-SmbNonBrowsable <String>]
[-IsLargeVolume]
[-Tag <Hashtable>]
[-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".
Example 2: Create an ANF volume using NFSv4.1 Protocol Type. Note do not use the IP adddress block shown for -AllowedClient. This is an example IPv4 address blocks for use in documentation.
$exportPolicyRule = New-AzNetAppFilesExportPolicyRuleObject -RuleIndex 1 -AllowedClient "192.0.2.0/24" -UnixReadWrite -Nfsv41
New-AzNetAppFilesVolume -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume" -Location "westus2" -CreationToken "MyAnfVolume" -ProtocolType NFSv4.1 -ExportPolicy $exportPolicyRule -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" using NFSv4.1 protocol including the required ExportPolicy.
Parameters
-AccountName
The name of the ANF account
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-AvsDataStore
Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose (Enabled, Disabled)
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Backup
A hashtable array which represents the backup object
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-BackupId
Backup ID. UUID v4 or resource identifier used to identify the Backup
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CapacityPoolResourceId
Pool Resource Id used in case of creating a volume through volume group.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CoolAccess
Specifies whether Cool Access(tiering) is enabled for the volume (default false).
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CoolAccessRetrievalPolicy
CoolAccessRetrievalPolicy determines the data retrieval behavior from the cool tier to standard storage based on the read pattern for cool access enabled volumes. The possible values for this field are:
Default - Data will be pulled from cool tier to standard storage on random reads. This policy is the default.
OnRead - All client-driven data read is pulled from cool tier to standard storage on both sequential and random reads.
Never - No client-driven data is pulled from cool tier to standard storage.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CoolAccessTieringPolicy
CoolAccessTieringPolicy determines which cold data blocks are moved to cool tier. The possible values for this field are:
Auto - Moves cold user data blocks in both the Snapshot copies and the active file system to the cool tier tier. This policy is the default.
SnapshotOnly - Moves user data blocks of the Volume Snapshot copies that are not associated with the active file system to the cool tier.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CoolnessPeriod
Specifies the number of days after which data that is not accessed by clients will be tiered (minimum 7, maximum 63).
Parameter properties
Type: Nullable<T> [ Int32 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-CreationToken
A unique file path for the volume
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultGroupQuotaInKiB
Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
Parameter properties
Type: Nullable<T> [ Int64 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Parameter properties
Type: IAzureContextContainer
Default value: None Supports wildcards: False DontShow: False Aliases: AzContext, AzureRmContext, AzureCredential
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultUserQuotaInKiB
Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
Parameter properties
Type: Nullable<T> [ Int64 ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DeleteBaseSnapshot
If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EnableSubvolume
Flag indicating whether subvolume operations are enabled on the volume (Enabled, Disabled)
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-EncryptionKeySource
Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values are: 'Microsoft.NetApp, Microsoft.KeyVault'
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ExportPolicy
A hashtable array which represents the export policy
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IsDefaultQuotaEnabled
Specifies if default quota is enabled for the volume
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-IsLargeVolume
Specifies whether volume is a Large Volume or Regular Volume. Defaults to false
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KerberosEnabled
Describe if a volume is Kerberos Enabled
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultPrivateEndpointResourceId
The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-LdapEnabled
Specifies whether LDAP is enabled or not for a given NFS volume.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Location
The location of the resource
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Name
The name of the ANF volume
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: VolumeName
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-NetworkFeature
Basic network, or Standard features available to the volume (Basic, Standard).
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PlacementRule
Application specific placement rules for the particular volume.
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PoolName
The name of the ANF pool
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PoolObject
The pool for the new volume object
Parameter properties
Parameter sets
ByParentObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-ProtocolType
A hashtable array which represents the export policy
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ProximityPlacementGroup
Proximity placement group associated with the volume.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ReplicationObject
A hashtable array which represents the replication object
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ResourceGroupName
The resource group of the ANF account
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SecurityStyle
The security style of volume. Possible values include: 'ntfs', 'unix'
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ServiceLevel
The service level of the ANF volume
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SmbAccessBasedEnumeration
Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SmbContinuouslyAvailable
Enables continuously available share property for SMB volume. Only applicable for SMB volume.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SmbEncryption
Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SmbNonBrowsable
Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Snapshot
A hashtable array which represents the snapshot object
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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)
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SnapshotId
Create volume from a snapshot. UUID v4 or resource identifier used to identify the Snapshot
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SnapshotPolicyId
Snapshot Policy ResourceId used to apply a snapshot policy to the volume
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubnetId
The Azure Resource URI for a delegated subnet
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Tag
A hashtable which represents resource tags
Parameter properties
Type: Hashtable
Default value: None Supports wildcards: False DontShow: False Aliases: Tags
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-ThroughputMibps
Maximum throughput in Mibps that can be achieved by this volume
Parameter properties
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UnixPermission
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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: UnixPermissions
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UsageThreshold
The maximum storage quota allowed for a file system in bytes
Parameter properties
Type: Int64
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: 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.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-VolumeType
The type of the ANF volume
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByFieldsParameterSet
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-Zone
A list of Availability Zones
Parameter properties
Type: String [ ]
Default value: None Supports wildcards: False DontShow: False
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
-InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable,
-ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
about_CommonParameters .
Outputs
