Backup Protectable Items - List

Reference

Service:: Recovery Services - Backup

API Version:: 2024-10-01

Provides a pageable list of protectable objects within your subscription according to the query filter and the pagination parameters.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectableItems?api-version=2024-10-01

With optional parameters:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectableItems?api-version=2024-10-01&$filter={$filter}&$skipToken={$skipToken}

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The name of the resource group where the recovery services vault is present.
subscriptionId	path	True	string	The subscription Id.
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	WorkloadProtectableItemResourceList	OK
Other Status Codes	CloudError	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

List protectable items with backupManagementType filter as AzureIaasVm

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/backupProtectableItems?api-version=2024-10-01&$filter=backupManagementType eq 'AzureIaasVM'

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/SwaggerTestRg/providers/Microsoft.RecoveryServices/vaults/NetSDKTestRsVault/protectionContainers/IaasVMContainer;iaasvmcontainer;iaasvm-rg;iaasvm-1/protectableItems/VM;iaasvmcontainer;iaasvm-rg;iaasvm-1",
      "name": "VM;iaasvmcontainer;iaasvm-rg;iaasvm-1",
      "type": "Microsoft.RecoveryServices/vaults/backupFabrics/protectionContainers/protectableItems",
      "properties": {
        "friendlyName": "iaasvm-1",
        "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/providers/Microsoft.ClassicCompute/virtualMachines/iaasvm-1",
        "protectionState": "NotProtected",
        "protectableItemType": "Microsoft.ClassicCompute/virtualMachines",
        "backupManagementType": "AzureIaasVM",
        "workloadType": "VM"
      }
    }
  ]
}

Definitions

Name	Description
AzureFileShareProtectableItem	Protectable item for Azure Fileshare workloads.
AzureFileShareType	File Share type XSync or XSMB.
AzureIaaSClassicComputeVMProtectableItem	IaaS VM workload-specific backup item representing the Classic Compute VM.
AzureIaaSComputeVMProtectableItem	IaaS VM workload-specific backup item representing the Azure Resource Manager VM.
AzureVmWorkloadProtectableItem	Azure VM workload-specific protectable item.
AzureVmWorkloadSAPAseSystemProtectableItem	Azure VM workload-specific protectable item representing SAP ASE System.
AzureVmWorkloadSAPHanaDatabaseProtectableItem	Azure VM workload-specific protectable item representing SAP HANA Database.
AzureVmWorkloadSAPHanaDBInstance	Azure VM workload-specific protectable item representing SAP HANA Dbinstance.
AzureVmWorkloadSAPHanaHSRProtectableItem	Azure VM workload-specific protectable item representing HANA HSR.
AzureVmWorkloadSAPHanaSystemProtectableItem	Azure VM workload-specific protectable item representing SAP HANA System.
AzureVmWorkloadSQLAvailabilityGroupProtectableItem	Azure VM workload-specific protectable item representing SQL Availability Group.
AzureVmWorkloadSQLDatabaseProtectableItem	Azure VM workload-specific protectable item representing SQL Database.
AzureVmWorkloadSQLInstanceProtectableItem	Azure VM workload-specific protectable item representing SQL Instance.
CloudError	An error response from the Container Instance service.
CloudErrorBody	An error response from the Container Instance service.
DistributedNodesInfo	This is used to represent the various nodes of the distributed container.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	Error Detail class which encapsulates Code, Message and Recommendations.
IaaSVMProtectableItem	IaaS VM workload-specific backup item.
InquiryStatus	Status of protectable item, i.e. InProgress,Succeeded,Failed
PreBackupValidation	Pre-backup validation for Azure VM Workload provider.
ProtectionStatus	State of the back up item.
WorkloadProtectableItemResource	Base class for backup item. Workload-specific backup items are derived from this class.
WorkloadProtectableItemResourceList	List of WorkloadProtectableItem resources

AzureFileShareProtectableItem

Object

Protectable item for Azure Fileshare workloads.

