Update-AzNetAppFilesCache
Updates an existing Azure NetApp Files (ANF) Cache.
Syntax
ByFieldsParameterSet (Default)
Update-AzNetAppFilesCache
-ResourceGroupName <String>
-AccountName <String>
-PoolName <String>
-Name <String>
[-Size <Int64>]
[-ProtocolType <String[]>]
[-ExportPolicy <PSNetAppFilesVolumeExportPolicy>]
[-ThroughputMibps <Double>]
[-KeyVaultPrivateEndpointResourceId <String>]
[-CifsChangeNotification <String>]
[-WriteBack <String>]
[-SmbEncryption <String>]
[-SmbAccessBasedEnumeration <String>]
[-SmbNonBrowsable <String>]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByResourceIdParameterSet
Update-AzNetAppFilesCache
-ResourceId <String>
[-Size <Int64>]
[-ProtocolType <String[]>]
[-ExportPolicy <PSNetAppFilesVolumeExportPolicy>]
[-ThroughputMibps <Double>]
[-KeyVaultPrivateEndpointResourceId <String>]
[-CifsChangeNotification <String>]
[-WriteBack <String>]
[-SmbEncryption <String>]
[-SmbAccessBasedEnumeration <String>]
[-SmbNonBrowsable <String>]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
ByObjectParameterSet
Update-AzNetAppFilesCache
-InputObject <PSNetAppFilesCache>
[-Size <Int64>]
[-ProtocolType <String[]>]
[-ExportPolicy <PSNetAppFilesVolumeExportPolicy>]
[-ThroughputMibps <Double>]
[-KeyVaultPrivateEndpointResourceId <String>]
[-CifsChangeNotification <String>]
[-WriteBack <String>]
[-SmbEncryption <String>]
[-SmbAccessBasedEnumeration <String>]
[-SmbNonBrowsable <String>]
[-Tag <Hashtable>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Update-AzNetAppFilesCache cmdlet patches an existing ANF Cache. Only the properties supplied as parameters are modified; all others retain their current values. Use this cmdlet to resize the cache, change protocol types, adjust SMB/export settings, update throughput, toggle CIFS change notifications or writeback, or attach a new KeyVault private endpoint.
Examples
Example 1: Increase cache size and throughput
Update-AzNetAppFilesCache -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfCache" `
-Size (200 * 1024 * 1024 * 1024) -ThroughputMibps 128
Resizes the cache to 200 GiB and raises throughput to 128 MiB/s.
Update-AzNetAppFilesCache -ResourceGroupName "MyRG" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfCache" `
-CifsChangeNotification "Enabled" -Tag @{Owner = "ai-team"; Env = "prod"}
Enables CIFS change notifications on the cache and replaces the resource tags.
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
-CifsChangeNotification
Whether CIFS change notifications are 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
-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
The cache object to update
ByObjectParameterSet
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-KeyVaultPrivateEndpointResourceId
Resource ID of the private endpoint for 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
-Name
The name of the ANF cache
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False Aliases: CacheName
Parameter sets
ByFieldsParameterSet
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
-ProtocolType
Set of supported protocol types
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
-ResourceId
The resource id of the ANF cache
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
ByResourceIdParameterSet
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: True Value from remaining arguments: False
-Size
Maximum storage quota for the file system in bytes
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
-SmbAccessBasedEnumeration
Enables access-based enumeration for SMB shares
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
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
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
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
