Backup Status - Get

Get the container backup status

POST https://management.azure.com/Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupStatus?api-version=2017-07-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription Id.

azureRegion
path True
  • string

Azure region to hit Api

api-version
query True
  • string

Client Api Version.

Request Body

Name Type Description
poLogicalName
  • string

Protectable Item Logical Name

resourceId
  • string

Entire ARM resource id of the resource

resourceType

Container Type - VM, SQLPaaS, DPM, AzureFileShare...

Responses

Name Type Description
200 OK

OK

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

Get Azure Virtual Machine Backup Status

Sample Request

POST https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.RecoveryServices/locations/southeastasia/backupStatus?api-version=2017-07-01
{
  "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.Compute/VirtualMachines/testVm",
  "resourceType": "VM"
}

Sample Response

{
  "protectionStatus": "Protected",
  "vaultId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testRg/providers/Microsoft.RecoveryServices/Vaults/testVault",
  "fabricName": "Azure",
  "containerName": "iaasvmcontainer;iaasvmcontainerv2;testRg;testVm",
  "protectedItemName": "vm;iaasvmcontainerv2;testRg;testVm",
  "policyName": "myPolicy",
  "errorCode": "Success",
  "errorMessage": "ErrorMessage"
}

Definitions

BackupStatusRequest

BackupStatus request.

BackupStatusResponse

BackupStatus response.

DataSourceType

Type of workload this item represents.

FabricName

Specifies the fabric name - Azure or AD

ProtectionStatus

Backup state of this backup item.

BackupStatusRequest

BackupStatus request.

Name Type Description
poLogicalName
  • string

Protectable Item Logical Name

resourceId
  • string

Entire ARM resource id of the resource

resourceType

Container Type - VM, SQLPaaS, DPM, AzureFileShare...

BackupStatusResponse

BackupStatus response.

Name Type Description
containerName
  • string

Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname.

errorCode
  • string

ErrorCode in case of intent failed

errorMessage
  • string

ErrorMessage in case of intent failed.

fabricName

Specifies the fabric name - Azure or AD

policyName
  • string

Specifies the policy name which is used for protection

protectedItemName
  • string

Specifies the product specific ds name. E.g. vm;iaasvmcontainer;csname;vmname.

protectionStatus

Specifies whether the container is registered or not

registrationStatus
  • string

Container registration status

vaultId
  • string

Specifies the arm resource id of the vault

DataSourceType

Type of workload this item represents.

Name Type Description
AzureFileShare
  • string
AzureSqlDb
  • string
Client
  • string
Exchange
  • string
FileFolder
  • string
GenericDataSource
  • string
Invalid
  • string
SAPAseDatabase
  • string
SAPHanaDatabase
  • string
SQLDB
  • string
SQLDataBase
  • string
Sharepoint
  • string
SystemState
  • string
VM
  • string
VMwareVM
  • string

FabricName

Specifies the fabric name - Azure or AD

Name Type Description
Azure
  • string
Invalid
  • string

ProtectionStatus

Backup state of this backup item.

Name Type Description
Invalid
  • string
NotProtected
  • string
Protected
  • string
Protecting
  • string
ProtectionFailed
  • string