Volumes - Update

Reference

Service:: Azure NetApp Files

API Version:: 2024-07-01

Update a volume
Patch the specified volume

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}?api-version=2024-07-01

URI Parameters

Name	In	Required	Type	Description
accountName	path	True	string	The name of the NetApp account Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$`
poolName	path	True	string	The name of the capacity pool Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$`
resourceGroupName	path	True	string	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string uuid	The ID of the target subscription. The value must be an UUID.
volumeName	path	True	string	The name of the volume Regex pattern: `^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$`
api-version	query	True	string	The API version to use for this operation.

Request Body

Name	Type	Description
location	string	Resource location
properties.coolAccess	boolean	Specifies whether Cool Access(tiering) is enabled for the volume.
properties.coolAccessRetrievalPolicy	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.
properties.coolnessPeriod	integer	Specifies the number of days after which data that is not accessed by clients will be tiered.
properties.dataProtection	volumePatchProperties.DataProtection	DataProtection DataProtection type volumes include an object containing details of the replication
properties.defaultGroupQuotaInKiBs	integer	Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
properties.defaultUserQuotaInKiBs	integer	Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
properties.exportPolicy	volumePatchProperties.ExportPolicy	exportPolicy Set of export policy rules
properties.isDefaultQuotaEnabled	boolean	Specifies if default quota is enabled for the volume.
properties.protocolTypes	string[]	protocolTypes Set of protocol types, default NFSv3, CIFS for SMB protocol
properties.serviceLevel	ServiceLevel	serviceLevel The service level of the file system
properties.smbAccessBasedEnumeration	smbAccessBasedEnumeration	smbAccessBasedEnumeration Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
properties.smbNonBrowsable	smbNonBrowsable	smbNonBrowsable Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
properties.snapshotDirectoryVisible	boolean	If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots.
properties.throughputMibps	number	Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume
properties.unixPermissions	string	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.
properties.usageThreshold	integer	usageThreshold Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.
tags	object	Resource tags

Responses

Name	Type	Description
200 OK	volume	OK
202 Accepted		Accepted -- Create or update request accepted; operation will complete asynchronously
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Volumes_Update

Sample request

PATCH https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1?api-version=2024-07-01

{}


import com.azure.resourcemanager.netapp.models.Volume;

