Share via


Subvolumes - Update

Patch a subvolume

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

URI Parameters

Name In Required Type Description
accountName
path True

string

pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,127}$

The name of the NetApp account

poolName
path True

string

minLength: 1
maxLength: 64
pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-_]{0,63}$

The name of the capacity pool

resourceGroupName
path True

string

minLength: 1
maxLength: 90

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.

subvolumeName
path True

string

minLength: 1
maxLength: 64
pattern: ^[a-zA-Z][a-zA-Z0-9\-_]{0,63}$

The name of the subvolume.

volumeName
path True

string

minLength: 1
maxLength: 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.

Request Body

Name Type Description
properties.path

string

path to the subvolume

properties.size

integer (int64)

Truncate subvolume to the provided size in bytes

Responses

Name Type Description
200 OK

SubvolumeInfo

Azure operation completed successfully.

202 Accepted

Resource update request accepted.

Headers

  • Azure-AsyncOperation: string
  • Retry-After: integer
Other Status Codes

ErrorResponse

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_Update

Sample request

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1?api-version=2025-09-01

{
  "properties": {
    "path": "/subvolumePath"
  }
}

Sample response

{
  "name": "account1/pool1/volume1/subvolume1",
  "type": "Microsoft.NetApp/netAppAccounts/capacityPools/volumes/subvolume1",
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/subvolumes/subvolume1",
  "properties": {
    "path": "/subvolumePath",
    "size": 0
  }
}
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
createdByType

The type of identity that created the resource.

ErrorAdditionalInfo

The resource management error additional info.

ErrorDetail

The error detail.

ErrorResponse

Error response

SubvolumeInfo

Subvolume Information properties

SubvolumePatchRequest

Subvolume Patch Request properties

systemData

Metadata pertaining to creation and last modification of the resource.

createdByType

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

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.

SubvolumeInfo

Subvolume Information properties

Name Type Description
id

string (arm-id)

Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

name

string

The name of the resource

properties.parentPath

string

parent path to the subvolume

properties.path

string

Path to the subvolume

properties.provisioningState

string

Azure lifecycle management

properties.size

integer (int64)

Truncate subvolume to the provided size in bytes

systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.

type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

SubvolumePatchRequest

Subvolume Patch Request properties

Name Type Description
properties.path

string

path to the subvolume

properties.size

integer (int64)

Truncate subvolume to the provided size in bytes

systemData

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

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 (date-time)

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.