Backups - Get Latest Status

Service:: Azure NetApp Files

API Version:: 2026-03-01

Get the latest status of the backup for a volume

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetApp/netAppAccounts/{accountName}/capacityPools/{poolName}/volumes/{volumeName}/latestBackupStatus/current?api-version=2026-03-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.
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.

Responses

Name	Type	Description
200 OK	BackupStatus	Azure operation completed successfully.
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

Volumes_BackupStatus

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myRG/providers/Microsoft.NetApp/netAppAccounts/account1/capacityPools/pool1/volumes/volume1/latestBackupStatus/current?api-version=2026-03-01

Sample response

Status code:: 200

{
  "errorMessage": "",
  "healthy": true,
  "lastTransferSize": 100000,
  "lastTransferType": "",
  "mirrorState": "Mirrored",
  "relationshipStatus": "Idle",
  "totalTransferBytes": 100000,
  "unhealthyReason": ""
}

Definitions

Name	Description
BackupStatus	Backup status
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
MirrorState	The status of the replication
VolumeBackupRelationshipStatus	Status of the volume backup relationship

BackupStatus

Object

Backup status

Name	Type	Description
errorMessage	string	Displays error message if the backup is in an error state
healthy	boolean	Backup health status
lastTransferSize	integer (int64)	Displays the last transfer size
lastTransferType	string	Displays the last transfer type
mirrorState	MirrorState	The status of the backup
relationshipStatus	VolumeBackupRelationshipStatus	Status of the backup mirror relationship
totalTransferBytes	integer (int64)	Displays the total bytes transferred
transferProgressBytes	integer (int64)	Displays the total number of bytes transferred for the ongoing operation
unhealthyReason	string	Reason for the unhealthy backup relationship

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

MirrorState

Enumeration

The status of the replication

Value	Description
Uninitialized
Mirrored
Broken

VolumeBackupRelationshipStatus

Enumeration

Status of the volume backup relationship

Value	Description
Idle
Transferring
Failed
Unknown