Subvolumes - Get Metadata
Get details of the specified subvolume
POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/subvolumes/{subvolumeName}/getMetadata?api-version=2025-09-01
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
|
account
|
path | True |
string pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$ |
The name of the NetApp account |
|
pool
|
path | True |
string minLength: 1maxLength: 64 pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$ |
The name of the capacity pool |
|
resource
|
path | True |
string minLength: 1maxLength: 90 |
The name of the resource group. The name is case insensitive. |
|
subscription
|
path | True |
string (uuid) |
The ID of the target subscription. The value must be an UUID. |
|
subvolume
|
path | True |
string minLength: 1maxLength: 64 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$ |
The name of the subvolume. |
|
volume
|
path | True |
string minLength: 1maxLength: 64 pattern: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$ |
The name of the volume |
|
api-version
|
query | True |
string minLength: 1 |
The API version to use for this operation. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK |
Azure operation completed successfully. |
|
| 202 Accepted |
Resource operation accepted. Headers
|
|
| Other Status Codes |
An unexpected error response. |
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
Subvolumes_Metadata
Sample request
Sample response
{
"name": "account1/pool1/volume1/subvolume1/metadata",
"type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolumes/metadata",
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1/metadata",
"properties": {
"path": "/pathToSubvol",
"accessedTimeStamp": "2017-08-15T13:23:33Z",
"bytesUsed": 5,
"changedTimeStamp": "2017-08-15T13:23:33Z",
"creationTimeStamp": "2017-08-15T13:23:33Z",
"modifiedTimeStamp": "2017-08-15T13:23:33Z",
"permissions": "777",
"size": 5
}
}
Location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.NetApp/locations/eastus/operationResults/616ee961-4042-4935-b4a0-ed6f4dae0172?api-version=2025-09-01&operationResultResponseType=Location
Definitions
| Name | Description |
|---|---|
|
Error |
The resource management error additional info. |
|
Error |
The error detail. |
|
Error |
Error response |
|
Subvolume |
Result of the post subvolume and action is to get metadata of the subvolume. |
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. |
SubvolumeModel
Result of the post subvolume and action is to get metadata of the subvolume.
| Name | Type | Description |
|---|---|---|
| id |
string |
Resource Id |
| name |
string |
Resource name |
| properties.accessedTimeStamp |
string (date-time) |
Most recent access time and date |
| properties.bytesUsed |
integer (int64) |
Bytes used |
| properties.changedTimeStamp |
string (date-time) |
Most recent change time and date |
| properties.creationTimeStamp |
string (date-time) |
Creation time and date |
| properties.modifiedTimeStamp |
string (date-time) |
Most recent modification time and date |
| properties.parentPath |
string |
Path to the parent subvolume |
| properties.path |
string |
Path to the subvolume |
| properties.permissions |
string |
Permissions of the subvolume |
| properties.provisioningState |
string |
Azure lifecycle management |
| properties.size |
integer (int64) |
Size of subvolume |
| type |
string |
Resource type |