/**
 * Samples for Volumes Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Update.json
     */
    /**
     * Sample code: Volumes_Update.
     * 
     * @param manager Entry point to NetAppFilesManager.
     */
    public static void volumesUpdate(com.azure.resourcemanager.netapp.NetAppFilesManager manager) {
        Volume resource = manager.volumes()
            .getWithResponse("myRG", "account1", "pool1", "volume1", com.azure.core.util.Context.NONE).getValue();
        resource.update().apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

package armnetapp_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/netapp/armnetapp/v7"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/366aaa13cdd218b9adac716680e49473673410c8/specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Update.json
func ExampleVolumesClient_BeginUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armnetapp.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewVolumesClient().BeginUpdate(ctx, "myRG", "account1", "pool1", "volume1", armnetapp.VolumePatch{}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Volume = armnetapp.Volume{
	// 	Name: to.Ptr("account1/pool1/volume1"),
	// 	Type: to.Ptr("Microsoft.NetApp/netAppAccounts/capacityPools/volumes"),
	// 	ID: to.Ptr("/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armnetapp.VolumeProperties{
	// 		CreationToken: to.Ptr("some-amazing-filepath"),
	// 		DataProtection: &armnetapp.VolumePropertiesDataProtection{
	// 			Snapshot: &armnetapp.VolumeSnapshotProperties{
	// 				SnapshotPolicyID: to.Ptr("/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRP/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1"),
	// 			},
	// 		},
	// 		FileSystemID: to.Ptr("9760acf5-4638-11e7-9bdb-020073ca7778"),
	// 		NetworkFeatures: to.Ptr(armnetapp.NetworkFeaturesStandard),
	// 		NetworkSiblingSetID: to.Ptr("0f434a03-ce0b-4935-81af-d98652ffb1c4"),
	// 		ProvisioningState: to.Ptr("Succeeded"),
	// 		ServiceLevel: to.Ptr(armnetapp.ServiceLevelPremium),
	// 		StorageToNetworkProximity: to.Ptr(armnetapp.VolumeStorageToNetworkProximityT2),
	// 		SubnetID: to.Ptr("/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3"),
	// 		ThroughputMibps: to.Ptr[float32](128),
	// 		UsageThreshold: to.Ptr[int64](107374182400),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

const { NetAppManagementClient } = require("@azure/arm-netapp");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Patch the specified volume
 *
 * @summary Patch the specified volume
 * x-ms-original-file: specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Update.json
 */
async function volumesUpdate() {
  const subscriptionId =
    process.env["NETAPP_SUBSCRIPTION_ID"] || "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9";
  const resourceGroupName = process.env["NETAPP_RESOURCE_GROUP"] || "myRG";
  const accountName = "account1";
  const poolName = "pool1";
  const volumeName = "volume1";
  const body = {};
  const credential = new DefaultAzureCredential();
  const client = new NetAppManagementClient(credential, subscriptionId);
  const result = await client.volumes.beginUpdateAndWait(
    resourceGroupName,
    accountName,
    poolName,
    volumeName,
    body,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

using Azure;
using Azure.ResourceManager;
using System;
using System.Net;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.NetApp.Models;
using Azure.ResourceManager.NetApp;

// Generated from example definition: specification/netapp/resource-manager/Microsoft.NetApp/stable/2024-07-01/examples/Volumes_Update.json
// this example is just showing the usage of "Volumes_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this NetAppVolumeResource created on azure
// for more information of creating NetAppVolumeResource, please refer to the document of NetAppVolumeResource
string subscriptionId = "D633CC2E-722B-4AE1-B636-BBD9E4C60ED9";
string resourceGroupName = "myRG";
string accountName = "account1";
string poolName = "pool1";
string volumeName = "volume1";
ResourceIdentifier netAppVolumeResourceId = NetAppVolumeResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, accountName, poolName, volumeName);
NetAppVolumeResource netAppVolume = client.GetNetAppVolumeResource(netAppVolumeResourceId);

// invoke the operation
NetAppVolumePatch patch = new NetAppVolumePatch(new AzureLocation("placeholder"));
ArmOperation<NetAppVolumeResource> lro = await netAppVolume.UpdateAsync(WaitUntil.Completed, patch);
NetAppVolumeResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
NetAppVolumeData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/subscriptionId/resourceGroups/resourceGroup/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1",
  "name": "account1/pool1/volume1",
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes",
  "location": "eastus",
  "properties": {
    "fileSystemId": "9760acf5-4638-11e7-9bdb-020073ca7778",
    "creationToken": "some-amazing-filepath",
    "usageThreshold": 107374182400,
    "serviceLevel": "Premium",
    "provisioningState": "Succeeded",
    "throughputMibps": 128,
    "subnetId": "/subscriptions/9760acf5-4638-11e7-9bdb-020073ca7778/resourceGroups/myRP/providers/Microsoft.Network/virtualNetworks/testvnet3/subnets/testsubnet3",
    "networkFeatures": "Standard",
    "networkSiblingSetId": "0f434a03-ce0b-4935-81af-d98652ffb1c4",
    "storageToNetworkProximity": "T2",
    "dataProtection": {
      "snapshot": {
        "snapshotPolicyId": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRP/providers/Microsoft.NetApp/netAppAccounts/account1/snapshotPolicies/snapshotPolicy1"
      }
    }
  }
}

Status code:: 202

Location: https://management.azure.com/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2024-07-01&operationResultResponseType=Location

Definitions

Name	Description
avsDataStore	avsDataStore
ChownMode	This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.
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.
createdByType	The type of identity that created the resource.
DataProtection	DataProtection
enableSubvolumes	Flag indicating whether subvolume operations are enabled on the volume
EncryptionKeySource	Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'
EndpointType	Indicates whether the local volume is the source or destination for the Volume Replication
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExportPolicy	exportPolicy
exportPolicyRule	Volume Export Policy Rule
fileAccessLogs	Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.
mountTargetProperties	Mount target properties
NetworkFeatures	Network features
placementKeyValuePairs	Application specific parameters for the placement of volumes in the volume group
remotePath	The full path to a volume that is to be migrated into ANF. Required for Migration volumes
replicationObject	Replication properties
ReplicationSchedule	Schedule
SecurityStyle	The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol
ServiceLevel	serviceLevel
smbAccessBasedEnumeration	smbAccessBasedEnumeration
smbNonBrowsable	smbNonBrowsable
systemData	Metadata pertaining to creation and last modification of the resource.
volume	Volume resource
volumeBackupProperties	Volume Backup Properties
volumePatch	Volume patch resource
volumePatch.volumePatchProperties.DataProtection	DataProtection
volumePatch.volumePatchProperties.ExportPolicy	exportPolicy
volumePatchProperties.DataProtection	DataProtection
volumePatchProperties.ExportPolicy	exportPolicy
volumeRelocationProperties	Volume relocation properties
volumeSnapshotProperties	Volume Snapshot Properties
VolumeStorageToNetworkProximity	Storage to Network Proximity

avsDataStore

Name	Type	Description
Disabled	string	avsDataStore is disabled
Enabled	string	avsDataStore is enabled

ChownMode

This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.

Name	Type	Description
Restricted	string
Unrestricted	string

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.

Name	Type	Description
Default	string
Never	string
OnRead	string

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DataProtection

Name	Type	Description
backup	volumeBackupProperties	Backup Backup Properties
replication	replicationObject	Replication Replication properties
snapshot	volumeSnapshotProperties	Snapshot Snapshot properties.
volumeRelocation	volumeRelocationProperties	VolumeRelocation VolumeRelocation properties

enableSubvolumes

Flag indicating whether subvolume operations are enabled on the volume

Name	Type	Description
Disabled	string	subvolumes are not enabled
Enabled	string	subvolumes are enabled

EncryptionKeySource

Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'

Name	Type	Description
Microsoft.KeyVault	string	Customer-managed key encryption
Microsoft.NetApp	string	Microsoft-managed key encryption

EndpointType

Indicates whether the local volume is the source or destination for the Volume Replication

Name	Type	Description
dst	string
src	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExportPolicy

exportPolicy

Name	Type	Description
rules	exportPolicyRule[]	Export policy rule Export policy rule

exportPolicyRule

Volume Export Policy Rule

Name	Type	Default value	Description
allowedClients	string		Client ingress specification as comma separated string with IPv4 CIDRs, IPv4 host addresses and host names
chownMode	ChownMode	Restricted	This parameter specifies who is authorized to change the ownership of a file. restricted - Only root user can change the ownership of the file. unrestricted - Non-root users can change ownership of files that they own.
cifs	boolean		Allows CIFS protocol
hasRootAccess	boolean	True	Has root access to volume
kerberos5ReadOnly	boolean	False	Kerberos5 Read only access. To be use with swagger version 2020-05-01 or later
kerberos5ReadWrite	boolean	False	Kerberos5 Read and write access. To be use with swagger version 2020-05-01 or later
kerberos5iReadOnly	boolean	False	Kerberos5i Read only access. To be use with swagger version 2020-05-01 or later
kerberos5iReadWrite	boolean	False	Kerberos5i Read and write access. To be use with swagger version 2020-05-01 or later
kerberos5pReadOnly	boolean	False	Kerberos5p Read only access. To be use with swagger version 2020-05-01 or later
kerberos5pReadWrite	boolean	False	Kerberos5p Read and write access. To be use with swagger version 2020-05-01 or later
nfsv3	boolean		Allows NFSv3 protocol. Enable only for NFSv3 type volumes
nfsv41	boolean		Allows NFSv4.1 protocol. Enable only for NFSv4.1 type volumes
ruleIndex	integer		Order index
unixReadOnly	boolean		Read only access
unixReadWrite	boolean		Read and write access

fileAccessLogs

Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.

Name	Type	Description
Disabled	string	fileAccessLogs are not enabled
Enabled	string	fileAccessLogs are enabled

mountTargetProperties

Mount target properties

Name	Type	Description
fileSystemId	string	fileSystemId UUID v4 used to identify the MountTarget
ipAddress	string	ipAddress The mount target's IPv4 address
mountTargetId	string	mountTargetId UUID v4 used to identify the MountTarget
smbServerFqdn	string	smbServerFQDN The SMB server's Fully Qualified Domain Name, FQDN

NetworkFeatures

Network features

Name	Type	Description
Basic	string	Basic network features.
Basic_Standard	string	Updating from Basic to Standard network features.
Standard	string	Standard network features.
Standard_Basic	string	Updating from Standard to Basic network features.

placementKeyValuePairs

Application specific parameters for the placement of volumes in the volume group

Name	Type	Description
key	string	Key for an application specific parameter for the placement of volumes in the volume group
value	string	Value for an application specific parameter for the placement of volumes in the volume group

remotePath

The full path to a volume that is to be migrated into ANF. Required for Migration volumes

Name	Type	Description
externalHostName	string	The Path to a ONTAP Host
serverName	string	The name of a server on the ONTAP Host
volumeName	string	The name of a volume on the server

replicationObject

Replication properties

Name	Type	Description
endpointType	EndpointType	Indicates whether the local volume is the source or destination for the Volume Replication
remotePath	remotePath	The full path to a volume that is to be migrated into ANF. Required for Migration volumes
remoteVolumeRegion	string	The remote region for the other end of the Volume Replication.
remoteVolumeResourceId	string	The resource ID of the remote volume. Required for cross region and cross zone replication
replicationId	string	Id
replicationSchedule	ReplicationSchedule	Schedule

ReplicationSchedule

Schedule

Name	Type	Description
_10minutely	string
daily	string
hourly	string

SecurityStyle

The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol

Name	Type	Description
ntfs	string
unix	string

ServiceLevel

serviceLevel

Name	Type	Description
Premium	string	Premium service level
Standard	string	Standard service level
StandardZRS	string	Zone redundant storage service level
Ultra	string	Ultra service level

smbAccessBasedEnumeration

Name	Type	Description
Disabled	string	smbAccessBasedEnumeration share setting is disabled
Enabled	string	smbAccessBasedEnumeration share setting is enabled

smbNonBrowsable

Name	Type	Description
Disabled	string	smbNonBrowsable share setting is disabled
Enabled	string	smbNonBrowsable share setting is enabled

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

volume

Volume resource

Name	Type	Default value	Description
etag	string		A unique read-only string that changes whenever the resource is updated.
id	string		Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string		The geo-location where the resource lives
name	string		The name of the resource
properties.actualThroughputMibps	number		Actual throughput in MiB/s for auto qosType volumes calculated based on size and serviceLevel
properties.avsDataStore	avsDataStore	Disabled	avsDataStore Specifies whether the volume is enabled for Azure VMware Solution (AVS) datastore purpose
properties.backupId	string		Backup ID Resource identifier used to identify the Backup.
properties.baremetalTenantId	string		Baremetal Tenant ID Unique Baremetal Tenant Identifier.
properties.capacityPoolResourceId	string		Pool Resource Id used in case of creating a volume through volume group
properties.cloneProgress	integer		When a volume is being restored from another volume's snapshot, will show the percentage completion of this cloning process. When this value is empty/null there is no cloning process currently happening on this volume. This value will update every 5 minutes during cloning.
properties.coolAccess	boolean	False	Specifies whether Cool Access(tiering) is enabled for the volume.
properties.coolAccessRetrievalPolicy	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.
properties.coolnessPeriod	integer		Specifies the number of days after which data that is not accessed by clients will be tiered.
properties.creationToken	string		Creation Token or File Path A unique file path for the volume. Used when creating mount targets
properties.dataProtection	DataProtection		DataProtection DataProtection type volumes include an object containing details of the replication
properties.dataStoreResourceId	string[]		dataStoreResourceId Data store resource unique identifier
properties.defaultGroupQuotaInKiBs	integer	0	Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
properties.defaultUserQuotaInKiBs	integer	0	Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
properties.deleteBaseSnapshot	boolean		If enabled (true) the snapshot the volume was created from will be automatically deleted after the volume create operation has finished. Defaults to false
properties.effectiveNetworkFeatures	NetworkFeatures	Basic	Network features The effective value of the network features type available to the volume, or current effective state of update.
properties.enableSubvolumes	enableSubvolumes	Disabled	Flag indicating whether subvolume operations are enabled on the volume
properties.encrypted	boolean		Specifies if the volume is encrypted or not. Only available on volumes created or updated after 2022-01-01.
properties.encryptionKeySource	EncryptionKeySource	Microsoft.NetApp	Source of key used to encrypt data in volume. Applicable if NetApp account has encryption.keySource = 'Microsoft.KeyVault'. Possible values (case-insensitive) are: 'Microsoft.NetApp, Microsoft.KeyVault'
properties.exportPolicy	ExportPolicy		exportPolicy Set of export policy rules
properties.fileAccessLogs	fileAccessLogs	Disabled	Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume.
properties.fileSystemId	string		FileSystem ID Unique FileSystem Identifier.
properties.isDefaultQuotaEnabled	boolean	False	Specifies if default quota is enabled for the volume.
properties.isLargeVolume	boolean	False	Is Large Volume Specifies whether volume is a Large Volume or Regular Volume.
properties.isRestoring	boolean		Restoring
properties.kerberosEnabled	boolean	False	Describe if a volume is KerberosEnabled. To be use with swagger version 2020-05-01 or later
properties.keyVaultPrivateEndpointResourceId	string		The resource ID of private endpoint for KeyVault. It must reside in the same VNET as the volume. Only applicable if encryptionKeySource = 'Microsoft.KeyVault'.
properties.ldapEnabled	boolean	False	Specifies whether LDAP is enabled or not for a given NFS volume.
properties.maximumNumberOfFiles	integer		Maximum number of files allowed. Needs a service request in order to be changed. Only allowed to be changed if volume quota is more than 4TiB.
properties.mountTargets	mountTargetProperties[]		mountTargets List of mount targets
properties.networkFeatures	NetworkFeatures	Basic	Network features The original value of the network features type available to the volume at the time it was created.
properties.networkSiblingSetId	string		Network Sibling Set ID Network Sibling Set ID for the the group of volumes sharing networking resources.
properties.originatingResourceId	string		Originating Resource Id Id of the snapshot or backup that the volume is restored from.
properties.placementRules	placementKeyValuePairs[]		Volume placement rules Application specific placement rules for the particular volume
properties.protocolTypes	string[]		protocolTypes Set of protocol types, default NFSv3, CIFS for SMB protocol
properties.provisionedAvailabilityZone	string		Provisioned Availability Zone The availability zone where the volume is provisioned. This refers to the logical availability zone where the volume resides.
properties.provisioningState	string		Azure lifecycle management
properties.proximityPlacementGroup	string		Proximity placement group associated with the volume
properties.securityStyle	SecurityStyle	unix	The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol
properties.serviceLevel	ServiceLevel	Premium	serviceLevel The service level of the file system
properties.smbAccessBasedEnumeration	smbAccessBasedEnumeration		smbAccessBasedEnumeration Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
properties.smbContinuouslyAvailable	boolean	False	Enables continuously available share property for smb volume. Only applicable for SMB volume
properties.smbEncryption	boolean	False	Enables encryption for in-flight smb3 data. Only applicable for SMB/DualProtocol volume. To be used with swagger version 2020-08-01 or later
properties.smbNonBrowsable	smbNonBrowsable		smbNonBrowsable Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
properties.snapshotDirectoryVisible	boolean	True	If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots (defaults to true).
properties.snapshotId	string		Snapshot ID Resource identifier used to identify the Snapshot.
properties.storageToNetworkProximity	VolumeStorageToNetworkProximity		Storage to Network Proximity Provides storage to network proximity information for the volume.
properties.subnetId	string		The Azure Resource URI for a delegated subnet. Must have the delegation Microsoft.NetApp/volumes
properties.t2Network	string		T2 network information
properties.throughputMibps	number		Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume
properties.unixPermissions	string		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.
properties.usageThreshold	integer	0	usageThreshold Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.
properties.volumeGroupName	string		Volume Group Name
properties.volumeSpecName	string		Volume spec name is the application specific designation or identifier for the particular volume in a volume group for e.g. data, log
properties.volumeType	string		What type of volume is this. For destination volumes in Cross Region Replication, set type to DataProtection
systemData	systemData		Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object		Resource tags.
type	string		The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
zones	string[]		Availability Zone

volumeBackupProperties

Volume Backup Properties

Name	Type	Description
backupPolicyId	string	Backup Policy Resource ID
backupVaultId	string	Backup Vault Resource ID
policyEnforced	boolean	Policy Enforced

volumePatch

Volume patch resource

Name	Type	Default value	Description
id	string		Resource Id
location	string		Resource location
name	string		Resource name
properties.coolAccess	boolean		Specifies whether Cool Access(tiering) is enabled for the volume.
properties.coolAccessRetrievalPolicy	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.
properties.coolnessPeriod	integer		Specifies the number of days after which data that is not accessed by clients will be tiered.
properties.dataProtection	volumePatchProperties.DataProtection		DataProtection DataProtection type volumes include an object containing details of the replication
properties.defaultGroupQuotaInKiBs	integer	0	Default group quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies.
properties.defaultUserQuotaInKiBs	integer	0	Default user quota for volume in KiBs. If isDefaultQuotaEnabled is set, the minimum value of 4 KiBs applies .
properties.exportPolicy	volumePatchProperties.ExportPolicy		exportPolicy Set of export policy rules
properties.isDefaultQuotaEnabled	boolean	False	Specifies if default quota is enabled for the volume.
properties.protocolTypes	string[]		protocolTypes Set of protocol types, default NFSv3, CIFS for SMB protocol
properties.serviceLevel	ServiceLevel	Premium	serviceLevel The service level of the file system
properties.smbAccessBasedEnumeration	smbAccessBasedEnumeration		smbAccessBasedEnumeration Enables access-based enumeration share property for SMB Shares. Only applicable for SMB/DualProtocol volume
properties.smbNonBrowsable	smbNonBrowsable		smbNonBrowsable Enables non-browsable property for SMB Shares. Only applicable for SMB/DualProtocol volume
properties.snapshotDirectoryVisible	boolean		If enabled (true) the volume will contain a read-only snapshot directory which provides access to each of the volume's snapshots.
properties.throughputMibps	number		Maximum throughput in MiB/s that can be achieved by this volume and this will be accepted as input only for manual qosType volume
properties.unixPermissions	string		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.
properties.usageThreshold	integer	0	usageThreshold Maximum storage quota allowed for a file system in bytes. This is a soft quota used for alerting only. For regular volumes, valid values are in the range 50GiB to 100TiB. For large volumes, valid values are in the range 100TiB to 500TiB, and on an exceptional basis, from to 2400GiB to 2400TiB. Values expressed in bytes as multiples of 1 GiB.
tags	object		Resource tags
type	string		Resource type

volumePatch.volumePatchProperties.DataProtection

DataProtection

Name	Type	Description
backup	volumeBackupProperties	Backup Backup Properties
snapshot	volumeSnapshotProperties	Snapshot Snapshot properties.

volumePatch.volumePatchProperties.ExportPolicy

exportPolicy

Name	Type	Description
rules	exportPolicyRule[]	Export policy rule Export policy rule

volumePatchProperties.DataProtection

DataProtection

Name	Type	Description
backup	volumeBackupProperties	Backup Backup Properties
snapshot	volumeSnapshotProperties	Snapshot Snapshot properties.

volumePatchProperties.ExportPolicy

exportPolicy

Name	Type	Description
rules	exportPolicyRule[]	Export policy rule Export policy rule

volumeRelocationProperties

Volume relocation properties

Name	Type	Description
readyToBeFinalized	boolean	Has relocation finished and is ready to be cleaned up
relocationRequested	boolean	Has relocation been requested for this volume

volumeSnapshotProperties

Volume Snapshot Properties

Name	Type	Description
snapshotPolicyId	string	Snapshot Policy ResourceId

VolumeStorageToNetworkProximity

Storage to Network Proximity

Name	Type	Description
AcrossT2	string	Standard AcrossT2 storage to network connectivity.
Default	string	Basic storage to network connectivity.
T1	string	Standard T1 storage to network connectivity.
T2	string	Standard T2 storage to network connectivity.

Share via

Volumes - Update

URI Parameters

Request Body

Responses

Security

azure_auth

Scopes

Examples

Volumes_Update

Sample request

Sample response

Definitions

avsDataStore

ChownMode

coolAccessRetrievalPolicy

createdByType

DataProtection

enableSubvolumes

EncryptionKeySource

EndpointType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

ExportPolicy

exportPolicyRule

fileAccessLogs

mountTargetProperties

NetworkFeatures

placementKeyValuePairs

remotePath

replicationObject

ReplicationSchedule

SecurityStyle

ServiceLevel

smbAccessBasedEnumeration

smbNonBrowsable

systemData

volume

volumeBackupProperties

volumePatch

volumePatch.volumePatchProperties.DataProtection

volumePatch.volumePatchProperties.ExportPolicy

volumePatchProperties.DataProtection

volumePatchProperties.ExportPolicy

volumeRelocationProperties

volumeSnapshotProperties

VolumeStorageToNetworkProximity

Additional resources