New-AzNetAppFilesCache
Creates a new Azure NetApp Files (ANF) Cache (FlexCache) in a Capacity Pool.
Syntax
ByFieldsParameterSet (Default)
New-AzNetAppFilesCache
-ResourceGroupName <String>
-Location <String>
-AccountName <String>
-PoolName <String>
-Name <String>
-FilePath <String>
-Size <Int64>
-CacheSubnetResourceId <String>
-PeeringSubnetResourceId <String>
-EncryptionKeySource <String>
-OriginPeerClusterName <String>
-OriginPeerAddress <String[]>
-OriginPeerVserverName <String>
-OriginPeerVolumeName <String>
[-ProtocolType <String[]>]
[-ExportPolicy <PSNetAppFilesVolumeExportPolicy>]
[-KerberosEnabled <String>]
[-ThroughputMibps <Double>]
[-KeyVaultPrivateEndpointResourceId <String>]
[-Ldap <String>]
[-LdapServerType <String>]
[-CifsChangeNotification <String>]
[-GlobalFileLocking <String>]
[-WriteBack <String>]
[-SmbEncryption <String>]
[-SmbAccessBasedEnumeration <String>]
[-SmbNonBrowsable <String>]
[-Zone <String[]>]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByParentObjectParameterSet
New-AzNetAppFilesCache
-Name <String>
-FilePath <String>
-Size <Int64>
-CacheSubnetResourceId <String>
-PeeringSubnetResourceId <String>
-EncryptionKeySource <String>
-OriginPeerClusterName <String>
-OriginPeerAddress <String[]>
-OriginPeerVserverName <String>
-OriginPeerVolumeName <String>
-PoolObject <PSNetAppFilesPool>
[-ProtocolType <String[]>]
[-ExportPolicy <PSNetAppFilesVolumeExportPolicy>]
[-KerberosEnabled <String>]
[-ThroughputMibps <Double>]
[-KeyVaultPrivateEndpointResourceId <String>]
[-Ldap <String>]
[-LdapServerType <String>]
[-CifsChangeNotification <String>]
[-GlobalFileLocking <String>]
[-WriteBack <String>]
[-SmbEncryption <String>]
[-SmbAccessBasedEnumeration <String>]
[-SmbNonBrowsable <String>]
[-Zone <String[]>]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The New-AzNetAppFilesCache cmdlet creates a FlexCache under an ANF Capacity Pool. A Cache requires a peered on-prem ONTAP origin volume: the origin cluster name, Intercluster LIF addresses, Vserver (SVM) name, and origin volume name must be supplied via the OriginPeer* parameters. The Cache is allocated data IPs from the subnet referenced by CacheSubnetResourceId and uses PeeringSubnetResourceId for Intercluster Interface IP addresses.
After creation, use Get-AzNetAppFilesCachePeeringPassphrase to obtain the cluster and vserver peering commands that must be applied on the external ONTAP origin to complete peering.
Examples
Example 1: Create a Cache backed by an on-prem ONTAP origin
$subsId = (Get-AzContext).Subscription.Id
$cacheSubnet = "/subscriptions/$subsId/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/myanf-vnet/subnets/cache-subnet"
$peeringSubnet = "/subscriptions/$subsId/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/myanf-vnet/subnets/peering-subnet"
New-AzNetAppFilesCache -ResourceGroupName "MyRG" -Location "eastus" `
-AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfCache" `
-FilePath "MyAnfCache" -Size (100 * 1024 * 1024 * 1024) `
-CacheSubnetResourceId $cacheSubnet -PeeringSubnetResourceId $peeringSubnet `
-EncryptionKeySource "Microsoft.NetApp" `
-OriginPeerClusterName "onprem-ontap-cluster" `
-OriginPeerAddress @("10.10.0.10", "10.10.0.11") `
-OriginPeerVserverName "onprem-svm" `
-OriginPeerVolumeName "onprem-origin-vol" `
-ProtocolType @("NFSv3")
Creates a 100 GiB NFSv3 FlexCache whose origin is the onprem-origin-vol volume on the onprem-svm Vserver of the onprem-ontap-cluster cluster.
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
-CacheSubnetResourceId
The Azure Resource URI for a delegated cache subnet that will be used to allocate data IPs
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
-CifsChangeNotification
Whether CIFS change notification is enabled.
Either 'Disabled' or 'Enabled'
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
-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
-EncryptionKeySource
Source of the encryption key.
Either 'Microsoft.NetApp' or 'Microsoft.KeyVault'
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
-ExportPolicy
Export policy for the cache
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
-FilePath
The file path of the cache
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
-GlobalFileLocking
Whether the global file lock is enabled.
Either 'Disabled' or 'Enabled'
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
-KerberosEnabled
Whether Kerberos is enabled for the cache.
Either 'Disabled' or 'Enabled'
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
-KeyVaultPrivateEndpointResourceId
Resource ID of the private endpoint for KeyVault when EncryptionKeySource is 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
-Ldap
Whether LDAP is enabled for the flexcache volume.
Either 'Disabled' or 'Enabled'
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
-LdapServerType
Type of LDAP server.
Either 'ActiveDirectory' or 'OpenLDAP'
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
-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 cache
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: CacheName
Parameter sets
(All)
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-OriginPeerAddress
ONTAP Intercluster LIF IP addresses; one IP address per cluster node
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
-OriginPeerClusterName
ONTAP cluster name of external cluster hosting the origin 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
-OriginPeerVolumeName
External origin volume name associated to this cache
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
-OriginPeerVserverName
External Vserver (SVM) name hosting the origin 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
-PeeringSubnetResourceId
The Azure Resource URI for a delegated subnet that will be used for ANF Intercluster Interface IP addresses
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
-PoolName
The name of the ANF capacity 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 object for the new cache
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
Set of supported protocol types (NFSv3, NFSv4 or SMB)
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
-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
-Size
Maximum storage quota allowed for the file system in bytes (50 GiB to 1 PiB)
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
-SmbAccessBasedEnumeration
Enables access-based enumeration for SMB shares.
Either 'Disabled' or 'Enabled'
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
-SmbEncryption
Enables encryption for in-flight SMB3 data.
Either 'Disabled' or 'Enabled'
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
-SmbNonBrowsable
Enables non-browsable property for SMB shares.
Either 'Disabled' or 'Enabled'
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
-Tag
A hashtable representing resource tags
Parameter properties
Type: Hashtable
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
-ThroughputMibps
Maximum throughput in MiB/s for manual qos cache
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
-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
-WriteBack
Whether writeback is enabled for the cache.
Either 'Disabled' or 'Enabled'
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
-Zone
The availability zones for the cache
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