Name	Type	Description
azureFileShareType	AzureFileShareType	File Share type XSync or XSMB.
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
parentContainerFabricId	string	Full Fabric ID of container to which this protectable item belongs. For example, ARM ID.
parentContainerFriendlyName	string	Friendly name of container to which this protectable item belongs.
protectableItemType	string: AzureFileShare	Type of the backup item.
protectionState	ProtectionStatus	State of the back up item.
workloadType	string	Type of workload for the backup management

AzureFileShareType

Enumeration

File Share type XSync or XSMB.

Value	Description
Invalid
XSMB
XSync

AzureIaaSClassicComputeVMProtectableItem

Object

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

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
protectableItemType	string: Microsoft.ClassicCompute/virtualMachines	Type of the backup item.
protectionState	ProtectionStatus	State of the back up item.
resourceGroup	string	Resource group name of Recovery Services Vault.
virtualMachineId	string	Fully qualified ARM ID of the virtual machine.
virtualMachineVersion	string	Specifies whether the container represents a Classic or an Azure Resource Manager VM.
workloadType	string	Type of workload for the backup management

AzureIaaSComputeVMProtectableItem

Object

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

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
protectableItemType	string: Microsoft.Compute/virtualMachines	Type of the backup item.
protectionState	ProtectionStatus	State of the back up item.
resourceGroup	string	Resource group name of Recovery Services Vault.
virtualMachineId	string	Fully qualified ARM ID of the virtual machine.
virtualMachineVersion	string	Specifies whether the container represents a Classic or an Azure Resource Manager VM.
workloadType	string	Type of workload for the backup management

AzureVmWorkloadProtectableItem

Object

Azure VM workload-specific protectable item.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if protectable item is auto-protectable
isAutoProtected	boolean	Indicates if protectable item is auto-protected
isProtectable	boolean	Indicates if item is protectable
parentName	string	Name for instance or AG
parentUniqueName	string	Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
prebackupvalidation	PreBackupValidation	Pre-backup validation for protectable objects
protectableItemType	string: AzureVmWorkloadProtectableItem	Type of the backup item.
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subinquireditemcount	integer	For instance or AG, indicates number of DB's present
subprotectableitemcount	integer	For instance or AG, indicates number of DB's to be protected
workloadType	string	Type of workload for the backup management

AzureVmWorkloadSAPAseSystemProtectableItem

Object

Azure VM workload-specific protectable item representing SAP ASE System.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if protectable item is auto-protectable
isAutoProtected	boolean	Indicates if protectable item is auto-protected
isProtectable	boolean	Indicates if item is protectable
parentName	string	Name for instance or AG
parentUniqueName	string	Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
prebackupvalidation	PreBackupValidation	Pre-backup validation for protectable objects
protectableItemType	string: SAPAseSystem	Type of the backup item.
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subinquireditemcount	integer	For instance or AG, indicates number of DB's present
subprotectableitemcount	integer	For instance or AG, indicates number of DB's to be protected
workloadType	string	Type of workload for the backup management

AzureVmWorkloadSAPHanaDatabaseProtectableItem

Object

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

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if protectable item is auto-protectable
isAutoProtected	boolean	Indicates if protectable item is auto-protected
isProtectable	boolean	Indicates if item is protectable
parentName	string	Name for instance or AG
parentUniqueName	string	Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
prebackupvalidation	PreBackupValidation	Pre-backup validation for protectable objects
protectableItemType	string: SAPHanaDatabase	Type of the backup item.
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subinquireditemcount	integer	For instance or AG, indicates number of DB's present
subprotectableitemcount	integer	For instance or AG, indicates number of DB's to be protected
workloadType	string	Type of workload for the backup management

AzureVmWorkloadSAPHanaDBInstance

Object

Azure VM workload-specific protectable item representing SAP HANA Dbinstance.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if protectable item is auto-protectable
isAutoProtected	boolean	Indicates if protectable item is auto-protected
isProtectable	boolean	Indicates if item is protectable
parentName	string	Name for instance or AG
parentUniqueName	string	Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
prebackupvalidation	PreBackupValidation	Pre-backup validation for protectable objects
protectableItemType	string: SAPHanaDBInstance	Type of the backup item.
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subinquireditemcount	integer	For instance or AG, indicates number of DB's present
subprotectableitemcount	integer	For instance or AG, indicates number of DB's to be protected
workloadType	string	Type of workload for the backup management

