Microsoft.RecoveryServices (stable:2017-07-01)

2025/10/23 • 8 new, 8 deleted methods

ProtectionIntent_Validate (new)
Description :  It will validate followings 1. Vault capacity 2. VM is already protected 3. Any VM related configuration passed in properties.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupPreValidateProtection
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Enable backup validation request on Virtual Machine ,
Required: True ,
}
{
resourceType:
{
Description: ProtectedItem Type- VM, SqlDataBase, AzureFileShare etc ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
VMwareVM: No description available. ,
SystemState: No description available. ,
Client: No description available. ,
GenericDataSource: No description available. ,
SQLDataBase: No description available. ,
AzureFileShare: No description available. ,
SAPHanaDatabase: No description available. ,
SAPAseDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: ARM Virtual Machine Id ,
Required: False ,
}
string ,
vaultId:
{
Description: ARM id of the Recovery Services Vault ,
Required: False ,
}
string ,
properties:
{
Description: Configuration of VM if any needs to be validated like OS type etc ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
status:
{
Description: Validation Status ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Response error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Response error message ,
Required: False ,
}
string ,
recommendation:
{
Description: Recommended action for user ,
Required: False ,
}
string ,
containerName:
{
Description: Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required for portal ,
Required: False ,
}
string ,
protectedItemName:
{
Description: Specifies the product specific ds name. E.g. vm;iaasvmcontainer;rgname;vmname. This is required for portal ,
Required: False ,
}
string ,
}
BackupStatus_Get (new)
Description :  Get the container backup status
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupStatus
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Container Backup Status Request ,
Required: True ,
}
{
resourceType:
{
Description: Container Type - VM, SQLPaaS, DPM, AzureFileShare... ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
VMwareVM: No description available. ,
SystemState: No description available. ,
Client: No description available. ,
GenericDataSource: No description available. ,
SQLDataBase: No description available. ,
AzureFileShare: No description available. ,
SAPHanaDatabase: No description available. ,
SAPAseDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Entire ARM resource id of the resource ,
Required: False ,
}
string ,
poLogicalName:
{
Description: Protectable Item Logical Name ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
protectionStatus:
{
Description: Specifies whether the container is registered or not ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
vaultId:
{
Description: Specifies the arm resource id of the vault ,
Required: False ,
}
string ,
fabricName:
{
Description: Specifies the fabric name - Azure or AD ,
Enum:
{
Invalid: No description available. ,
Azure: No description available. ,
}
,
Required: False ,
}
enum ,
containerName:
{
Description: Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname. ,
Required: False ,
}
string ,
protectedItemName:
{
Description: Specifies the product specific ds name. E.g. vm;iaasvmcontainer;csname;vmname. ,
Required: False ,
}
string ,
errorCode:
{
Description: ErrorCode in case of intent failed ,
Required: False ,
}
string ,
errorMessage:
{
Description: ErrorMessage in case of intent failed. ,
Required: False ,
}
string ,
policyName:
{
Description: Specifies the policy name which is used for protection ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Container registration status ,
Required: False ,
}
string ,
}
FeatureSupport_Validate (new)
Description :  It will validate if given feature with resource properties is supported in service
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupValidateFeatures
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Feature support request object ,
Required: True ,
}
{
featureType:
{
Description: backup support feature type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
supportStatus:
{
Description: Support status of feature ,
Enum:
{
Invalid: No description available. ,
Supported: No description available. ,
DefaultOFF: No description available. ,
DefaultON: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
ProtectionIntent_Get (new)
Description :  Provides the details of the protection intent up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the backed up item. ,
Required: True ,
}
string ,
intentObjectName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionIntentResource properties ,
Required: False ,
}
{
protectionIntentItemType:
{
Description: backup protectionIntent type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
itemId:
{
Description: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
protectionState:
{
Description: Backup state of this backup item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
ProtectionIntent_CreateOrUpdate (new)
Description :  Create Intent for Enabling backup of an item. This is a synchronous operation.
Reference :  Link ¶

⚼ Request

PUT:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the backup item. ,
Required: True ,
}
string ,
intentObjectName:
{
Description: Intent object name. ,
Required: True ,
}
string ,
parameters:
{
Description: resource backed up item ,
Required: True ,
}
{
properties:
{
Description: ProtectionIntentResource properties ,
Required: False ,
}
{
protectionIntentItemType:
{
Description: backup protectionIntent type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
itemId:
{
Description: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
protectionState:
{
Description: Backup state of this backup item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionIntentResource properties ,
Required: False ,
}
{
protectionIntentItemType:
{
Description: backup protectionIntent type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
itemId:
{
Description: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
protectionState:
{
Description: Backup state of this backup item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
ProtectionIntent_Delete (new)
Description :  Used to remove intent from an item
Reference :  Link ¶

⚼ Request

DELETE:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the intent. ,
Required: True ,
}
string ,
intentObjectName:
{
Description: Intent to be deleted. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
BackupProtectionIntent_List (new)
Description :  Provides a pageable list of all intents that are present within a vault.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectionIntents
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken Filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ProtectionIntentResource properties ,
Required: False ,
}
{
protectionIntentItemType:
{
Description: backup protectionIntent type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
itemId:
{
Description: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
protectionState:
{
Description: Backup state of this backup item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
BackupUsageSummaries_List (new)
Description :  Fetches the backup management usage summaries of the vault.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupUsageSummaries
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken Filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of backup management usages for the given vault. ,
Required: False ,
}
[
{
unit:
{
Description: Unit of the usage. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
}
,
Required: False ,
}
enum ,
quotaPeriod:
{
Description: Quota period of usage. ,
Required: False ,
}
string ,
nextResetTime:
{
Description: Next reset time of usage. ,
Format: date-time ,
Required: False ,
}
string ,
currentValue:
{
Description: Current value of usage. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: Limit of usage. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Name of usage. ,
Required: False ,
}
{
value:
{
Description: Value of usage. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized value of usage. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ProtectionIntent_Validate (removed)
Description :  It will validate followings 1. Vault capacity 2. VM is already protected 3. Any VM related configuration passed in properties.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupPreValidateProtection
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Enable backup validation request on Virtual Machine ,
Required: True ,
}
{
resourceType:
{
Description: ProtectedItem Type- VM, SqlDataBase, AzureFileShare etc ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
VMwareVM: No description available. ,
SystemState: No description available. ,
Client: No description available. ,
GenericDataSource: No description available. ,
SQLDataBase: No description available. ,
AzureFileShare: No description available. ,
SAPHanaDatabase: No description available. ,
SAPAseDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: ARM Virtual Machine Id ,
Required: False ,
}
string ,
vaultId:
{
Description: ARM id of the Recovery Services Vault ,
Required: False ,
}
string ,
properties:
{
Description: Configuration of VM if any needs to be validated like OS type etc ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
status:
{
Description: Validation Status ,
Enum:
{
Invalid: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
errorCode:
{
Description: Response error code ,
Required: False ,
}
string ,
errorMessage:
{
Description: Response error message ,
Required: False ,
}
string ,
recommendation:
{
Description: Recommended action for user ,
Required: False ,
}
string ,
containerName:
{
Description: Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;rgname;vmname. This is required for portal ,
Required: False ,
}
string ,
protectedItemName:
{
Description: Specifies the product specific ds name. E.g. vm;iaasvmcontainer;rgname;vmname. This is required for portal ,
Required: False ,
}
string ,
}
BackupStatus_Get (removed)
Description :  Get the container backup status
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupStatus
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Container Backup Status Request ,
Required: True ,
}
{
resourceType:
{
Description: Container Type - VM, SQLPaaS, DPM, AzureFileShare... ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
VMwareVM: No description available. ,
SystemState: No description available. ,
Client: No description available. ,
GenericDataSource: No description available. ,
SQLDataBase: No description available. ,
AzureFileShare: No description available. ,
SAPHanaDatabase: No description available. ,
SAPAseDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
resourceId:
{
Description: Entire ARM resource id of the resource ,
Required: False ,
}
string ,
poLogicalName:
{
Description: Protectable Item Logical Name ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
protectionStatus:
{
Description: Specifies whether the container is registered or not ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
vaultId:
{
Description: Specifies the arm resource id of the vault ,
Required: False ,
}
string ,
fabricName:
{
Description: Specifies the fabric name - Azure or AD ,
Enum:
{
Invalid: No description available. ,
Azure: No description available. ,
}
,
Required: False ,
}
enum ,
containerName:
{
Description: Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname. ,
Required: False ,
}
string ,
protectedItemName:
{
Description: Specifies the product specific ds name. E.g. vm;iaasvmcontainer;csname;vmname. ,
Required: False ,
}
string ,
errorCode:
{
Description: ErrorCode in case of intent failed ,
Required: False ,
}
string ,
errorMessage:
{
Description: ErrorMessage in case of intent failed. ,
Required: False ,
}
string ,
policyName:
{
Description: Specifies the policy name which is used for protection ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Container registration status ,
Required: False ,
}
string ,
}
FeatureSupport_Validate (removed)
Description :  It will validate if given feature with resource properties is supported in service
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupValidateFeatures
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Feature support request object ,
Required: True ,
}
{
featureType:
{
Description: backup support feature type. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
supportStatus:
{
Description: Support status of feature ,
Enum:
{
Invalid: No description available. ,
Supported: No description available. ,
DefaultOFF: No description available. ,
DefaultON: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}
ProtectionIntent_Get (removed)
Description :  Provides the details of the protection intent up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the backed up item. ,
Required: True ,
}
string ,
intentObjectName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionIntentResource properties ,
Required: False ,
}
{
protectionIntentItemType:
{
Description: backup protectionIntent type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
itemId:
{
Description: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
protectionState:
{
Description: Backup state of this backup item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
ProtectionIntent_CreateOrUpdate (removed)
Description :  Create Intent for Enabling backup of an item. This is a synchronous operation.
Reference :  Link ¶

⚼ Request

PUT:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the backup item. ,
Required: True ,
}
string ,
intentObjectName:
{
Description: Intent object name. ,
Required: True ,
}
string ,
parameters:
{
Description: resource backed up item ,
Required: True ,
}
{
properties:
{
Description: ProtectionIntentResource properties ,
Required: False ,
}
{
protectionIntentItemType:
{
Description: backup protectionIntent type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
itemId:
{
Description: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
protectionState:
{
Description: Backup state of this backup item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionIntentResource properties ,
Required: False ,
}
{
protectionIntentItemType:
{
Description: backup protectionIntent type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
itemId:
{
Description: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
protectionState:
{
Description: Backup state of this backup item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
ProtectionIntent_Delete (removed)
Description :  Used to remove intent from an item
Reference :  Link ¶

⚼ Request

DELETE:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the intent. ,
Required: True ,
}
string ,
intentObjectName:
{
Description: Intent to be deleted. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
BackupProtectionIntent_List (removed)
Description :  Provides a pageable list of all intents that are present within a vault.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectionIntents
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken Filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ProtectionIntentResource properties ,
Required: False ,
}
{
protectionIntentItemType:
{
Description: backup protectionIntent type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
itemId:
{
Description: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
protectionState:
{
Description: Backup state of this backup item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
BackupUsageSummaries_List (removed)
Description :  Fetches the backup management usage summaries of the vault.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupUsageSummaries
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken Filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of backup management usages for the given vault. ,
Required: False ,
}
[
{
unit:
{
Description: Unit of the usage. ,
Enum:
{
Count: No description available. ,
Bytes: No description available. ,
Seconds: No description available. ,
Percent: No description available. ,
CountPerSecond: No description available. ,
BytesPerSecond: No description available. ,
}
,
Required: False ,
}
enum ,
quotaPeriod:
{
Description: Quota period of usage. ,
Required: False ,
}
string ,
nextResetTime:
{
Description: Next reset time of usage. ,
Format: date-time ,
Required: False ,
}
string ,
currentValue:
{
Description: Current value of usage. ,
Format: int64 ,
Required: False ,
}
integer ,
limit:
{
Description: Limit of usage. ,
Format: int64 ,
Required: False ,
}
integer ,
name:
{
Description: Name of usage. ,
Required: False ,
}
{
value:
{
Description: Value of usage. ,
Required: False ,
}
string ,
localizedValue:
{
Description: Localized value of usage. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}