Update-AzNetAppFilesVolume
Updates an Azure NetApp Files (ANF) volume according to the optional modifiers provided.
Syntax
Update-AzNetAppFilesVolume
-ResourceGroupName <String>
-Location <String>
-AccountName <String>
-PoolName <String>
-Name <String>
[-UsageThreshold <Int64>]
[-ServiceLevel <String>]
[-ExportPolicy <PSNetAppFilesVolumeExportPolicy>]
[-Backup <PSNetAppFilesVolumeBackupProperties>]
[-ThroughputMibps <Double>]
[-SnapshotPolicyId <String>]
[-IsDefaultQuotaEnabled]
[-DefaultUserQuotaInKiB <Int64>]
[-DefaultGroupQuotaInKiB <Int64>]
[-Tag <Hashtable>]
[-UnixPermission <String>]
[-CoolAccess]
[-CoolnessPeriod <Int32>]
[-CoolAccessRetrievalPolicy <String>]
[-SnapshotDirectoryVisible]
[-SmbAccessBasedEnumeration <String>]
[-SmbNonBrowsable <String>]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzNetAppFilesVolume
-Name <String>
[-UsageThreshold <Int64>]
[-ServiceLevel <String>]
[-ExportPolicy <PSNetAppFilesVolumeExportPolicy>]
[-Backup <PSNetAppFilesVolumeBackupProperties>]
[-ThroughputMibps <Double>]
[-SnapshotPolicyId <String>]
[-IsDefaultQuotaEnabled]
[-DefaultUserQuotaInKiB <Int64>]
[-DefaultGroupQuotaInKiB <Int64>]
[-Tag <Hashtable>]
[-UnixPermission <String>]
[-CoolAccess]
[-CoolnessPeriod <Int32>]
[-CoolAccessRetrievalPolicy <String>]
[-SnapshotDirectoryVisible]
[-SmbAccessBasedEnumeration <String>]
[-SmbNonBrowsable <String>]
-PoolObject <PSNetAppFilesPool>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzNetAppFilesVolume
[-UsageThreshold <Int64>]
[-ServiceLevel <String>]
[-ExportPolicy <PSNetAppFilesVolumeExportPolicy>]
[-Backup <PSNetAppFilesVolumeBackupProperties>]
[-ThroughputMibps <Double>]
[-SnapshotPolicyId <String>]
[-IsDefaultQuotaEnabled]
[-DefaultUserQuotaInKiB <Int64>]
[-DefaultGroupQuotaInKiB <Int64>]
[-Tag <Hashtable>]
[-UnixPermission <String>]
[-CoolAccess]
[-CoolnessPeriod <Int32>]
[-CoolAccessRetrievalPolicy <String>]
[-SnapshotDirectoryVisible]
[-SmbAccessBasedEnumeration <String>]
[-SmbNonBrowsable <String>]
-ResourceId <String>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Update-AzNetAppFilesVolume
[-UsageThreshold <Int64>]
[-ServiceLevel <String>]
[-ExportPolicy <PSNetAppFilesVolumeExportPolicy>]
[-Backup <PSNetAppFilesVolumeBackupProperties>]
[-ThroughputMibps <Double>]
[-SnapshotPolicyId <String>]
[-IsDefaultQuotaEnabled]
[-DefaultUserQuotaInKiB <Int64>]
[-DefaultGroupQuotaInKiB <Int64>]
[-Tag <Hashtable>]
[-UnixPermission <String>]
[-CoolAccess]
[-CoolnessPeriod <Int32>]
[-CoolAccessRetrievalPolicy <String>]
[-SnapshotDirectoryVisible]
[-SmbAccessBasedEnumeration <String>]
[-SmbNonBrowsable <String>]
-InputObject <PSNetAppFilesVolume>
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Update-AzNetAppFilesVolume cmdlet updates an ANF volume.
Examples
Example 1: Update an ANF volume
Update-AzNetAppFilesVolume -ResourceGroupName "MyRG" -Location "westus2" -AccountName "MyAnfAccount" -PoolName "MyAnfPool" -Name "MyAnfVolume" -UsageThreshold Size
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 : 2199023255552
ProvisioningState : Succeeded
SubnetId : /subscriptions/subsId/resourceGroups/MyRG/providers/Microsoft.Network/virtualNetworks/MyRG-vnet/subnets/defaultThis command updates the ANF volume "MyAnfVolume" with the new UsageThreshold size.
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 |
-Backup
A hashtable array which represents the backup object
| Type: | PSNetAppFilesVolumeBackupProperties |
| 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 |
-CoolAccess
Specifies whether Cool Access(tiering) is enabled for the volume (default false).
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Required: | False |
| 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 |
| 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 |
-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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExportPolicy
A hashtable array which represents the export policy
| Type: | PSNetAppFilesVolumeExportPolicy |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InputObject
The volume object to update
| Type: | PSNetAppFilesVolume |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-IsDefaultQuotaEnabled
Specifies if default quota is enabled for the volume
| Type: | SwitchParameter |
| 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 |
-Name
The name of the ANF volume
| Type: | String |
| Aliases: | VolumeName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PoolName
The name of the ANF pool
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PoolObject
The pool object containing the volume to update
| Type: | PSNetAppFilesPool |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ResourceGroupName
The resource group of the ANF account
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ResourceId
The resource id of the ANF volume
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ServiceLevel
The service level of the ANF volume
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SmbAccessBasedEnumeration
Enables access based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SmbNonBrowsable
Enables non browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Required: | False |
| 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 |
| 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 |
-ThroughputMibps
Maximum throughput in Mibps that can be achieved by this volume
| Type: | Nullable<T>[Double] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | 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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UsageThreshold
The maximum storage quota allowed for a file system in bytes
| Type: | Nullable<T>[Int64] |
| 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
Outputs
Related Links
- New-AzNetAppFilesVolume
- Get-AzNetAppFilesVolume
- Remove-AzNetAppFilesVolume
- Restore-AzNetAppFilesVolume
- Set-AzNetAppFilesVolumePool
- Get-AzNetAppFilesVolumeBackupStatus
- Get-AzNetAppFilesVolumeRestoreStatus
- Approve-AzNetAppFilesReplication
- Initialize-AzNetAppFilesReplication
- Resume-AzNetAppFilesReplication
- Remove-AzNetAppFilesReplication
Azure PowerShell
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for