AzureVmWorkloadSAPHanaHSRProtectableItem

Object

Azure VM workload-specific protectable item representing HANA HSR.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if protectable item is auto-protectable
isAutoProtected	boolean	Indicates if protectable item is auto-protected
isProtectable	boolean	Indicates if item is protectable
parentName	string	Name for instance or AG
parentUniqueName	string	Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
prebackupvalidation	PreBackupValidation	Pre-backup validation for protectable objects
protectableItemType	string: HanaHSRContainer	Type of the backup item.
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subinquireditemcount	integer	For instance or AG, indicates number of DB's present
subprotectableitemcount	integer	For instance or AG, indicates number of DB's to be protected
workloadType	string	Type of workload for the backup management

AzureVmWorkloadSAPHanaSystemProtectableItem

Object

Azure VM workload-specific protectable item representing SAP HANA System.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if protectable item is auto-protectable
isAutoProtected	boolean	Indicates if protectable item is auto-protected
isProtectable	boolean	Indicates if item is protectable
parentName	string	Name for instance or AG
parentUniqueName	string	Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
prebackupvalidation	PreBackupValidation	Pre-backup validation for protectable objects
protectableItemType	string: SAPHanaSystem	Type of the backup item.
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subinquireditemcount	integer	For instance or AG, indicates number of DB's present
subprotectableitemcount	integer	For instance or AG, indicates number of DB's to be protected
workloadType	string	Type of workload for the backup management

AzureVmWorkloadSQLAvailabilityGroupProtectableItem

Object

Azure VM workload-specific protectable item representing SQL Availability Group.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if protectable item is auto-protectable
isAutoProtected	boolean	Indicates if protectable item is auto-protected
isProtectable	boolean	Indicates if item is protectable
nodesList	DistributedNodesInfo[]	List of the nodes in case of distributed container.
parentName	string	Name for instance or AG
parentUniqueName	string	Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
prebackupvalidation	PreBackupValidation	Pre-backup validation for protectable objects
protectableItemType	string: SQLAvailabilityGroupContainer	Type of the backup item.
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subinquireditemcount	integer	For instance or AG, indicates number of DB's present
subprotectableitemcount	integer	For instance or AG, indicates number of DB's to be protected
workloadType	string	Type of workload for the backup management

AzureVmWorkloadSQLDatabaseProtectableItem

Object

Azure VM workload-specific protectable item representing SQL Database.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if protectable item is auto-protectable
isAutoProtected	boolean	Indicates if protectable item is auto-protected
isProtectable	boolean	Indicates if item is protectable
parentName	string	Name for instance or AG
parentUniqueName	string	Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
prebackupvalidation	PreBackupValidation	Pre-backup validation for protectable objects
protectableItemType	string: SQLDataBase	Type of the backup item.
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subinquireditemcount	integer	For instance or AG, indicates number of DB's present
subprotectableitemcount	integer	For instance or AG, indicates number of DB's to be protected
workloadType	string	Type of workload for the backup management

AzureVmWorkloadSQLInstanceProtectableItem

Object

Azure VM workload-specific protectable item representing SQL Instance.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
isAutoProtectable	boolean	Indicates if protectable item is auto-protectable
isAutoProtected	boolean	Indicates if protectable item is auto-protected
isProtectable	boolean	Indicates if item is protectable
parentName	string	Name for instance or AG
parentUniqueName	string	Parent Unique Name is added to provide the service formatted URI Name of the Parent Only Applicable for data bases where the parent would be either Instance or a SQL AG.
prebackupvalidation	PreBackupValidation	Pre-backup validation for protectable objects
protectableItemType	string: SQLInstance	Type of the backup item.
protectionState	ProtectionStatus	State of the back up item.
serverName	string	Host/Cluster Name for instance or AG
subinquireditemcount	integer	For instance or AG, indicates number of DB's present
subprotectableitemcount	integer	For instance or AG, indicates number of DB's to be protected
workloadType	string	Type of workload for the backup management

CloudError

