Snapshot Policies - List Volumes
Get volumes for snapshot policy
Get volumes associated with snapshot policy
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/snapshotPolicies/{snapshotPolicyName}/volumes?api-version=2024-07-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
account
|
path | True |
string |
The name of the NetApp account Regex pattern: |
resource
|
path | True |
string |
The name of the resource group. The name is case insensitive. |
snapshot
|
path | True |
string |
The name of the snapshot policy |
subscription
|
path | True |
string uuid |
The ID of the target subscription. The value must be an UUID. |
api-version
|
query | True |
string |
The API version to use for this operation. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
OK |
|
Other Status Codes |
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
SnapshotPolicies_ListVolumes
Sample request
Sample response
{
"value": [
{
"id": "/subscriptions/D633CC2E-722B-4AE1-B636-BBD9E4C60ED9/resourceGroups/myRG/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"
}
}
]
}
Definitions
Name | Description |
---|---|
avs |
avsDataStore |
Chown |
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. |
cool |
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. |
created |
The type of identity that created the resource. |
Data |
DataProtection |
enable |
Flag indicating whether subvolume operations are enabled on the volume |
Encryption |
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' |
Endpoint |
Indicates whether the local volume is the source or destination for the Volume Replication |
Error |
The resource management error additional info. |
Error |
The error detail. |
Error |
Error response |
Export |
exportPolicy |
export |
Volume Export Policy Rule |
file |
Flag indicating whether file access logs are enabled for the volume, based on active diagnostic settings present on the volume. |
mount |
Mount target properties |
Network |
Network features |
placement |
Application specific parameters for the placement of volumes in the volume group |
remote |
The full path to a volume that is to be migrated into ANF. Required for Migration volumes |
replication |
Replication properties |
Replication |
Schedule |
Security |
The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol |
Service |
serviceLevel |
smb |
smbAccessBasedEnumeration |
smb |
smbNonBrowsable |
snapshot |
Volumes associated with snapshot policy |
system |
Metadata pertaining to creation and last modification of the resource. |
volume |
Volume resource |
volume |
Volume Backup Properties |
volume |
Volume relocation properties |
volume |
Volume Snapshot Properties |
Volume |
Storage to Network Proximity |
avsDataStore
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
DataProtection
Name | Type | Description |
---|---|---|
backup |
Backup |
|
replication |
Replication |
|
snapshot |
Snapshot |
|
volumeRelocation |
VolumeRelocation |
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 |
The error additional info. |
|
code |
string |
The error code. |
details |
The error details. |
|
message |
string |
The error message. |
target |
string |
The error target. |
ErrorResponse
Error response
Name | Type | Description |
---|---|---|
error |
The error object. |
ExportPolicy
exportPolicy
Name | Type | Description |
---|---|---|
rules |
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 | 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 |
ipAddress |
string |
ipAddress |
mountTargetId |
string |
mountTargetId |
smbServerFqdn |
string |
smbServerFQDN |
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 |
Indicates whether the local volume is the source or destination for the Volume Replication |
|
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 |
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
smbAccessBasedEnumeration
Name | Type | Description |
---|---|---|
Disabled |
string |
smbAccessBasedEnumeration share setting is disabled |
Enabled |
string |
smbAccessBasedEnumeration share setting is enabled |
smbNonBrowsable
smbNonBrowsable
Name | Type | Description |
---|---|---|
Disabled |
string |
smbNonBrowsable share setting is disabled |
Enabled |
string |
smbNonBrowsable share setting is enabled |
snapshotPolicyVolumeList
Volumes associated with snapshot policy
Name | Type | Description |
---|---|---|
value |
volume[] |
List of volumes |
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 |
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 |
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 | Disabled |
avsDataStore |
|
properties.backupId |
string |
Backup ID |
|
properties.baremetalTenantId |
string |
Baremetal Tenant ID |
|
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 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 |
|
properties.dataProtection |
DataProtection |
||
properties.dataStoreResourceId |
string[] |
dataStoreResourceId |
|
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 | Basic |
Network features |
|
properties.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 | 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 |
||
properties.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 |
|
properties.isDefaultQuotaEnabled |
boolean |
False |
Specifies if default quota is enabled for the volume. |
properties.isLargeVolume |
boolean |
False |
Is Large 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 |
mountTargets |
||
properties.networkFeatures | Basic |
Network features |
|
properties.networkSiblingSetId |
string |
Network Sibling Set ID |
|
properties.originatingResourceId |
string |
Originating Resource Id |
|
properties.placementRules |
Volume placement rules |
||
properties.protocolTypes |
string[] |
protocolTypes |
|
properties.provisionedAvailabilityZone |
string |
Provisioned Availability Zone |
|
properties.provisioningState |
string |
Azure lifecycle management |
|
properties.proximityPlacementGroup |
string |
Proximity placement group associated with the volume |
|
properties.securityStyle | unix |
The security style of volume, default unix, defaults to ntfs for dual protocol or CIFS protocol |
|
properties.serviceLevel | Premium |
serviceLevel |
|
properties.smbAccessBasedEnumeration |
smbAccessBasedEnumeration |
||
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 |
||
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 |
|
properties.storageToNetworkProximity |
Storage to Network Proximity |
||
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 |
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 |
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 |
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. |