Protected Items - Get
Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}?api-version=2024-10-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}?api-version=2024-10-01&$filter={$filter}
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
container
|
path | True |
string |
Container name associated with the backed up item. |
fabric
|
path | True |
string |
Fabric name associated with the backed up item. |
protected
|
path | True |
string |
Backed up item name whose details are to be fetched. |
resource
|
path | True |
string |
The name of the resource group where the recovery services vault is present. |
subscription
|
path | True |
string |
The subscription Id. |
vault
|
path | True |
string |
The name of the recovery services vault. |
api-version
|
query | True |
string |
Client Api Version. |
$filter
|
query |
string |
OData filter options. |
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
Get Protected Classic Virtual Machine Details |
Get Protected Virtual Machine Details |
Get Protected Classic Virtual Machine Details
Sample request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainer;iaasvm-rg;iaasvm-1/protectedItems/vm;iaasvmcontainer;iaasvm-rg;iaasvm-1?api-version=2024-10-01
Sample response
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainer;iaasvm-rg;iaasvm-1/protectedItems/VM;iaasvmcontainer;iaasvm-rg;iaasvm-1",
"name": "VM;iaasvmcontainer;iaasvm-rg;iaasvm-1",
"type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems",
"properties": {
"friendlyName": "iaasvm-1",
"virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1",
"protectionStatus": "Healthy",
"protectionState": "Protected",
"healthStatus": "Passed",
"lastBackupStatus": "Completed",
"lastBackupTime": "2018-01-22T12:25:32.048723Z",
"protectedItemDataId": "636482643132986882",
"protectedItemType": "Microsoft.ClassicCompute/virtualMachines",
"backupManagementType": "AzureIaasVM",
"workloadType": "VM",
"containerName": "iaasvmcontainer;iaasvm-rg;iaasvm-1",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1",
"policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1",
"lastRecoveryPoint": "2017-11-22T12:25:32.048723Z"
}
}
Get Protected Virtual Machine Details
Sample request
GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;iaasvm-rg;iaasvm-1/protectedItems/vm;iaasvmcontainerv2;iaasvm-rg;iaasvm-1?api-version=2024-10-01
Sample response
{
"id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/IaasVMContainer;iaasvmcontainerv2;iaasvm-rg;iaasvm-1/protectedItems/VM;iaasvmcontainerv2;iaasvm-rg;iaasvm-1",
"name": "VM;iaasvmcontainerv2;iaasvm-rg;iaasvm-1",
"type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectedItems",
"properties": {
"friendlyName": "iaasvm-1",
"virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.Compute/virtualMachines/iaasvm-1",
"protectionStatus": "Healthy",
"protectionState": "Protected",
"healthStatus": "Passed",
"lastBackupStatus": "Completed",
"lastBackupTime": "2018-01-22T12:25:32.048723Z",
"protectedItemDataId": "636482643132986882",
"protectedItemType": "Microsoft.Compute/virtualMachines",
"backupManagementType": "AzureIaasVM",
"workloadType": "VM",
"containerName": "iaasvmcontainerv2;iaasvm-rg;iaasvm-1",
"sourceResourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.Compute/virtualMachines/iaasvm-1",
"policyId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupPolicies/testPolicy1",
"lastRecoveryPoint": "2017-11-22T12:25:32.048723Z"
}
}
Definitions
Name | Description |
---|---|
Azure |
Azure File Share workload-specific backup item. |
Azure |
Additional information about Azure File Share backup item. |
Azure |
IaaS VM workload-specific backup item representing the Classic Compute VM. |
Azure |
IaaS VM workload-specific backup item representing the Azure Resource Manager VM. |
Azure |
Azure IaaS VM workload-specific Health Details. |
Azure |
IaaS VM workload-specific backup item. |
Azure |
Additional information on Azure IaaS VM specific backup item. |
Azure |
Azure SQL workload-specific backup item. |
Azure |
Additional information on Azure Sql specific protected item. |
Azure |
Azure VM workload-specific protected item. |
Azure |
Additional information on Azure Workload for SQL specific backup item. |
Azure |
Azure VM workload-specific protected item representing SAP ASE Database. |
Azure |
Azure VM workload-specific protected item representing SAP HANA Database. |
Azure |
Azure VM workload-specific protected item representing SAP HANA DBInstance. |
Azure |
Azure VM workload-specific protected item representing SQL Database. |
Backup |
Type of backup management for the backed up item. |
Cloud |
An error response from the Container Instance service. |
Cloud |
An error response from the Container Instance service. |
Create |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
Data |
Type of workload this item represents. |
Disk |
|
Distributed |
This is used to represent the various nodes of the distributed container. |
DPMProtected |
Additional information on Backup engine specific backup item. |
DPMProtected |
Additional information of DPM Protected item. |
Error |
The resource management error additional info. |
Error |
Error Detail class which encapsulates Code, Message and Recommendations. |
Extended |
Extended Properties for Azure IaasVM Backup. |
Generic |
Base class for backup items. |
Health |
Health status of protected item. |
KPIResource |
KPI Resource Health Details |
Last |
Last backup operation status. Possible values: Healthy, Unhealthy. |
Mab |
MAB workload-specific backup item. |
Mab |
Additional information on the backed up item. |
Protected |
Health status of the backup item, evaluated based on last heartbeat received |
Protected |
Base class for backup items. |
Protected |
Backup state of the backed up item. |
Protection |
Backup state of this backup item. |
Resource |
Health Details for backup items. |
Resource |
Resource Health Status |
AzureFileshareProtectedItem
Azure File Share workload-specific backup item.
Name | Type | Description |
---|---|---|
backupManagementType |
Type of backup management for the backed up item. |
|
backupSetName |
string |
Name of the backup set the backup item belongs to |
containerName |
string |
Unique name of container |
createMode |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
|
deferredDeleteTimeInUTC |
string |
Time for deferred deletion in UTC |
deferredDeleteTimeRemaining |
string |
Time remaining before the DS marked for deferred delete is permanently deleted |
extendedInfo |
Additional information with this backup item. |
|
friendlyName |
string |
Friendly name of the fileshare represented by this backup item. |
isArchiveEnabled |
boolean |
Flag to identify whether datasource is protected in archive |
isDeferredDeleteScheduleUpcoming |
boolean |
Flag to identify whether the deferred deleted DS is to be purged soon |
isRehydrate |
boolean |
Flag to identify that deferred deleted DS is to be moved into Pause state |
isScheduledForDeferredDelete |
boolean |
Flag to identify whether the DS is scheduled for deferred delete |
kpisHealths |
<string,
KPIResource |
Health details of different KPIs |
lastBackupStatus |
string |
Last backup operation status. Possible values: Healthy, Unhealthy. |
lastBackupTime |
string |
Timestamp of the last backup operation on this backup item. |
lastRecoveryPoint |
string |
Timestamp when the last (latest) backup copy was created for this backup item. |
policyId |
string |
ID of the backup policy with which this item is backed up. |
policyName |
string |
Name of the policy used for protection |
protectedItemType |
string:
Azure |
backup item type. |
protectionState |
Backup state of this backup item. |
|
protectionStatus |
string |
Backup status of this backup item. |
resourceGuardOperationRequests |
string[] |
ResourceGuardOperationRequests on which LAC check will be performed |
softDeleteRetentionPeriodInDays |
integer |
Soft delete retention period in days |
sourceResourceId |
string |
ARM ID of the resource to be backed up. |
vaultId |
string |
ID of the vault which protects this item |
workloadType |
Type of workload this item represents. |
AzureFileshareProtectedItemExtendedInfo
Additional information about Azure File Share backup item.
Name | Type | Description |
---|---|---|
oldestRecoveryPoint |
string |
The oldest backup copy available for this item in the service. |
policyState |
string |
Indicates consistency of policy object and policy applied to this backup item. |
recoveryPointCount |
integer |
Number of available backup copies associated with this backup item. |
resourceState |
string |
Indicates the state of this resource. Possible values are from enum ResourceState {Invalid, Active, SoftDeleted, Deleted} |
resourceStateSyncTime |
string |
The resource state sync time for this backup item. |
AzureIaaSClassicComputeVMProtectedItem
IaaS VM workload-specific backup item representing the Classic Compute VM.
Name | Type | Description |
---|---|---|
backupManagementType |
Type of backup management for the backed up item. |
|
backupSetName |
string |
Name of the backup set the backup item belongs to |
containerName |
string |
Unique name of container |
createMode |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
|
deferredDeleteTimeInUTC |
string |
Time for deferred deletion in UTC |
deferredDeleteTimeRemaining |
string |
Time remaining before the DS marked for deferred delete is permanently deleted |
extendedInfo |
Additional information for this backup item. |
|
extendedProperties |
Extended Properties for Azure IaasVM Backup. |
|
friendlyName |
string |
Friendly name of the VM represented by this backup item. |
healthDetails |
Health details on this backup item. |
|
healthStatus |
Health status of protected item. |
|
isArchiveEnabled |
boolean |
Flag to identify whether datasource is protected in archive |
isDeferredDeleteScheduleUpcoming |
boolean |
Flag to identify whether the deferred deleted DS is to be purged soon |
isRehydrate |
boolean |
Flag to identify that deferred deleted DS is to be moved into Pause state |
isScheduledForDeferredDelete |
boolean |
Flag to identify whether the DS is scheduled for deferred delete |
kpisHealths |
<string,
KPIResource |
Health details of different KPIs |
lastBackupStatus |
string |
Last backup operation status. |
lastBackupTime |
string |
Timestamp of the last backup operation on this backup item. |
lastRecoveryPoint |
string |
Timestamp when the last (latest) backup copy was created for this backup item. |
policyId |
string |
ID of the backup policy with which this item is backed up. |
policyName |
string |
Name of the policy used for protection |
protectedItemDataId |
string |
Data ID of the protected item. |
protectedItemType |
string:
Microsoft. |
backup item type. |
protectionState |
Backup state of this backup item. |
|
protectionStatus |
string |
Backup status of this backup item. |
resourceGuardOperationRequests |
string[] |
ResourceGuardOperationRequests on which LAC check will be performed |
softDeleteRetentionPeriodInDays |
integer |
Soft delete retention period in days |
sourceResourceId |
string |
ARM ID of the resource to be backed up. |
vaultId |
string |
ID of the vault which protects this item |
virtualMachineId |
string |
Fully qualified ARM ID of the virtual machine represented by this item. |
workloadType |
Type of workload this item represents. |
AzureIaaSComputeVMProtectedItem
IaaS VM workload-specific backup item representing the Azure Resource Manager VM.
Name | Type | Description |
---|---|---|
backupManagementType |
Type of backup management for the backed up item. |
|
backupSetName |
string |
Name of the backup set the backup item belongs to |
containerName |
string |
Unique name of container |
createMode |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
|
deferredDeleteTimeInUTC |
string |
Time for deferred deletion in UTC |
deferredDeleteTimeRemaining |
string |
Time remaining before the DS marked for deferred delete is permanently deleted |
extendedInfo |
Additional information for this backup item. |
|
extendedProperties |
Extended Properties for Azure IaasVM Backup. |
|
friendlyName |
string |
Friendly name of the VM represented by this backup item. |
healthDetails |
Health details on this backup item. |
|
healthStatus |
Health status of protected item. |
|
isArchiveEnabled |
boolean |
Flag to identify whether datasource is protected in archive |
isDeferredDeleteScheduleUpcoming |
boolean |
Flag to identify whether the deferred deleted DS is to be purged soon |
isRehydrate |
boolean |
Flag to identify that deferred deleted DS is to be moved into Pause state |
isScheduledForDeferredDelete |
boolean |
Flag to identify whether the DS is scheduled for deferred delete |
kpisHealths |
<string,
KPIResource |
Health details of different KPIs |
lastBackupStatus |
string |
Last backup operation status. |
lastBackupTime |
string |
Timestamp of the last backup operation on this backup item. |
lastRecoveryPoint |
string |
Timestamp when the last (latest) backup copy was created for this backup item. |
policyId |
string |
ID of the backup policy with which this item is backed up. |
policyName |
string |
Name of the policy used for protection |
protectedItemDataId |
string |
Data ID of the protected item. |
protectedItemType |
string:
Microsoft. |
backup item type. |
protectionState |
Backup state of this backup item. |
|
protectionStatus |
string |
Backup status of this backup item. |
resourceGuardOperationRequests |
string[] |
ResourceGuardOperationRequests on which LAC check will be performed |
softDeleteRetentionPeriodInDays |
integer |
Soft delete retention period in days |
sourceResourceId |
string |
ARM ID of the resource to be backed up. |
vaultId |
string |
ID of the vault which protects this item |
virtualMachineId |
string |
Fully qualified ARM ID of the virtual machine represented by this item. |
workloadType |
Type of workload this item represents. |
AzureIaaSVMHealthDetails
Azure IaaS VM workload-specific Health Details.
Name | Type | Description |
---|---|---|
code |
integer |
Health Code |
message |
string |
Health Message |
recommendations |
string[] |
Health Recommended Actions |
title |
string |
Health Title |
AzureIaaSVMProtectedItem
IaaS VM workload-specific backup item.
Name | Type | Description |
---|---|---|
backupManagementType |
Type of backup management for the backed up item. |
|
backupSetName |
string |
Name of the backup set the backup item belongs to |
containerName |
string |
Unique name of container |
createMode |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
|
deferredDeleteTimeInUTC |
string |
Time for deferred deletion in UTC |
deferredDeleteTimeRemaining |
string |
Time remaining before the DS marked for deferred delete is permanently deleted |
extendedInfo |
Additional information for this backup item. |
|
extendedProperties |
Extended Properties for Azure IaasVM Backup. |
|
friendlyName |
string |
Friendly name of the VM represented by this backup item. |
healthDetails |
Health details on this backup item. |
|
healthStatus |
Health status of protected item. |
|
isArchiveEnabled |
boolean |
Flag to identify whether datasource is protected in archive |
isDeferredDeleteScheduleUpcoming |
boolean |
Flag to identify whether the deferred deleted DS is to be purged soon |
isRehydrate |
boolean |
Flag to identify that deferred deleted DS is to be moved into Pause state |
isScheduledForDeferredDelete |
boolean |
Flag to identify whether the DS is scheduled for deferred delete |
kpisHealths |
<string,
KPIResource |
Health details of different KPIs |
lastBackupStatus |
string |
Last backup operation status. |
lastBackupTime |
string |
Timestamp of the last backup operation on this backup item. |
lastRecoveryPoint |
string |
Timestamp when the last (latest) backup copy was created for this backup item. |
policyId |
string |
ID of the backup policy with which this item is backed up. |
policyName |
string |
Name of the policy used for protection |
protectedItemDataId |
string |
Data ID of the protected item. |
protectedItemType | string: |
backup item type. |
protectionState |
Backup state of this backup item. |
|
protectionStatus |
string |
Backup status of this backup item. |
resourceGuardOperationRequests |
string[] |
ResourceGuardOperationRequests on which LAC check will be performed |
softDeleteRetentionPeriodInDays |
integer |
Soft delete retention period in days |
sourceResourceId |
string |
ARM ID of the resource to be backed up. |
vaultId |
string |
ID of the vault which protects this item |
virtualMachineId |
string |
Fully qualified ARM ID of the virtual machine represented by this item. |
workloadType |
Type of workload this item represents. |
AzureIaaSVMProtectedItemExtendedInfo
Additional information on Azure IaaS VM specific backup item.
Name | Type | Description |
---|---|---|
newestRecoveryPointInArchive |
string |
The latest backup copy available for this backup item in archive tier |
oldestRecoveryPoint |
string |
The oldest backup copy available for this backup item across all tiers. |
oldestRecoveryPointInArchive |
string |
The oldest backup copy available for this backup item in archive tier |
oldestRecoveryPointInVault |
string |
The oldest backup copy available for this backup item in vault tier |
policyInconsistent |
boolean |
Specifies if backup policy associated with the backup item is inconsistent. |
recoveryPointCount |
integer |
Number of backup copies available for this backup item. |
AzureSqlProtectedItem
Azure SQL workload-specific backup item.
Name | Type | Description |
---|---|---|
backupManagementType |
Type of backup management for the backed up item. |
|
backupSetName |
string |
Name of the backup set the backup item belongs to |
containerName |
string |
Unique name of container |
createMode |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
|
deferredDeleteTimeInUTC |
string |
Time for deferred deletion in UTC |
deferredDeleteTimeRemaining |
string |
Time remaining before the DS marked for deferred delete is permanently deleted |
extendedInfo |
Additional information for this backup item. |
|
isArchiveEnabled |
boolean |
Flag to identify whether datasource is protected in archive |
isDeferredDeleteScheduleUpcoming |
boolean |
Flag to identify whether the deferred deleted DS is to be purged soon |
isRehydrate |
boolean |
Flag to identify that deferred deleted DS is to be moved into Pause state |
isScheduledForDeferredDelete |
boolean |
Flag to identify whether the DS is scheduled for deferred delete |
lastRecoveryPoint |
string |
Timestamp when the last (latest) backup copy was created for this backup item. |
policyId |
string |
ID of the backup policy with which this item is backed up. |
policyName |
string |
Name of the policy used for protection |
protectedItemDataId |
string |
Internal ID of a backup item. Used by Azure SQL Backup engine to contact Recovery Services. |
protectedItemType |
string:
Microsoft. |
backup item type. |
protectionState |
Backup state of the backed up item. |
|
resourceGuardOperationRequests |
string[] |
ResourceGuardOperationRequests on which LAC check will be performed |
softDeleteRetentionPeriodInDays |
integer |
Soft delete retention period in days |
sourceResourceId |
string |
ARM ID of the resource to be backed up. |
vaultId |
string |
ID of the vault which protects this item |
workloadType |
Type of workload this item represents. |
AzureSqlProtectedItemExtendedInfo
Additional information on Azure Sql specific protected item.
Name | Type | Description |
---|---|---|
oldestRecoveryPoint |
string |
The oldest backup copy available for this item in the service. |
policyState |
string |
State of the backup policy associated with this backup item. |
recoveryPointCount |
integer |
Number of available backup copies associated with this backup item. |
AzureVmWorkloadProtectedItem
Azure VM workload-specific protected item.
Name | Type | Description |
---|---|---|
backupManagementType |
Type of backup management for the backed up item. |
|
backupSetName |
string |
Name of the backup set the backup item belongs to |
containerName |
string |
Unique name of container |
createMode |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
|
deferredDeleteTimeInUTC |
string |
Time for deferred deletion in UTC |
deferredDeleteTimeRemaining |
string |
Time remaining before the DS marked for deferred delete is permanently deleted |
extendedInfo |
Additional information for this backup item. |
|
friendlyName |
string |
Friendly name of the DB represented by this backup item. |
isArchiveEnabled |
boolean |
Flag to identify whether datasource is protected in archive |
isDeferredDeleteScheduleUpcoming |
boolean |
Flag to identify whether the deferred deleted DS is to be purged soon |
isRehydrate |
boolean |
Flag to identify that deferred deleted DS is to be moved into Pause state |
isScheduledForDeferredDelete |
boolean |
Flag to identify whether the DS is scheduled for deferred delete |
kpisHealths |
<string,
KPIResource |
Health details of different KPIs |
lastBackupErrorDetail |
Error details in last backup |
|
lastBackupStatus |
Last backup operation status. Possible values: Healthy, Unhealthy. |
|
lastBackupTime |
string |
Timestamp of the last backup operation on this backup item. |
lastRecoveryPoint |
string |
Timestamp when the last (latest) backup copy was created for this backup item. |
nodesList |
List of the nodes in case of distributed container. |
|
parentName |
string |
Parent name of the DB such as Instance or Availability Group. |
parentType |
string |
Parent type of protected item, example: for a DB, standalone server or distributed |
policyId |
string |
ID of the backup policy with which this item is backed up. |
policyName |
string |
Name of the policy used for protection |
protectedItemDataSourceId |
string |
Data ID of the protected item. |
protectedItemHealthStatus |
Health status of the backup item, evaluated based on last heartbeat received |
|
protectedItemType | string: |
backup item type. |
protectionState |
Backup state of this backup item. |
|
protectionStatus |
string |
Backup status of this backup item. |
resourceGuardOperationRequests |
string[] |
ResourceGuardOperationRequests on which LAC check will be performed |
serverName |
string |
Host/Cluster Name for instance or AG |
softDeleteRetentionPeriodInDays |
integer |
Soft delete retention period in days |
sourceResourceId |
string |
ARM ID of the resource to be backed up. |
vaultId |
string |
ID of the vault which protects this item |
workloadType |
Type of workload this item represents. |
AzureVmWorkloadProtectedItemExtendedInfo
Additional information on Azure Workload for SQL specific backup item.
Name | Type | Description |
---|---|---|
newestRecoveryPointInArchive |
string |
The latest backup copy available for this backup item in archive tier |
oldestRecoveryPoint |
string |
The oldest backup copy available for this backup item across all tiers. |
oldestRecoveryPointInArchive |
string |
The oldest backup copy available for this backup item in archive tier |
oldestRecoveryPointInVault |
string |
The oldest backup copy available for this backup item in vault tier |
policyState |
string |
Indicates consistency of policy object and policy applied to this backup item. |
recoveryModel |
string |
Indicates consistency of policy object and policy applied to this backup item. |
recoveryPointCount |
integer |
Number of backup copies available for this backup item. |
AzureVmWorkloadSAPAseDatabaseProtectedItem
Azure VM workload-specific protected item representing SAP ASE Database.
Name | Type | Description |
---|---|---|
backupManagementType |
Type of backup management for the backed up item. |
|
backupSetName |
string |
Name of the backup set the backup item belongs to |
containerName |
string |
Unique name of container |
createMode |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
|
deferredDeleteTimeInUTC |
string |
Time for deferred deletion in UTC |
deferredDeleteTimeRemaining |
string |
Time remaining before the DS marked for deferred delete is permanently deleted |
extendedInfo |
Additional information for this backup item. |
|
friendlyName |
string |
Friendly name of the DB represented by this backup item. |
isArchiveEnabled |
boolean |
Flag to identify whether datasource is protected in archive |
isDeferredDeleteScheduleUpcoming |
boolean |
Flag to identify whether the deferred deleted DS is to be purged soon |
isRehydrate |
boolean |
Flag to identify that deferred deleted DS is to be moved into Pause state |
isScheduledForDeferredDelete |
boolean |
Flag to identify whether the DS is scheduled for deferred delete |
kpisHealths |
<string,
KPIResource |
Health details of different KPIs |
lastBackupErrorDetail |
Error details in last backup |
|
lastBackupStatus |
Last backup operation status. Possible values: Healthy, Unhealthy. |
|
lastBackupTime |
string |
Timestamp of the last backup operation on this backup item. |
lastRecoveryPoint |
string |
Timestamp when the last (latest) backup copy was created for this backup item. |
nodesList |
List of the nodes in case of distributed container. |
|
parentName |
string |
Parent name of the DB such as Instance or Availability Group. |
parentType |
string |
Parent type of protected item, example: for a DB, standalone server or distributed |
policyId |
string |
ID of the backup policy with which this item is backed up. |
policyName |
string |
Name of the policy used for protection |
protectedItemDataSourceId |
string |
Data ID of the protected item. |
protectedItemHealthStatus |
Health status of the backup item, evaluated based on last heartbeat received |
|
protectedItemType |
string:
Azure |
backup item type. |
protectionState |
Backup state of this backup item. |
|
protectionStatus |
string |
Backup status of this backup item. |
resourceGuardOperationRequests |
string[] |
ResourceGuardOperationRequests on which LAC check will be performed |
serverName |
string |
Host/Cluster Name for instance or AG |
softDeleteRetentionPeriodInDays |
integer |
Soft delete retention period in days |
sourceResourceId |
string |
ARM ID of the resource to be backed up. |
vaultId |
string |
ID of the vault which protects this item |
workloadType |
Type of workload this item represents. |
AzureVmWorkloadSAPHanaDatabaseProtectedItem
Azure VM workload-specific protected item representing SAP HANA Database.
Name | Type | Description |
---|---|---|
backupManagementType |
Type of backup management for the backed up item. |
|
backupSetName |
string |
Name of the backup set the backup item belongs to |
containerName |
string |
Unique name of container |
createMode |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
|
deferredDeleteTimeInUTC |
string |
Time for deferred deletion in UTC |
deferredDeleteTimeRemaining |
string |
Time remaining before the DS marked for deferred delete is permanently deleted |
extendedInfo |
Additional information for this backup item. |
|
friendlyName |
string |
Friendly name of the DB represented by this backup item. |
isArchiveEnabled |
boolean |
Flag to identify whether datasource is protected in archive |
isDeferredDeleteScheduleUpcoming |
boolean |
Flag to identify whether the deferred deleted DS is to be purged soon |
isRehydrate |
boolean |
Flag to identify that deferred deleted DS is to be moved into Pause state |
isScheduledForDeferredDelete |
boolean |
Flag to identify whether the DS is scheduled for deferred delete |
kpisHealths |
<string,
KPIResource |
Health details of different KPIs |
lastBackupErrorDetail |
Error details in last backup |
|
lastBackupStatus |
Last backup operation status. Possible values: Healthy, Unhealthy. |
|
lastBackupTime |
string |
Timestamp of the last backup operation on this backup item. |
lastRecoveryPoint |
string |
Timestamp when the last (latest) backup copy was created for this backup item. |
nodesList |
List of the nodes in case of distributed container. |
|
parentName |
string |
Parent name of the DB such as Instance or Availability Group. |
parentType |
string |
Parent type of protected item, example: for a DB, standalone server or distributed |
policyId |
string |
ID of the backup policy with which this item is backed up. |
policyName |
string |
Name of the policy used for protection |
protectedItemDataSourceId |
string |
Data ID of the protected item. |
protectedItemHealthStatus |
Health status of the backup item, evaluated based on last heartbeat received |
|
protectedItemType |
string:
Azure |
backup item type. |
protectionState |
Backup state of this backup item. |
|
protectionStatus |
string |
Backup status of this backup item. |
resourceGuardOperationRequests |
string[] |
ResourceGuardOperationRequests on which LAC check will be performed |
serverName |
string |
Host/Cluster Name for instance or AG |
softDeleteRetentionPeriodInDays |
integer |
Soft delete retention period in days |
sourceResourceId |
string |
ARM ID of the resource to be backed up. |
vaultId |
string |
ID of the vault which protects this item |
workloadType |
Type of workload this item represents. |
AzureVmWorkloadSAPHanaDBInstanceProtectedItem
Azure VM workload-specific protected item representing SAP HANA DBInstance.
Name | Type | Description |
---|---|---|
backupManagementType |
Type of backup management for the backed up item. |
|
backupSetName |
string |
Name of the backup set the backup item belongs to |
containerName |
string |
Unique name of container |
createMode |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
|
deferredDeleteTimeInUTC |
string |
Time for deferred deletion in UTC |
deferredDeleteTimeRemaining |
string |
Time remaining before the DS marked for deferred delete is permanently deleted |
extendedInfo |
Additional information for this backup item. |
|
friendlyName |
string |
Friendly name of the DB represented by this backup item. |
isArchiveEnabled |
boolean |
Flag to identify whether datasource is protected in archive |
isDeferredDeleteScheduleUpcoming |
boolean |
Flag to identify whether the deferred deleted DS is to be purged soon |
isRehydrate |
boolean |
Flag to identify that deferred deleted DS is to be moved into Pause state |
isScheduledForDeferredDelete |
boolean |
Flag to identify whether the DS is scheduled for deferred delete |
kpisHealths |
<string,
KPIResource |
Health details of different KPIs |
lastBackupErrorDetail |
Error details in last backup |
|
lastBackupStatus |
Last backup operation status. Possible values: Healthy, Unhealthy. |
|
lastBackupTime |
string |
Timestamp of the last backup operation on this backup item. |
lastRecoveryPoint |
string |
Timestamp when the last (latest) backup copy was created for this backup item. |
nodesList |
List of the nodes in case of distributed container. |
|
parentName |
string |
Parent name of the DB such as Instance or Availability Group. |
parentType |
string |
Parent type of protected item, example: for a DB, standalone server or distributed |
policyId |
string |
ID of the backup policy with which this item is backed up. |
policyName |
string |
Name of the policy used for protection |
protectedItemDataSourceId |
string |
Data ID of the protected item. |
protectedItemHealthStatus |
Health status of the backup item, evaluated based on last heartbeat received |
|
protectedItemType |
string:
Azure |
backup item type. |
protectionState |
Backup state of this backup item. |
|
protectionStatus |
string |
Backup status of this backup item. |
resourceGuardOperationRequests |
string[] |
ResourceGuardOperationRequests on which LAC check will be performed |
serverName |
string |
Host/Cluster Name for instance or AG |
softDeleteRetentionPeriodInDays |
integer |
Soft delete retention period in days |
sourceResourceId |
string |
ARM ID of the resource to be backed up. |
vaultId |
string |
ID of the vault which protects this item |
workloadType |
Type of workload this item represents. |
AzureVmWorkloadSQLDatabaseProtectedItem
Azure VM workload-specific protected item representing SQL Database.
Name | Type | Description |
---|---|---|
backupManagementType |
Type of backup management for the backed up item. |
|
backupSetName |
string |
Name of the backup set the backup item belongs to |
containerName |
string |
Unique name of container |
createMode |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
|
deferredDeleteTimeInUTC |
string |
Time for deferred deletion in UTC |
deferredDeleteTimeRemaining |
string |
Time remaining before the DS marked for deferred delete is permanently deleted |
extendedInfo |
Additional information for this backup item. |
|
friendlyName |
string |
Friendly name of the DB represented by this backup item. |
isArchiveEnabled |
boolean |
Flag to identify whether datasource is protected in archive |
isDeferredDeleteScheduleUpcoming |
boolean |
Flag to identify whether the deferred deleted DS is to be purged soon |
isRehydrate |
boolean |
Flag to identify that deferred deleted DS is to be moved into Pause state |
isScheduledForDeferredDelete |
boolean |
Flag to identify whether the DS is scheduled for deferred delete |
kpisHealths |
<string,
KPIResource |
Health details of different KPIs |
lastBackupErrorDetail |
Error details in last backup |
|
lastBackupStatus |
Last backup operation status. Possible values: Healthy, Unhealthy. |
|
lastBackupTime |
string |
Timestamp of the last backup operation on this backup item. |
lastRecoveryPoint |
string |
Timestamp when the last (latest) backup copy was created for this backup item. |
nodesList |
List of the nodes in case of distributed container. |
|
parentName |
string |
Parent name of the DB such as Instance or Availability Group. |
parentType |
string |
Parent type of protected item, example: for a DB, standalone server or distributed |
policyId |
string |
ID of the backup policy with which this item is backed up. |
policyName |
string |
Name of the policy used for protection |
protectedItemDataSourceId |
string |
Data ID of the protected item. |
protectedItemHealthStatus |
Health status of the backup item, evaluated based on last heartbeat received |
|
protectedItemType |
string:
Azure |
backup item type. |
protectionState |
Backup state of this backup item. |
|
protectionStatus |
string |
Backup status of this backup item. |
resourceGuardOperationRequests |
string[] |
ResourceGuardOperationRequests on which LAC check will be performed |
serverName |
string |
Host/Cluster Name for instance or AG |
softDeleteRetentionPeriodInDays |
integer |
Soft delete retention period in days |
sourceResourceId |
string |
ARM ID of the resource to be backed up. |
vaultId |
string |
ID of the vault which protects this item |
workloadType |
Type of workload this item represents. |
BackupManagementType
Type of backup management for the backed up item.
Name | Type | Description |
---|---|---|
AzureBackupServer |
string |
|
AzureIaasVM |
string |
|
AzureSql |
string |
|
AzureStorage |
string |
|
AzureWorkload |
string |
|
DPM |
string |
|
DefaultBackup |
string |
|
Invalid |
string |
|
MAB |
string |
CloudError
An error response from the Container Instance service.
Name | Type | Description |
---|---|---|
error |
The error object. |
CloudErrorBody
An error response from the Container Instance service.
Name | Type | Description |
---|---|---|
additionalInfo |
The error additional info. |
|
code |
string |
An identifier for the error. Codes are invariant and are intended to be consumed programmatically. |
details |
A list of additional details about the error. |
|
message |
string |
A message describing the error, intended to be suitable for display in a user interface. |
target |
string |
The target of the particular error. For example, the name of the property in error. |
CreateMode
Create mode to indicate recovery of existing soft deleted data source or creation of new data source.
Name | Type | Description |
---|---|---|
Default |
string |
|
Invalid |
string |
|
Recover |
string |
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 |
|
SAPHanaDBInstance |
string |
|
SAPHanaDatabase |
string |
|
SQLDB |
string |
|
SQLDataBase |
string |
|
Sharepoint |
string |
|
SystemState |
string |
|
VM |
string |
|
VMwareVM |
string |
DiskExclusionProperties
Name | Type | Description |
---|---|---|
diskLunList |
integer[] |
List of Disks' Logical Unit Numbers (LUN) to be used for VM Protection. |
isInclusionList |
boolean |
Flag to indicate whether DiskLunList is to be included/ excluded from backup. |
DistributedNodesInfo
This is used to represent the various nodes of the distributed container.
Name | Type | Description |
---|---|---|
errorDetail |
Error Details if the Status is non-success. |
|
nodeName |
string |
Name of the node under a distributed container. |
sourceResourceId |
string |
ARM resource id of the node |
status |
string |
Status of this Node. Failed | Succeeded |
DPMProtectedItem
Additional information on Backup engine specific backup item.
Name | Type | Description |
---|---|---|
backupEngineName |
string |
Backup Management server protecting this backup item |
backupManagementType |
Type of backup management for the backed up item. |
|
backupSetName |
string |
Name of the backup set the backup item belongs to |
containerName |
string |
Unique name of container |
createMode |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
|
deferredDeleteTimeInUTC |
string |
Time for deferred deletion in UTC |
deferredDeleteTimeRemaining |
string |
Time remaining before the DS marked for deferred delete is permanently deleted |
extendedInfo |
Extended info of the backup item. |
|
friendlyName |
string |
Friendly name of the managed item |
isArchiveEnabled |
boolean |
Flag to identify whether datasource is protected in archive |
isDeferredDeleteScheduleUpcoming |
boolean |
Flag to identify whether the deferred deleted DS is to be purged soon |
isRehydrate |
boolean |
Flag to identify that deferred deleted DS is to be moved into Pause state |
isScheduledForDeferredDelete |
boolean |
Flag to identify whether the DS is scheduled for deferred delete |
lastRecoveryPoint |
string |
Timestamp when the last (latest) backup copy was created for this backup item. |
policyId |
string |
ID of the backup policy with which this item is backed up. |
policyName |
string |
Name of the policy used for protection |
protectedItemType | string: |
backup item type. |
protectionState |
Protection state of the backup engine |
|
resourceGuardOperationRequests |
string[] |
ResourceGuardOperationRequests on which LAC check will be performed |
softDeleteRetentionPeriodInDays |
integer |
Soft delete retention period in days |
sourceResourceId |
string |
ARM ID of the resource to be backed up. |
vaultId |
string |
ID of the vault which protects this item |
workloadType |
Type of workload this item represents. |
DPMProtectedItemExtendedInfo
Additional information of DPM Protected item.
Name | Type | Description |
---|---|---|
diskStorageUsedInBytes |
string |
Used Disk storage in bytes. |
isCollocated |
boolean |
To check if backup item is collocated. |
isPresentOnCloud |
boolean |
To check if backup item is cloud protected. |
lastBackupStatus |
string |
Last backup status information on backup item. |
lastRefreshedAt |
string |
Last refresh time on backup item. |
oldestRecoveryPoint |
string |
Oldest cloud recovery point time. |
onPremiseLatestRecoveryPoint |
string |
latest disk recovery point time. |
onPremiseOldestRecoveryPoint |
string |
Oldest disk recovery point time. |
onPremiseRecoveryPointCount |
integer |
disk recovery point count. |
protectableObjectLoadPath |
object |
Attribute to provide information on various DBs. |
protected |
boolean |
To check if backup item is disk protected. |
protectionGroupName |
string |
Protection group name of the backup item. |
recoveryPointCount |
integer |
cloud recovery point count. |
totalDiskStorageSizeInBytes |
string |
total Disk storage in bytes. |
ErrorAdditionalInfo
The resource management error additional info.
Name | Type | Description |
---|---|---|
info |
object |
The additional info. |
type |
string |
The additional info type. |
ErrorDetail
Error Detail class which encapsulates Code, Message and Recommendations.
Name | Type | Description |
---|---|---|
code |
string |
Error code. |
message |
string |
Error Message related to the Code. |
recommendations |
string[] |
List of recommendation strings. |
ExtendedProperties
Extended Properties for Azure IaasVM Backup.
Name | Type | Description |
---|---|---|
diskExclusionProperties |
Extended Properties for Disk Exclusion. |
|
linuxVmApplicationName |
string |
Linux VM name |
GenericProtectedItem
Base class for backup items.
Name | Type | Description |
---|---|---|
backupManagementType |
Type of backup management for the backed up item. |
|
backupSetName |
string |
Name of the backup set the backup item belongs to |
containerName |
string |
Unique name of container |
createMode |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
|
deferredDeleteTimeInUTC |
string |
Time for deferred deletion in UTC |
deferredDeleteTimeRemaining |
string |
Time remaining before the DS marked for deferred delete is permanently deleted |
fabricName |
string |
Name of this backup item's fabric. |
friendlyName |
string |
Friendly name of the container. |
isArchiveEnabled |
boolean |
Flag to identify whether datasource is protected in archive |
isDeferredDeleteScheduleUpcoming |
boolean |
Flag to identify whether the deferred deleted DS is to be purged soon |
isRehydrate |
boolean |
Flag to identify that deferred deleted DS is to be moved into Pause state |
isScheduledForDeferredDelete |
boolean |
Flag to identify whether the DS is scheduled for deferred delete |
lastRecoveryPoint |
string |
Timestamp when the last (latest) backup copy was created for this backup item. |
policyId |
string |
ID of the backup policy with which this item is backed up. |
policyName |
string |
Name of the policy used for protection |
policyState |
string |
Indicates consistency of policy object and policy applied to this backup item. |
protectedItemId |
integer |
Data Plane Service ID of the protected item. |
protectedItemType | string: |
backup item type. |
protectionState |
Backup state of this backup item. |
|
resourceGuardOperationRequests |
string[] |
ResourceGuardOperationRequests on which LAC check will be performed |
softDeleteRetentionPeriodInDays |
integer |
Soft delete retention period in days |
sourceAssociations |
object |
Loosely coupled (type, value) associations (example - parent of a protected item) |
sourceResourceId |
string |
ARM ID of the resource to be backed up. |
vaultId |
string |
ID of the vault which protects this item |
workloadType |
Type of workload this item represents. |
HealthStatus
Health status of protected item.
Name | Type | Description |
---|---|---|
ActionRequired |
string |
|
ActionSuggested |
string |
|
Invalid |
string |
|
Passed |
string |
KPIResourceHealthDetails
KPI Resource Health Details
Name | Type | Description |
---|---|---|
resourceHealthDetails |
Resource Health Status |
|
resourceHealthStatus |
Resource Health Status |
LastBackupStatus
Last backup operation status. Possible values: Healthy, Unhealthy.
Name | Type | Description |
---|---|---|
Healthy |
string |
|
IRPending |
string |
|
Invalid |
string |
|
Unhealthy |
string |
MabFileFolderProtectedItem
MAB workload-specific backup item.
Name | Type | Description |
---|---|---|
backupManagementType |
Type of backup management for the backed up item. |
|
backupSetName |
string |
Name of the backup set the backup item belongs to |
computerName |
string |
Name of the computer associated with this backup item. |
containerName |
string |
Unique name of container |
createMode |
Create mode to indicate recovery of existing soft deleted data source or creation of new data source. |
|
deferredDeleteSyncTimeInUTC |
integer |
Sync time for deferred deletion in UTC |
deferredDeleteTimeInUTC |
string |
Time for deferred deletion in UTC |
deferredDeleteTimeRemaining |
string |
Time remaining before the DS marked for deferred delete is permanently deleted |
extendedInfo |
Additional information with this backup item. |
|
friendlyName |
string |
Friendly name of this backup item. |
isArchiveEnabled |
boolean |
Flag to identify whether datasource is protected in archive |
isDeferredDeleteScheduleUpcoming |
boolean |
Flag to identify whether the deferred deleted DS is to be purged soon |
isRehydrate |
boolean |
Flag to identify that deferred deleted DS is to be moved into Pause state |
isScheduledForDeferredDelete |
boolean |
Flag to identify whether the DS is scheduled for deferred delete |
lastBackupStatus |
string |
Status of last backup operation. |
lastBackupTime |
string |
Timestamp of the last backup operation on this backup item. |
lastRecoveryPoint |
string |
Timestamp when the last (latest) backup copy was created for this backup item. |
policyId |
string |
ID of the backup policy with which this item is backed up. |
policyName |
string |
Name of the policy used for protection |
protectedItemType | string: |
backup item type. |
protectionState |
string |
Protected, ProtectionStopped, IRPending or ProtectionError |
resourceGuardOperationRequests |
string[] |
ResourceGuardOperationRequests on which LAC check will be performed |
softDeleteRetentionPeriodInDays |
integer |
Soft delete retention period in days |
sourceResourceId |
string |
ARM ID of the resource to be backed up. |
vaultId |
string |
ID of the vault which protects this item |
workloadType |
Type of workload this item represents. |
MabFileFolderProtectedItemExtendedInfo
Additional information on the backed up item.
Name | Type | Description |
---|---|---|
lastRefreshedAt |
string |
Last time when the agent data synced to service. |
oldestRecoveryPoint |
string |
The oldest backup copy available. |
recoveryPointCount |
integer |
Number of backup copies associated with the backup item. |
ProtectedItemHealthStatus
Health status of the backup item, evaluated based on last heartbeat received
Name | Type | Description |
---|---|---|
Healthy |
string |
|
IRPending |
string |
|
Invalid |
string |
|
NotReachable |
string |
|
Unhealthy |
string |
ProtectedItemResource
Base class for backup items.
Name | Type | Description |
---|---|---|
eTag |
string |
Optional ETag. |
id |
string |
Resource Id represents the complete path to the resource. |
location |
string |
Resource location. |
name |
string |
Resource name associated with the resource. |
properties |
ProtectedItem:
|
ProtectedItemResource properties |
tags |
object |
Resource tags. |
type |
string |
Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/... |
ProtectedItemState
Backup state of the backed up item.
Name | Type | Description |
---|---|---|
BackupsSuspended |
string |
|
IRPending |
string |
|
Invalid |
string |
|
Protected |
string |
|
ProtectionError |
string |
|
ProtectionPaused |
string |
|
ProtectionStopped |
string |
ProtectionState
Backup state of this backup item.
Name | Type | Description |
---|---|---|
BackupsSuspended |
string |
|
IRPending |
string |
|
Invalid |
string |
|
Protected |
string |
|
ProtectionError |
string |
|
ProtectionPaused |
string |
|
ProtectionStopped |
string |
ResourceHealthDetails
Health Details for backup items.
Name | Type | Description |
---|---|---|
code |
integer |
Health Code |
message |
string |
Health Message |
recommendations |
string[] |
Health Recommended Actions |
title |
string |
Health Title |
ResourceHealthStatus
Resource Health Status
Name | Type | Description |
---|---|---|
Healthy |
string |
|
Invalid |
string |
|
PersistentDegraded |
string |
|
PersistentUnhealthy |
string |
|
TransientDegraded |
string |
|
TransientUnhealthy |
string |