Object

An error response from the Container Instance service.

Name	Type	Description
error	CloudErrorBody	The error object.

CloudErrorBody

Object

An error response from the Container Instance service.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	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.

DistributedNodesInfo

Object

This is used to represent the various nodes of the distributed container.

Name	Type	Description
errorDetail	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

ErrorAdditionalInfo

Object

The resource management error additional info.

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

ErrorDetail

Object

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.

IaaSVMProtectableItem

Object

IaaS VM workload-specific backup item.

Name	Type	Description
backupManagementType	string	Type of backup management to backup an item.
friendlyName	string	Friendly name of the backup item.
protectableItemType	string: IaaSVMProtectableItem	Type of the backup item.
protectionState	ProtectionStatus	State of the back up item.
resourceGroup	string	Resource group name of Recovery Services Vault.
virtualMachineId	string	Fully qualified ARM ID of the virtual machine.
virtualMachineVersion	string	Specifies whether the container represents a Classic or an Azure Resource Manager VM.
workloadType	string	Type of workload for the backup management

InquiryStatus

Enumeration

Status of protectable item, i.e. InProgress,Succeeded,Failed

Value	Description
Failed
Invalid
Success

PreBackupValidation

Object

Pre-backup validation for Azure VM Workload provider.

Name	Type	Description
code	string	Error code of protectable item
message	string	Message corresponding to the error code for the protectable item
status	InquiryStatus	Status of protectable item, i.e. InProgress,Succeeded,Failed

ProtectionStatus

Enumeration

State of the back up item.

Value	Description
Invalid
NotProtected
Protected
Protecting
ProtectionFailed

WorkloadProtectableItemResource

Object

Base class for backup item. Workload-specific backup items are derived from this class.

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	WorkloadProtectableItem: AzureFileShareProtectableItem AzureIaaSClassicComputeVMProtectableItem AzureIaaSComputeVMProtectableItem AzureVmWorkloadProtectableItem AzureVmWorkloadSAPAseSystemProtectableItem AzureVmWorkloadSAPHanaDBInstance AzureVmWorkloadSAPHanaDatabaseProtectableItem AzureVmWorkloadSAPHanaHSRProtectableItem AzureVmWorkloadSAPHanaSystemProtectableItem AzureVmWorkloadSQLAvailabilityGroupProtectableItem AzureVmWorkloadSQLDatabaseProtectableItem AzureVmWorkloadSQLInstanceProtectableItem IaaSVMProtectableItem	WorkloadProtectableItemResource properties
tags	object	Resource tags.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

WorkloadProtectableItemResourceList

Object

List of WorkloadProtectableItem resources

Name	Type	Description
nextLink	string	The URI to fetch the next page of resources, with each API call returning up to 200 resources per page. Use ListNext() to fetch the next page if the total number of resources exceeds 200.
value	WorkloadProtectableItemResource[]	List of resources.

Share via

Backup Protectable Items - List

URI Parameters

Responses

Security

azure_auth

Scopes

Examples

List protectable items with backupManagementType filter as AzureIaasVm

Sample request

Sample response

Definitions

AzureFileShareProtectableItem

AzureFileShareType

AzureIaaSClassicComputeVMProtectableItem

AzureIaaSComputeVMProtectableItem

AzureVmWorkloadProtectableItem

AzureVmWorkloadSAPAseSystemProtectableItem

AzureVmWorkloadSAPHanaDatabaseProtectableItem

AzureVmWorkloadSAPHanaDBInstance

AzureVmWorkloadSAPHanaHSRProtectableItem

AzureVmWorkloadSAPHanaSystemProtectableItem

AzureVmWorkloadSQLAvailabilityGroupProtectableItem

AzureVmWorkloadSQLDatabaseProtectableItem

AzureVmWorkloadSQLInstanceProtectableItem

CloudError

CloudErrorBody

DistributedNodesInfo

ErrorAdditionalInfo

ErrorDetail

IaaSVMProtectableItem

InquiryStatus

PreBackupValidation

ProtectionStatus

WorkloadProtectableItemResource

WorkloadProtectableItemResourceList

Additional resources