Backup Protected Items - List

Provides a pageable list of all items that are backed up within a vault.

GET https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectedItems?api-version=2019-05-13
GET https://management.azure.com/Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectedItems?api-version=2019-05-13&$filter={$filter}&$skipToken={$skipToken}

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

The subscription Id.

resourceGroupName
path True
  • string

The name of the resource group where the recovery services vault is present.

vaultName
path True
  • string

The name of the recovery services vault.

api-version
query True
  • string

Client Api Version.

$filter
query
  • string

OData filter options.

$skipToken
query
  • string

skipToken Filter.

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

List protected items with backupManagementType filter as AzureIaasVm

Sample Request

GET https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupProtectedItems?api-version=2019-05-13&$filter=backupManagementType eq 'AzureIaasVM' and itemType eq 'VM'

Sample Response

{
  "value": [
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/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/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupPolicies/testPolicy1",
        "lastRecoveryPoint": "2017-11-22T12:25:32.048723Z"
      }
    }
  ]
}

Definitions

AzureFileshareProtectedItem

Azure File Share workload-specific backup item.

AzureFileshareProtectedItemExtendedInfo

Additional information about Azure File Share backup item.

AzureIaaSClassicComputeVMProtectedItem

IaaS VM workload-specific backup item representing the Classic Compute VM.

AzureIaaSComputeVMProtectedItem

IaaS VM workload-specific backup item representing the Azure Resource Manager VM.

AzureIaaSVMHealthDetails

Azure IaaS VM workload-specific Health Details.

AzureIaaSVMProtectedItem

IaaS VM workload-specific backup item.

AzureIaaSVMProtectedItemExtendedInfo

Additional information on Azure IaaS VM specific backup item.

AzureSqlProtectedItem

Azure SQL workload-specific backup item.

AzureSqlProtectedItemExtendedInfo

Additional information on Azure Sql specific protected item.

AzureVmWorkloadProtectedItem

Azure VM workload-specific protected item.

AzureVmWorkloadProtectedItemExtendedInfo

Additional information on Azure Workload for SQL specific backup item.

AzureVmWorkloadSAPAseDatabaseProtectedItem

Azure VM workload-specific protected item representing SAP ASE Database.

AzureVmWorkloadSAPHanaDatabaseProtectedItem

Azure VM workload-specific protected item representing SAP HANA Database.

AzureVmWorkloadSQLDatabaseProtectedItem

Azure VM workload-specific protected item representing SQL Database.

BackupManagementType

Type of backup management for the backed up item.

CreateMode

Create mode to indicate recovery of existing soft deleted data source or creation of new data source.

DataSourceType

Type of workload this item represents.

DiskExclusionProperties
DPMProtectedItem

Additional information on Backup engine specific backup item.

DPMProtectedItemExtendedInfo

Additional information of DPM Protected item.

ErrorDetail

Error Detail class which encapsulates Code, Message and Recommendations.

ExtendedProperties

Extended Properties for Azure IaasVM Backup.

GenericProtectedItem

Base class for backup items.

HealthStatus

backups running status for this backup item.

LastBackupStatus

Last backup operation status. Possible values: Healthy, Unhealthy.

MabFileFolderProtectedItem

MAB workload-specific backup item.

MabFileFolderProtectedItemExtendedInfo

Additional information on the backed up item.

ProtectedItemHealthStatus

Health status of the backup item, evaluated based on last heartbeat received

ProtectedItemResource

Base class for backup items.

ProtectedItemResourceList

List of ProtectedItem resources

ProtectedItemState

Backup state of the backed up item.

ProtectionState

Backup state of this backup item.

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.

healthStatus

backups running status for this backup item.

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

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.

protectedItemType string:
  • AzureFileShareProtectedItem

backup item type.

protectionState

Backup state of this backup item.

protectionStatus
  • string

Backup status of this backup item.

sourceResourceId
  • string

ARM ID of the resource to be backed up.

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

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

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.

protectedItemDataId
  • string

Data ID of the protected item.

protectedItemType string:
  • Microsoft.ClassicCompute/virtualMachines

backup item type.

protectionState

Backup state of this backup item.

protectionStatus
  • string

Backup status of this backup item.

sourceResourceId
  • string

ARM ID of the resource to be backed up.

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

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

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.

protectedItemDataId
  • string

Data ID of the protected item.

protectedItemType string:
  • Microsoft.Compute/virtualMachines

backup item type.

protectionState

Backup state of this backup item.

protectionStatus
  • string

Backup status of this backup item.

sourceResourceId
  • string

ARM ID of the resource to be backed up.

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

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

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.

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.

sourceResourceId
  • string

ARM ID of the resource to be backed up.

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
oldestRecoveryPoint
  • string

The oldest backup copy available for this backup item.

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.

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.

protectedItemDataId
  • string

Internal ID of a backup item. Used by Azure SQL Backup engine to contact Recovery Services.

protectedItemType string:
  • Microsoft.Sql/servers/databases

backup item type.

protectionState

Backup state of the backed up item.

sourceResourceId
  • string

ARM ID of the resource to be backed up.

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.

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

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.

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.

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.

serverName
  • string

Host/Cluster Name for instance or AG

sourceResourceId
  • string

ARM ID of the resource to be backed up.

workloadType

Type of workload this item represents.

AzureVmWorkloadProtectedItemExtendedInfo

Additional information on Azure Workload for SQL specific backup item.

Name Type Description
oldestRecoveryPoint
  • string

The oldest backup copy available for this backup item.

policyState
  • 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.

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

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.

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.

protectedItemDataSourceId
  • string

Data ID of the protected item.

protectedItemHealthStatus

Health status of the backup item, evaluated based on last heartbeat received

protectedItemType string:
  • AzureVmWorkloadSAPAseDatabase

backup item type.

protectionState

Backup state of this backup item.

protectionStatus
  • string

Backup status of this backup item.

serverName
  • string

Host/Cluster Name for instance or AG

sourceResourceId
  • string

ARM ID of the resource to be backed up.

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.

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

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.

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.

protectedItemDataSourceId
  • string

Data ID of the protected item.

protectedItemHealthStatus

Health status of the backup item, evaluated based on last heartbeat received

protectedItemType string:
  • AzureVmWorkloadSAPHanaDatabase

backup item type.

protectionState

Backup state of this backup item.

protectionStatus
  • string

Backup status of this backup item.

serverName
  • string

Host/Cluster Name for instance or AG

sourceResourceId
  • string

ARM ID of the resource to be backed up.

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.

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

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.

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.

protectedItemDataSourceId
  • string

Data ID of the protected item.

protectedItemHealthStatus

Health status of the backup item, evaluated based on last heartbeat received

protectedItemType string:
  • AzureVmWorkloadSQLDatabase

backup item type.

protectionState

Backup state of this backup item.

protectionStatus
  • string

Backup status of this backup item.

serverName
  • string

Host/Cluster Name for instance or AG

sourceResourceId
  • string

ARM ID of the resource to be backed up.

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

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
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.

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

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.

protectedItemType string:

backup item type.

protectionState

Protection state of the backup engine

sourceResourceId
  • string

ARM ID of the resource to be backed up.

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.

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.

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.

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.

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.

sourceAssociations
  • object

Loosely coupled (type, value) associations (example - parent of a protected item)

sourceResourceId
  • string

ARM ID of the resource to be backed up.

workloadType

Type of workload this item represents.

HealthStatus

backups running status for this backup item.

Name Type Description
ActionRequired
  • string
ActionSuggested
  • string
Invalid
  • string
Passed
  • string

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.

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.

protectedItemType string:

backup item type.

protectionState
  • string

Protected, ProtectionStopped, IRPending or ProtectionError

sourceResourceId
  • string

ARM ID of the resource to be backed up.

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/...

ProtectedItemResourceList

List of ProtectedItem resources

Name Type Description
nextLink
  • string

The uri to fetch the next page of resources. Call ListNext() fetches next page of resources.

value

List of resources.

ProtectedItemState

Backup state of the backed up item.

Name Type Description
IRPending
  • string
Invalid
  • string
Protected
  • string
ProtectionError
  • string
ProtectionPaused
  • string
ProtectionStopped
  • string

ProtectionState

Backup state of this backup item.

Name Type Description
IRPending
  • string
Invalid
  • string
Protected
  • string
ProtectionError
  • string
ProtectionPaused
  • string
ProtectionStopped
  • string