Microsoft.RecoveryServices (preview:2025-02-28)

2025/04/24 • 81 new methods

BackupResourceStorageConfigsNonCRR_Get (new)
Description :  Fetches resource storage config.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: BackupResourceConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestoreFlag:
{
Description: Opt in details of Cross Region Restore feature. ,
Required: False ,
}
boolean ,
dedupState:
{
Description: Vault Dedup state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
xcoolState:
{
Description: Vault x-cool state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupResourceStorageConfigsNonCRR_Update (new)
Description :  Updates vault storage model type.
Reference :  Link ¶

⚼ Request

PUT:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig
{
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 ,
parameters:
{
Description: Vault storage config request ,
Required: True ,
}
{
properties:
{
Description: BackupResourceConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestoreFlag:
{
Description: Opt in details of Cross Region Restore feature. ,
Required: False ,
}
boolean ,
dedupState:
{
Description: Vault Dedup state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
xcoolState:
{
Description: Vault x-cool state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: BackupResourceConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestoreFlag:
{
Description: Opt in details of Cross Region Restore feature. ,
Required: False ,
}
boolean ,
dedupState:
{
Description: Vault Dedup state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
xcoolState:
{
Description: Vault x-cool state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupResourceStorageConfigsNonCRR_patch (new)
Description :  Updates vault storage model type.
Reference :  Link ¶

⚼ Request

PATCH:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig
{
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 ,
parameters:
{
Description: Vault storage config request ,
Required: True ,
}
{
properties:
{
Description: BackupResourceConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestoreFlag:
{
Description: Opt in details of Cross Region Restore feature. ,
Required: False ,
}
boolean ,
dedupState:
{
Description: Vault Dedup state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
xcoolState:
{
Description: Vault x-cool state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
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. ,
SAPHanaDBInstance: 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. ,
SAPHanaDBInstance: 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 ,
protectedItemsCount:
{
Description: Number of protected items ,
Format: int32 ,
Required: False ,
}
integer ,
acquireStorageAccountLock:
{
Description: Specifies whether the storage account lock has been acquired or not ,
Enum:
{
Acquire: No description available. ,
NotAcquire: No description available. ,
}
,
Required: False ,
}
enum ,
}
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: True ,
}
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. ,
Enum:
{
Invalid: No description available. ,
AzureResourceItem: No description available. ,
RecoveryServiceVaultItem: No description available. ,
AzureWorkloadContainerAutoProtectionIntent: No description available. ,
AzureWorkloadAutoProtectionIntent: No description available. ,
AzureWorkloadSQLAutoProtectionIntent: No description available. ,
}
,
Required: True ,
}
enum ,
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. ,
Enum:
{
Invalid: No description available. ,
AzureResourceItem: No description available. ,
RecoveryServiceVaultItem: No description available. ,
AzureWorkloadContainerAutoProtectionIntent: No description available. ,
AzureWorkloadAutoProtectionIntent: No description available. ,
AzureWorkloadSQLAutoProtectionIntent: No description available. ,
}
,
Required: True ,
}
enum ,
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. ,
Enum:
{
Invalid: No description available. ,
AzureResourceItem: No description available. ,
RecoveryServiceVaultItem: No description available. ,
AzureWorkloadContainerAutoProtectionIntent: No description available. ,
AzureWorkloadAutoProtectionIntent: No description available. ,
AzureWorkloadSQLAutoProtectionIntent: No description available. ,
}
,
Required: True ,
}
enum ,
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. ,
Enum:
{
Invalid: No description available. ,
AzureResourceItem: No description available. ,
RecoveryServiceVaultItem: No description available. ,
AzureWorkloadContainerAutoProtectionIntent: No description available. ,
AzureWorkloadAutoProtectionIntent: No description available. ,
AzureWorkloadSQLAutoProtectionIntent: No description available. ,
}
,
Required: True ,
}
enum ,
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 ,
}
,
}
,
]
,
}
Operations_List (new)
Description :  Returns the list of available operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.RecoveryServices/operations
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of available operations. ,
Required: False ,
}
[
{
name:
{
Description: Name of the Operation. ,
Required: False ,
}
string ,
display:
{
Description: Contains the localized display information for this particular operation ,
Required: False ,
}
{
provider:
{
Description: Name of the provider for display purposes ,
Required: False ,
}
string ,
resource:
{
Description: ResourceType for which this Operation can be performed. ,
Required: False ,
}
string ,
operation:
{
Description: Operations Name itself. ,
Required: False ,
}
string ,
description:
{
Description: Description of the operation having details of what operation is about. ,
Required: False ,
}
string ,
}
,
origin:
{
Description: The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX ,
Required: False ,
}
string ,
properties:
{
Description: ShoeBox properties for the given operation. ,
Required: False ,
}
{
serviceSpecification:
{
Description: Operation properties. ,
Required: False ,
}
{
logSpecifications:
{
Description: List of log specifications of this operation. ,
Required: False ,
}
[
{
name:
{
Description: Name for shoebox log specification. ,
Required: False ,
}
string ,
displayName:
{
Description: Localized display name ,
Required: False ,
}
string ,
blobDuration:
{
Description: blob duration of shoebox log specification ,
Required: False ,
}
string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink:
{
Description: Link to the next chunk of Response. ,
Required: False ,
}
string ,
}
BackupResourceVaultConfigs_Get (new)
Description :  Fetches resource vault config.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupconfig/vaultconfig
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: BackupResourceVaultConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
enhancedSecurityState:
{
Description: Enabled or Disabled. ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteFeatureState:
{
Description: Soft Delete feature state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
isSoftDeleteFeatureStateEditable:
{
Description: This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupResourceVaultConfigs_Update (new)
Description :  Updates vault security config.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupconfig/vaultconfig
{
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 ,
parameters:
{
Description: resource config request ,
Required: True ,
}
{
properties:
{
Description: BackupResourceVaultConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
enhancedSecurityState:
{
Description: Enabled or Disabled. ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteFeatureState:
{
Description: Soft Delete feature state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
isSoftDeleteFeatureStateEditable:
{
Description: This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault ,
Required: False ,
}
boolean ,
}
,
}
,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: BackupResourceVaultConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
enhancedSecurityState:
{
Description: Enabled or Disabled. ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteFeatureState:
{
Description: Soft Delete feature state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
isSoftDeleteFeatureStateEditable:
{
Description: This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupResourceVaultConfigs_Put (new)
Description :  Updates vault security config.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupconfig/vaultconfig
{
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 ,
parameters:
{
Description: resource config request ,
Required: True ,
}
{
properties:
{
Description: BackupResourceVaultConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
enhancedSecurityState:
{
Description: Enabled or Disabled. ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteFeatureState:
{
Description: Soft Delete feature state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
isSoftDeleteFeatureStateEditable:
{
Description: This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault ,
Required: False ,
}
boolean ,
}
,
}
,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: BackupResourceVaultConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
enhancedSecurityState:
{
Description: Enabled or Disabled. ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteFeatureState:
{
Description: Soft Delete feature state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
isSoftDeleteFeatureStateEditable:
{
Description: This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupResourceEncryptionConfigs_Get (new)
Description :  Fetches Vault Encryption config.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEncryptionConfigs/backupResourceEncryptionConfig
{
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 ,
}

⚐ Response (200)

{
properties:
{
Description: BackupResourceEncryptionConfigExtendedResource properties ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: User Assigned Identity Id ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: bool to indicate whether to use system Assigned Identity or not ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupResourceEncryptionConfigs_Update (new)
Description :  Updates Vault encryption config.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEncryptionConfigs/backupResourceEncryptionConfig
{
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 ,
parameters:
{
Description: Vault encryption input config request ,
Required: True ,
}
{
properties:
{
Description: BackupResourceEncryptionConfigResource properties ,
Required: False ,
}
{
encryptionAtRestType:
{
Description: Encryption At Rest Type ,
Enum:
{
Invalid: No description available. ,
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
keyUri:
{
Description: Key Vault Key URI ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Key Vault Subscription Id ,
Required: False ,
}
string ,
lastUpdateStatus:
{
Enum:
{
Invalid: No description available. ,
NotEnabled: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyFailed: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Initialized: No description available. ,
FirstInitialization: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryptionState:
{
Enum:
{
Invalid: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnection_Get (new)
Description :  Get Private Endpoint Connection. This call is made by Backup Admin.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: PrivateEndpointConnectionResource properties ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Gets or sets private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Gets or sets id ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnection_Put (new)
Description :  Approve or Reject Private Endpoint requests. This call is made by Backup Admin.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
properties:
{
Description: PrivateEndpointConnectionResource properties ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Gets or sets private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Gets or sets id ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: PrivateEndpointConnectionResource properties ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Gets or sets private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Gets or sets id ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
Description: PrivateEndpointConnectionResource properties ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Gets or sets private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Gets or sets id ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpointConnection_Delete (new)
Description :  Delete Private Endpoint requests. This call is made by Backup Admin.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
PrivateEndpoint_GetOperationStatus (new)
Description :  Gets the operation status for a private endpoint connection.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}/operationsStatus/{operationId}
{
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 ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation id ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ID of the operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Operation start time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: Error code of the operation failure. ,
Required: False ,
}
string ,
message:
{
Description: Error message displayed if the operation failure. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GetOperationStatus (new)
Description :  Fetches operation status for data move operation on vault
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/operationStatus/{operationId}
{
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 ,
operationId:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ID of the operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Operation start time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: Error code of the operation failure. ,
Required: False ,
}
string ,
message:
{
Description: Error message displayed if the operation failure. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BMSPrepareDataMove (new)
Description :  Prepares source vault for Data Move operation
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/prepareDataMove
{
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 ,
parameters:
{
Description: Prepare data move request ,
Required: True ,
}
{
targetResourceId:
{
Description: ARM Id of target vault ,
Required: True ,
}
string ,
targetRegion:
{
Description: Target Region ,
Required: True ,
}
string ,
dataMoveLevel:
{
Description: DataMove Level ,
Enum:
{
Invalid: No description available. ,
Vault: No description available. ,
Container: No description available. ,
}
,
Required: True ,
}
enum ,
sourceContainerArmIds:
{
Description: Source Container ArmIds This needs to be populated only if DataMoveLevel is set to container ,
Required: False ,
}
[
string ,
]
,
ignoreMoved:
{
Description: Ignore the artifacts which are already moved. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BMSPrepareDataMoveOperationResult_Get (new)
Description :  Fetches Operation Result for Prepare Data Move
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/operationResults/{operationId}
{
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 ,
operationId:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BMSTriggerDataMove (new)
Description :  Triggers Data Move Operation on target vault
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/triggerDataMove
{
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 ,
parameters:
{
Description: Trigger data move request ,
Required: True ,
}
{
sourceResourceId:
{
Description: ARM Id of source vault ,
Required: True ,
}
string ,
sourceRegion:
{
Description: Source Region ,
Required: True ,
}
string ,
dataMoveLevel:
{
Description: DataMove Level ,
Enum:
{
Invalid: No description available. ,
Vault: No description available. ,
Container: No description available. ,
}
,
Required: True ,
}
enum ,
correlationId:
{
Description: Correlation Id ,
Required: True ,
}
string ,
sourceContainerArmIds:
{
Description: Source Container ArmIds ,
Required: False ,
}
[
string ,
]
,
pauseGC:
{
Description: Pause GC ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItems_Get (new)
Description :  Provides the details of the backed 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}/protectionContainers/{containerName}/protectedItems/{protectedItemName}
{
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 ,
containerName:
{
Description: Container name associated with the backed up item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectedItemResource properties ,
Required: False ,
}
{
protectedItemType:
{
Description: backup item type. ,
Required: True ,
}
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 ,
workloadType:
{
Description: Type of workload this item represents. ,
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. ,
SAPHanaDBInstance: No description available. ,
}
,
Required: False ,
}
enum ,
containerName:
{
Description: Unique name of container ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: Timestamp when the last (latest) backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
backupSetName:
{
Description: Name of the backup set the backup item belongs to ,
Required: False ,
}
string ,
createMode:
{
Description: Create mode to indicate recovery of existing soft deleted data source or creation of new data source. ,
Enum:
{
Invalid: No description available. ,
Default: No description available. ,
Recover: No description available. ,
}
,
Required: False ,
}
enum ,
deferredDeleteTimeInUTC:
{
Description: Time for deferred deletion in UTC ,
Format: date-time ,
Required: False ,
}
string ,
isScheduledForDeferredDelete:
{
Description: Flag to identify whether the DS is scheduled for deferred delete ,
Required: False ,
}
boolean ,
deferredDeleteTimeRemaining:
{
Description: Time remaining before the DS marked for deferred delete is permanently deleted ,
Required: False ,
}
string ,
isDeferredDeleteScheduleUpcoming:
{
Description: Flag to identify whether the deferred deleted DS is to be purged soon ,
Required: False ,
}
boolean ,
isRehydrate:
{
Description: Flag to identify that deferred deleted DS is to be moved into Pause state ,
Required: False ,
}
boolean ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
isArchiveEnabled:
{
Description: Flag to identify whether datasource is protected in archive ,
Required: False ,
}
boolean ,
policyName:
{
Description: Name of the policy used for protection ,
Required: False ,
}
string ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
vaultId:
{
Description: ID of the vault which protects this item ,
Required: False ,
}
string ,
sourceSideScanInfo:
{
Description: Source side threat information ,
Required: False ,
}
{
sourceSideScanStatus:
{
Description: Threat status of the container ,
Enum:
{
Configured: No description available. ,
NotConfigured: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
sourceSideScanSummary:
{
Description: Threat summary for the container ,
Enum:
{
Unknown: No description available. ,
NotApplicable: No description available. ,
Suspicious: No description available. ,
Healthy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItems_CreateOrUpdate (new)
Description :  Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}
{
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 ,
containerName:
{
Description: Container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Item name to be backed up. ,
Required: True ,
}
string ,
parameters:
{
Description: resource backed up item ,
Required: True ,
}
{
properties:
{
Description: ProtectedItemResource properties ,
Required: False ,
}
{
protectedItemType:
{
Description: backup item type. ,
Required: True ,
}
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 ,
workloadType:
{
Description: Type of workload this item represents. ,
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. ,
SAPHanaDBInstance: No description available. ,
}
,
Required: False ,
}
enum ,
containerName:
{
Description: Unique name of container ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: Timestamp when the last (latest) backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
backupSetName:
{
Description: Name of the backup set the backup item belongs to ,
Required: False ,
}
string ,
createMode:
{
Description: Create mode to indicate recovery of existing soft deleted data source or creation of new data source. ,
Enum:
{
Invalid: No description available. ,
Default: No description available. ,
Recover: No description available. ,
}
,
Required: False ,
}
enum ,
deferredDeleteTimeInUTC:
{
Description: Time for deferred deletion in UTC ,
Format: date-time ,
Required: False ,
}
string ,
isScheduledForDeferredDelete:
{
Description: Flag to identify whether the DS is scheduled for deferred delete ,
Required: False ,
}
boolean ,
deferredDeleteTimeRemaining:
{
Description: Time remaining before the DS marked for deferred delete is permanently deleted ,
Required: False ,
}
string ,
isDeferredDeleteScheduleUpcoming:
{
Description: Flag to identify whether the deferred deleted DS is to be purged soon ,
Required: False ,
}
boolean ,
isRehydrate:
{
Description: Flag to identify that deferred deleted DS is to be moved into Pause state ,
Required: False ,
}
boolean ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
isArchiveEnabled:
{
Description: Flag to identify whether datasource is protected in archive ,
Required: False ,
}
boolean ,
policyName:
{
Description: Name of the policy used for protection ,
Required: False ,
}
string ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
vaultId:
{
Description: ID of the vault which protects this item ,
Required: False ,
}
string ,
sourceSideScanInfo:
{
Description: Source side threat information ,
Required: False ,
}
{
sourceSideScanStatus:
{
Description: Threat status of the container ,
Enum:
{
Configured: No description available. ,
NotConfigured: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
sourceSideScanSummary:
{
Description: Threat summary for the container ,
Enum:
{
Unknown: No description available. ,
NotApplicable: No description available. ,
Suspicious: No description available. ,
Healthy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectedItemResource properties ,
Required: False ,
}
{
protectedItemType:
{
Description: backup item type. ,
Required: True ,
}
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 ,
workloadType:
{
Description: Type of workload this item represents. ,
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. ,
SAPHanaDBInstance: No description available. ,
}
,
Required: False ,
}
enum ,
containerName:
{
Description: Unique name of container ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: Timestamp when the last (latest) backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
backupSetName:
{
Description: Name of the backup set the backup item belongs to ,
Required: False ,
}
string ,
createMode:
{
Description: Create mode to indicate recovery of existing soft deleted data source or creation of new data source. ,
Enum:
{
Invalid: No description available. ,
Default: No description available. ,
Recover: No description available. ,
}
,
Required: False ,
}
enum ,
deferredDeleteTimeInUTC:
{
Description: Time for deferred deletion in UTC ,
Format: date-time ,
Required: False ,
}
string ,
isScheduledForDeferredDelete:
{
Description: Flag to identify whether the DS is scheduled for deferred delete ,
Required: False ,
}
boolean ,
deferredDeleteTimeRemaining:
{
Description: Time remaining before the DS marked for deferred delete is permanently deleted ,
Required: False ,
}
string ,
isDeferredDeleteScheduleUpcoming:
{
Description: Flag to identify whether the deferred deleted DS is to be purged soon ,
Required: False ,
}
boolean ,
isRehydrate:
{
Description: Flag to identify that deferred deleted DS is to be moved into Pause state ,
Required: False ,
}
boolean ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
isArchiveEnabled:
{
Description: Flag to identify whether datasource is protected in archive ,
Required: False ,
}
boolean ,
policyName:
{
Description: Name of the policy used for protection ,
Required: False ,
}
string ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
vaultId:
{
Description: ID of the vault which protects this item ,
Required: False ,
}
string ,
sourceSideScanInfo:
{
Description: Source side threat information ,
Required: False ,
}
{
sourceSideScanStatus:
{
Description: Threat status of the container ,
Enum:
{
Configured: No description available. ,
NotConfigured: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
sourceSideScanSummary:
{
Description: Threat summary for the container ,
Enum:
{
Unknown: No description available. ,
NotApplicable: No description available. ,
Suspicious: No description available. ,
Healthy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItems_Delete (new)
Description :  Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the request, call the GetItemOperationResult API.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}
{
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 ,
containerName:
{
Description: Container name associated with the backed up item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item to be deleted. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItemOperationResults_Get (new)
Description :  Fetches the result of any operation on the backup item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationResults/{operationId}
{
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 ,
containerName:
{
Description: Container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backup item name whose details are to be fetched. ,
Required: True ,
}
string ,
operationId:
{
Description: OperationID which represents the operation whose result needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectedItemResource properties ,
Required: False ,
}
{
protectedItemType:
{
Description: backup item type. ,
Required: True ,
}
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 ,
workloadType:
{
Description: Type of workload this item represents. ,
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. ,
SAPHanaDBInstance: No description available. ,
}
,
Required: False ,
}
enum ,
containerName:
{
Description: Unique name of container ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: Timestamp when the last (latest) backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
backupSetName:
{
Description: Name of the backup set the backup item belongs to ,
Required: False ,
}
string ,
createMode:
{
Description: Create mode to indicate recovery of existing soft deleted data source or creation of new data source. ,
Enum:
{
Invalid: No description available. ,
Default: No description available. ,
Recover: No description available. ,
}
,
Required: False ,
}
enum ,
deferredDeleteTimeInUTC:
{
Description: Time for deferred deletion in UTC ,
Format: date-time ,
Required: False ,
}
string ,
isScheduledForDeferredDelete:
{
Description: Flag to identify whether the DS is scheduled for deferred delete ,
Required: False ,
}
boolean ,
deferredDeleteTimeRemaining:
{
Description: Time remaining before the DS marked for deferred delete is permanently deleted ,
Required: False ,
}
string ,
isDeferredDeleteScheduleUpcoming:
{
Description: Flag to identify whether the deferred deleted DS is to be purged soon ,
Required: False ,
}
boolean ,
isRehydrate:
{
Description: Flag to identify that deferred deleted DS is to be moved into Pause state ,
Required: False ,
}
boolean ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
isArchiveEnabled:
{
Description: Flag to identify whether datasource is protected in archive ,
Required: False ,
}
boolean ,
policyName:
{
Description: Name of the policy used for protection ,
Required: False ,
}
string ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
vaultId:
{
Description: ID of the vault which protects this item ,
Required: False ,
}
string ,
sourceSideScanInfo:
{
Description: Source side threat information ,
Required: False ,
}
{
sourceSideScanStatus:
{
Description: Threat status of the container ,
Enum:
{
Configured: No description available. ,
NotConfigured: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
sourceSideScanSummary:
{
Description: Threat summary for the container ,
Enum:
{
Unknown: No description available. ,
NotApplicable: No description available. ,
Suspicious: No description available. ,
Healthy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPoints_List (new)
Description :  Lists the backup copies for the backed up item.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints
{
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 ,
containerName:
{
Description: Container name associated with the backed up item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item whose backup copies are to be fetched. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: RecoveryPointResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
threatStatus:
{
Description: Threat status of the recovery point ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
UnHealthy: No description available. ,
Warning: No description available. ,
NotAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
threatInfo:
{
Description: Recovery point threat information. ,
Required: False ,
}
[
{
threatTitle:
{
Description: Threat Subject ,
Required: False ,
}
string ,
threatDescription:
{
Description: Threat Description ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Timestamp when the last (latest)threat information was sent ,
Format: date-time ,
Required: False ,
}
string ,
threatState:
{
Description: Threat Status Types ,
Enum:
{
Active: No description available. ,
InProgress: No description available. ,
Ignored: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
threatStartTime:
{
Description: Start timestamp of the threat ,
Format: date-time ,
Required: False ,
}
string ,
threatEndTime:
{
Description: End timestamp of the threat ,
Format: date-time ,
Required: False ,
}
string ,
threatURI:
{
Description: threat details link ,
Format: uri ,
Required: False ,
}
string ,
threatSeverity:
{
Description: Threat Severity Types ,
Enum:
{
Critical: No description available. ,
High: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPoints_Get (new)
Description :  Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation. To know the status of the operation, call the GetProtectedItemOperationResult API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}
{
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 backed up item. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name associated with backed up item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose backup data needs to be fetched. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: RecoveryPointID represents the backed up data to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: RecoveryPointResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
threatStatus:
{
Description: Threat status of the recovery point ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
UnHealthy: No description available. ,
Warning: No description available. ,
NotAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
threatInfo:
{
Description: Recovery point threat information. ,
Required: False ,
}
[
{
threatTitle:
{
Description: Threat Subject ,
Required: False ,
}
string ,
threatDescription:
{
Description: Threat Description ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Timestamp when the last (latest)threat information was sent ,
Format: date-time ,
Required: False ,
}
string ,
threatState:
{
Description: Threat Status Types ,
Enum:
{
Active: No description available. ,
InProgress: No description available. ,
Ignored: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
threatStartTime:
{
Description: Start timestamp of the threat ,
Format: date-time ,
Required: False ,
}
string ,
threatEndTime:
{
Description: End timestamp of the threat ,
Format: date-time ,
Required: False ,
}
string ,
threatURI:
{
Description: threat details link ,
Format: uri ,
Required: False ,
}
string ,
threatSeverity:
{
Description: Threat Severity Types ,
Enum:
{
Critical: No description available. ,
High: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPoints_Update (new)
Description :  UpdateRecoveryPoint to update recovery point for given RecoveryPointID.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with backed up item. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name associated with backed up item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose backup data needs to be fetched. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: RecoveryPointID represents the backed up data to be fetched. ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
properties:
{
Description: Resource properties. ,
Required: False ,
}
{
recoveryPointProperties:
{
Description: Properties of Recovery Point ,
Required: False ,
}
{
expiryTime:
{
Description: Expiry time of Recovery Point in UTC. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: RecoveryPointResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
threatStatus:
{
Description: Threat status of the recovery point ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
UnHealthy: No description available. ,
Warning: No description available. ,
NotAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
threatInfo:
{
Description: Recovery point threat information. ,
Required: False ,
}
[
{
threatTitle:
{
Description: Threat Subject ,
Required: False ,
}
string ,
threatDescription:
{
Description: Threat Description ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Timestamp when the last (latest)threat information was sent ,
Format: date-time ,
Required: False ,
}
string ,
threatState:
{
Description: Threat Status Types ,
Enum:
{
Active: No description available. ,
InProgress: No description available. ,
Ignored: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
threatStartTime:
{
Description: Start timestamp of the threat ,
Format: date-time ,
Required: False ,
}
string ,
threatEndTime:
{
Description: End timestamp of the threat ,
Format: date-time ,
Required: False ,
}
string ,
threatURI:
{
Description: threat details link ,
Format: uri ,
Required: False ,
}
string ,
threatSeverity:
{
Description: Threat Severity Types ,
Enum:
{
Critical: No description available. ,
High: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Restores_Trigger (new)
Description :  Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use GetProtectedItemOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/restore
{
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 items. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name associated with the backed up items. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item to be restored. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: Recovery point ID which represents the backed up data to be restored. ,
Required: True ,
}
string ,
parameters:
{
Description: resource restore request ,
Required: True ,
}
{
properties:
{
Description: RestoreRequestResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupPolicies_List (new)
Description :  Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch scoped results.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ProtectionPolicyResource properties ,
Required: False ,
}
{
protectedItemsCount:
{
Description: Number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectionPolicies_Get (new)
Description :  Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}
{
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 ,
policyName:
{
Description: Backup policy information to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionPolicyResource properties ,
Required: False ,
}
{
protectedItemsCount:
{
Description: Number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectionPolicies_CreateOrUpdate (new)
Description :  Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}
{
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 ,
policyName:
{
Description: Backup policy to be created. ,
Required: True ,
}
string ,
parameters:
{
Description: resource backup policy ,
Required: True ,
}
{
properties:
{
Description: ProtectionPolicyResource properties ,
Required: False ,
}
{
protectedItemsCount:
{
Description: Number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionPolicyResource properties ,
Required: False ,
}
{
protectedItemsCount:
{
Description: Number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectionPolicies_Delete (new)
Description :  Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the operation can be fetched using GetProtectionPolicyOperationResult API.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}
{
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 ,
policyName:
{
Description: Backup policy to be deleted. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectionPolicyOperationResults_Get (new)
Description :  Provides the result of an operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}/operationResults/{operationId}
{
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 ,
policyName:
{
Description: Backup policy name whose operation's result needs to be fetched. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation ID which represents the operation whose result needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionPolicyResource properties ,
Required: False ,
}
{
protectedItemsCount:
{
Description: Number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupJobs_List (new)
Description :  Provides a pageable list of jobs.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs
{
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: JobResource properties ,
Required: False ,
}
{
entityFriendlyName:
{
Description: Friendly name of the entity on which the current job is executing. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Backup management type to execute the current job. ,
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 ,
operation:
{
Description: The operation name. ,
Required: False ,
}
string ,
status:
{
Description: Job status. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
activityId:
{
Description: ActivityId of job. ,
Required: False ,
}
string ,
jobType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobDetails_Get (new)
Description :  Gets extended information associated with the job.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}
{
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 ,
jobName:
{
Description: Name of the job whose details are to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: JobResource properties ,
Required: False ,
}
{
entityFriendlyName:
{
Description: Friendly name of the entity on which the current job is executing. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Backup management type to execute the current job. ,
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 ,
operation:
{
Description: The operation name. ,
Required: False ,
}
string ,
status:
{
Description: Job status. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
activityId:
{
Description: ActivityId of job. ,
Required: False ,
}
string ,
jobType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobCancellations_Trigger (new)
Description :  Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call GetCancelOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/cancel
{
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 ,
jobName:
{
Description: Name of the job to cancel. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobOperationResults_Get (new)
Description :  Fetches the result of any operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/operationResults/{operationId}
{
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 ,
jobName:
{
Description: Job name whose operation result has to be fetched. ,
Required: True ,
}
string ,
operationId:
{
Description: OperationID which represents the operation whose result has to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ExportJobsOperationResults_Get (new)
Description :  Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also contains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/operationResults/{operationId}
{
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 ,
operationId:
{
Description: OperationID which represents the export job. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
operation:
{
Description: OperationResultInfoBaseResource operation ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
operation:
{
Description: OperationResultInfoBaseResource operation ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Jobs_Export (new)
Description :  Triggers export of jobs specified by filters and returns an OperationID to track.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobsExport
{
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 ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupProtectedItems_List (new)
Description :  Provides a pageable list of all items that are backed up within a vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectedItems
{
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: ProtectedItemResource properties ,
Required: False ,
}
{
protectedItemType:
{
Description: backup item type. ,
Required: True ,
}
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 ,
workloadType:
{
Description: Type of workload this item represents. ,
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. ,
SAPHanaDBInstance: No description available. ,
}
,
Required: False ,
}
enum ,
containerName:
{
Description: Unique name of container ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: Timestamp when the last (latest) backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
backupSetName:
{
Description: Name of the backup set the backup item belongs to ,
Required: False ,
}
string ,
createMode:
{
Description: Create mode to indicate recovery of existing soft deleted data source or creation of new data source. ,
Enum:
{
Invalid: No description available. ,
Default: No description available. ,
Recover: No description available. ,
}
,
Required: False ,
}
enum ,
deferredDeleteTimeInUTC:
{
Description: Time for deferred deletion in UTC ,
Format: date-time ,
Required: False ,
}
string ,
isScheduledForDeferredDelete:
{
Description: Flag to identify whether the DS is scheduled for deferred delete ,
Required: False ,
}
boolean ,
deferredDeleteTimeRemaining:
{
Description: Time remaining before the DS marked for deferred delete is permanently deleted ,
Required: False ,
}
string ,
isDeferredDeleteScheduleUpcoming:
{
Description: Flag to identify whether the deferred deleted DS is to be purged soon ,
Required: False ,
}
boolean ,
isRehydrate:
{
Description: Flag to identify that deferred deleted DS is to be moved into Pause state ,
Required: False ,
}
boolean ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
isArchiveEnabled:
{
Description: Flag to identify whether datasource is protected in archive ,
Required: False ,
}
boolean ,
policyName:
{
Description: Name of the policy used for protection ,
Required: False ,
}
string ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
vaultId:
{
Description: ID of the vault which protects this item ,
Required: False ,
}
string ,
sourceSideScanInfo:
{
Description: Source side threat information ,
Required: False ,
}
{
sourceSideScanStatus:
{
Description: Threat status of the container ,
Enum:
{
Configured: No description available. ,
NotConfigured: No description available. ,
NotApplicable: No description available. ,
}
,
Required: False ,
}
enum ,
sourceSideScanSummary:
{
Description: Threat summary for the container ,
Enum:
{
Unknown: No description available. ,
NotApplicable: No description available. ,
Suspicious: No description available. ,
Healthy: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operation_Validate (new)
Description :  Validate operation for specified backed up item. This is a synchronous operation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperation
{
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 ,
parameters:
{
Description: resource validate operation request ,
Required: True ,
}
{
id:
{
Description: Recovery point ID. ,
Required: True ,
}
string ,
properties:
{
Description: ValidateOperationRequestResource properties ,
Required: True ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
validateOperationResponse:
{
Description: Base class for validate operation response. ,
Required: False ,
}
{
validationResults:
{
Description: Gets the validation result ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error Message related to the Code. ,
Required: False ,
}
string ,
recommendations:
{
Description: List of recommendation strings. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ValidateOperation_Trigger (new)
Description :  Validate operation for specified backed up item in the form of an asynchronous operation. Returns tracking headers which can be tracked using GetValidateOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupTriggerValidateOperation
{
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 ,
parameters:
{
Description: resource validate operation request ,
Required: True ,
}
{
id:
{
Description: Recovery point ID. ,
Required: True ,
}
string ,
properties:
{
Description: ValidateOperationRequestResource properties ,
Required: True ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ValidateOperationResults_Get (new)
Description :  Fetches the result of a triggered validate operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperationResults/{operationId}
{
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 ,
operationId:
{
Description: OperationID which represents the operation whose result needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
validateOperationResponse:
{
Description: Base class for validate operation response. ,
Required: False ,
}
{
validationResults:
{
Description: Gets the validation result ,
Required: False ,
}
[
{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error Message related to the Code. ,
Required: False ,
}
string ,
recommendations:
{
Description: List of recommendation strings. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ValidateOperationStatuses_Get (new)
Description :  Fetches the status of a triggered validate operation. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of the operation. If operation has completed, this method returns the list of errors obtained while validating the operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperationsStatuses/{operationId}
{
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 ,
operationId:
{
Description: OperationID represents the operation whose status needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ID of the operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Operation start time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: Error code of the operation failure. ,
Required: False ,
}
string ,
message:
{
Description: Error message displayed if the operation failure. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupEngines_List (new)
Description :  Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEngines
{
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: BackupEngineBaseResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the backup engine. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backup engine. ,
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 ,
registrationStatus:
{
Description: Registration status of the backup engine with the Recovery Services Vault. ,
Required: False ,
}
string ,
backupEngineState:
{
Description: Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed} ,
Required: False ,
}
string ,
healthStatus:
{
Description: Backup status of the backup engine. ,
Required: False ,
}
string ,
backupEngineType:
{
Description: Type of the backup engine. ,
Enum:
{
Invalid: No description available. ,
DpmBackupEngine: No description available. ,
AzureBackupServerEngine: No description available. ,
}
,
Required: True ,
}
enum ,
canReRegister:
{
Description: Flag indicating if the backup engine be registered, once already registered. ,
Required: False ,
}
boolean ,
backupEngineId:
{
Description: ID of the backup engine. ,
Required: False ,
}
string ,
dpmVersion:
{
Description: Backup engine version ,
Required: False ,
}
string ,
azureBackupAgentVersion:
{
Description: Backup agent version ,
Required: False ,
}
string ,
isAzureBackupAgentUpgradeAvailable:
{
Description: To check if backup agent upgrade available ,
Required: False ,
}
boolean ,
isDpmUpgradeAvailable:
{
Description: To check if backup engine upgrade available ,
Required: False ,
}
boolean ,
extendedInfo:
{
Description: Extended info of the backupengine ,
Required: False ,
}
{
databaseName:
{
Description: Database name of backup engine. ,
Required: False ,
}
string ,
protectedItemsCount:
{
Description: Number of protected items in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
protectedServersCount:
{
Description: Number of protected servers in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
diskCount:
{
Description: Number of disks in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDiskSpace:
{
Description: Disk space used in the backup engine. ,
Format: double ,
Required: False ,
}
number ,
availableDiskSpace:
{
Description: Disk space currently available in the backup engine. ,
Format: double ,
Required: False ,
}
number ,
refreshedAt:
{
Description: Last refresh time in the backup engine. ,
Format: date-time ,
Required: False ,
}
string ,
azureProtectedInstances:
{
Description: Protected instances in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupEngines_Get (new)
Description :  Returns backup management server registered to Recovery Services Vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEngines/{backupEngineName}
{
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 ,
backupEngineName:
{
Description: Name of the backup management server. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken Filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: BackupEngineBaseResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the backup engine. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backup engine. ,
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 ,
registrationStatus:
{
Description: Registration status of the backup engine with the Recovery Services Vault. ,
Required: False ,
}
string ,
backupEngineState:
{
Description: Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed} ,
Required: False ,
}
string ,
healthStatus:
{
Description: Backup status of the backup engine. ,
Required: False ,
}
string ,
backupEngineType:
{
Description: Type of the backup engine. ,
Enum:
{
Invalid: No description available. ,
DpmBackupEngine: No description available. ,
AzureBackupServerEngine: No description available. ,
}
,
Required: True ,
}
enum ,
canReRegister:
{
Description: Flag indicating if the backup engine be registered, once already registered. ,
Required: False ,
}
boolean ,
backupEngineId:
{
Description: ID of the backup engine. ,
Required: False ,
}
string ,
dpmVersion:
{
Description: Backup engine version ,
Required: False ,
}
string ,
azureBackupAgentVersion:
{
Description: Backup agent version ,
Required: False ,
}
string ,
isAzureBackupAgentUpgradeAvailable:
{
Description: To check if backup agent upgrade available ,
Required: False ,
}
boolean ,
isDpmUpgradeAvailable:
{
Description: To check if backup engine upgrade available ,
Required: False ,
}
boolean ,
extendedInfo:
{
Description: Extended info of the backupengine ,
Required: False ,
}
{
databaseName:
{
Description: Database name of backup engine. ,
Required: False ,
}
string ,
protectedItemsCount:
{
Description: Number of protected items in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
protectedServersCount:
{
Description: Number of protected servers in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
diskCount:
{
Description: Number of disks in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDiskSpace:
{
Description: Disk space used in the backup engine. ,
Format: double ,
Required: False ,
}
number ,
availableDiskSpace:
{
Description: Disk space currently available in the backup engine. ,
Format: double ,
Required: False ,
}
number ,
refreshedAt:
{
Description: Last refresh time in the backup engine. ,
Format: date-time ,
Required: False ,
}
string ,
azureProtectedInstances:
{
Description: Protected instances in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectionContainerRefreshOperationResults_Get (new)
Description :  Provides the result of the refresh operation triggered by the BeginRefresh operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/operationResults/{operationId}
{
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 container. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation ID associated with the operation whose result needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectableContainers_List (new)
Description :  Lists the containers that can be registered to Recovery Services Vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectableContainers
{
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:
{
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ProtectableContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
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 ,
protectableContainerType:
{
Description: Type of the container. The value of this property for 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
Microsoft.ClassicCompute/virtualMachines: No description available. ,
Microsoft.Compute/virtualMachines: No description available. ,
AzureWorkloadContainer: No description available. ,
}
,
Required: True ,
}
enum ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerId:
{
Description: Fabric Id of the container such as ARM Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectionContainers_Get (new)
Description :  Gets details of the specific container registered to your Recovery Services Vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}
{
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: Name of the fabric where the container belongs. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
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 ,
registrationStatus:
{
Description: Status of registration of the container with the Recovery Services Vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerType:
{
Description: Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
Microsoft.ClassicCompute/virtualMachines: No description available. ,
Microsoft.Compute/virtualMachines: No description available. ,
AzureWorkloadContainer: No description available. ,
}
,
Required: True ,
}
enum ,
protectableObjectType:
{
Description: Type of the protectable object associated with this container ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectionContainers_Register (new)
Description :  Registers the container with Recovery Services vault. This is an asynchronous operation. To track the operation status, use location header to call get latest status of the operation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}
{
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 container. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container to be registered. ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
properties:
{
Description: ProtectionContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
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 ,
registrationStatus:
{
Description: Status of registration of the container with the Recovery Services Vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerType:
{
Description: Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
Microsoft.ClassicCompute/virtualMachines: No description available. ,
Microsoft.Compute/virtualMachines: No description available. ,
AzureWorkloadContainer: No description available. ,
}
,
Required: True ,
}
enum ,
protectableObjectType:
{
Description: Type of the protectable object associated with this container ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
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 ,
registrationStatus:
{
Description: Status of registration of the container with the Recovery Services Vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerType:
{
Description: Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
Microsoft.ClassicCompute/virtualMachines: No description available. ,
Microsoft.Compute/virtualMachines: No description available. ,
AzureWorkloadContainer: No description available. ,
}
,
Required: True ,
}
enum ,
protectableObjectType:
{
Description: Type of the protectable object associated with this container ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectionContainers_Unregister (new)
Description :  Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine whether the backend service has finished processing the request, call Get Container Operation Result API.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}
{
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: Name of the fabric where the container belongs. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container which needs to be unregistered from the Recovery Services Vault. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectionContainers_Inquire (new)
Description :  This is an async operation and the results should be tracked using location header or Azure-async-url.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/inquire
{
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 container. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container in which inquiry needs to be triggered. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupWorkloadItems_List (new)
Description :  Provides a pageable list of workload item of a specific container according to the query filter and the pagination parameters.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/items
{
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 container. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container. ,
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: WorkloadItemResource properties ,
Required: False ,
}
{
backupManagementType:
{
Description: Type of backup management to backup an item. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of workload for the backup management ,
Required: False ,
}
string ,
workloadItemType:
{
Description: Type of the backup item. ,
Required: True ,
}
string ,
friendlyName:
{
Description: Friendly name of the backup item. ,
Required: False ,
}
string ,
protectionState:
{
Description: State of the back up 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 (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectionContainerOperationResults_Get (new)
Description :  Fetches the result of any operation on the container.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/operationResults/{operationId}
{
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 container. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name whose information should be fetched. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation ID which represents the operation whose result needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
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 ,
registrationStatus:
{
Description: Status of registration of the container with the Recovery Services Vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerType:
{
Description: Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
Microsoft.ClassicCompute/virtualMachines: No description available. ,
Microsoft.Compute/virtualMachines: No description available. ,
AzureWorkloadContainer: No description available. ,
}
,
Required: True ,
}
enum ,
protectableObjectType:
{
Description: Type of the protectable object associated with this container ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Backups_Trigger (new)
Description :  Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the operation, call GetProtectedItemOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/backup
{
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 ,
containerName:
{
Description: Container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backup item for which backup needs to be triggered. ,
Required: True ,
}
string ,
parameters:
{
Description: resource backup request ,
Required: True ,
}
{
properties:
{
Description: BackupRequestResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectedItemOperationStatuses_Get (new)
Description :  Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations create jobs. This method returns the list of jobs associated with the operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationsStatus/{operationId}
{
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 ,
containerName:
{
Description: Container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backup item name whose details are to be fetched. ,
Required: True ,
}
string ,
operationId:
{
Description: OperationID represents the operation whose status needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ID of the operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Operation start time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: Error code of the operation failure. ,
Required: False ,
}
string ,
message:
{
Description: Error message displayed if the operation failure. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ItemLevelRecoveryConnections_Provision (new)
Description :  Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file explorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of provisioning, call GetProtectedItemOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/provisionInstantItemRecovery
{
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 items. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name associated with the backed up items. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose files/folders are to be restored. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: Recovery point ID which represents backed up data. iSCSI connection will be provisioned for this backed up data. ,
Required: True ,
}
string ,
parameters:
{
Description: resource ILR request ,
Required: True ,
}
{
properties:
{
Description: ILRRequestResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ItemLevelRecoveryConnections_Revoke (new)
Description :  Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer displaying all recoverable files and folders. This is an asynchronous operation.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/revokeInstantItemRecovery
{
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 items. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name associated with the backed up items. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose files/folders are to be restored. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: Recovery point ID which represents backed up data. iSCSI connection will be revoked for this backed up data. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectionContainers_Refresh (new)
Description :  Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an asynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/refreshContainers
{
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 the container. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupOperationResults_Get (new)
Description :  Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the status code in the response would be Accepted. It will continue to be in this state till it reaches completion. On successful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is part of the Location header of the operation response.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupOperationResults/{operationId}
{
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 ,
operationId:
{
Description: OperationID which represents the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupOperationStatuses_Get (new)
Description :  Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs when the operation is complete.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupOperations/{operationId}
{
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 ,
operationId:
{
Description: OperationID which represents the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ID of the operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Operation start time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: Error code of the operation failure. ,
Required: False ,
}
string ,
message:
{
Description: Error message displayed if the operation failure. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectionPolicyOperationStatuses_Get (new)
Description :  Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed or failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs associated with operation.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}/operations/{operationId}
{
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 ,
policyName:
{
Description: Backup policy name whose operation's status needs to be fetched. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation ID which represents an operation whose status needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ID of the operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Operation start time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: Error code of the operation failure. ,
Required: False ,
}
string ,
message:
{
Description: Error message displayed if the operation failure. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupProtectableItems_List (new)
Description :  Provides a pageable list of protectable objects within your subscription according to the query filter and the pagination parameters.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectableItems
{
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: WorkloadProtectableItemResource properties ,
Required: False ,
}
{
backupManagementType:
{
Description: Type of backup management to backup an item. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of workload for the backup management ,
Required: False ,
}
string ,
protectableItemType:
{
Description: Type of the backup item. ,
Required: True ,
}
string ,
friendlyName:
{
Description: Friendly name of the backup item. ,
Required: False ,
}
string ,
protectionState:
{
Description: State of the back up 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 (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupProtectionContainers_List (new)
Description :  Lists the containers registered to Recovery Services Vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectionContainers
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ProtectionContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
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 ,
registrationStatus:
{
Description: Status of registration of the container with the Recovery Services Vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerType:
{
Description: Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
Microsoft.ClassicCompute/virtualMachines: No description available. ,
Microsoft.Compute/virtualMachines: No description available. ,
AzureWorkloadContainer: No description available. ,
}
,
Required: True ,
}
enum ,
protectableObjectType:
{
Description: Type of the protectable object associated with this container ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DeletedProtectionContainers_List (new)
Description :  Lists the soft deleted containers registered to Recovery Services Vault.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ProtectionContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
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 ,
registrationStatus:
{
Description: Status of registration of the container with the Recovery Services Vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerType:
{
Description: Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
Microsoft.ClassicCompute/virtualMachines: No description available. ,
Microsoft.Compute/virtualMachines: No description available. ,
AzureWorkloadContainer: No description available. ,
}
,
Required: True ,
}
enum ,
protectableObjectType:
{
Description: Type of the protectable object associated with this container ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
SecurityPINs_Get (new)
Description :  Get the security PIN.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupSecurityPIN
{
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 ,
parameters:
{
Description: security pin request ,
Required: False ,
}
{
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
}
,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
}

⚐ Response (200)

{
token:
{
Description: Token value. ,
Required: False ,
}
string ,
expiryTimeInUtcTicks:
{
Description: Expiry time of token. ,
Format: int64 ,
Required: False ,
}
integer ,
securityPIN:
{
Description: Security PIN ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
MoveRecoveryPoint (new)
Description :  Move recovery point from one datastore to another store.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/move
{
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:
{
Required: True ,
}
string ,
containerName:
{
Required: True ,
}
string ,
protectedItemName:
{
Required: True ,
}
string ,
recoveryPointId:
{
Required: True ,
}
string ,
parameters:
{
Description: Move Resource Across Tiers Request ,
Required: True ,
}
{
objectType:
{
Description: Gets the class type. ,
Required: False ,
}
string ,
sourceTierType:
{
Description: Source tier from where RP needs to be moved ,
Enum:
{
Invalid: No description available. ,
InstantRP: No description available. ,
HardenedRP: No description available. ,
ArchivedRP: No description available. ,
}
,
Required: False ,
}
enum ,
targetTierType:
{
Description: Target tier where RP needs to be moved ,
Enum:
{
Invalid: No description available. ,
InstantRP: No description available. ,
HardenedRP: No description available. ,
ArchivedRP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPointsRecommendedForMove_List (new)
Description :  Lists the recovery points recommended for move to another tier
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPointsRecommendedForMove
{
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:
{
Required: True ,
}
string ,
containerName:
{
Required: True ,
}
string ,
protectedItemName:
{
Required: True ,
}
string ,
parameters:
{
Description: List Recovery points Recommended for Move Request ,
Required: True ,
}
{
objectType:
{
Description: Gets the class type. ,
Required: False ,
}
string ,
excludedRPList:
{
Description: List of Recovery Points excluded from Move ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: RecoveryPointResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
threatStatus:
{
Description: Threat status of the recovery point ,
Enum:
{
Unknown: No description available. ,
Healthy: No description available. ,
UnHealthy: No description available. ,
Warning: No description available. ,
NotAvailable: No description available. ,
}
,
Required: False ,
}
enum ,
threatInfo:
{
Description: Recovery point threat information. ,
Required: False ,
}
[
{
threatTitle:
{
Description: Threat Subject ,
Required: False ,
}
string ,
threatDescription:
{
Description: Threat Description ,
Required: False ,
}
string ,
lastUpdatedTime:
{
Description: Timestamp when the last (latest)threat information was sent ,
Format: date-time ,
Required: False ,
}
string ,
threatState:
{
Description: Threat Status Types ,
Enum:
{
Active: No description available. ,
InProgress: No description available. ,
Ignored: No description available. ,
Resolved: No description available. ,
}
,
Required: False ,
}
enum ,
threatStartTime:
{
Description: Start timestamp of the threat ,
Format: date-time ,
Required: False ,
}
string ,
threatEndTime:
{
Description: End timestamp of the threat ,
Format: date-time ,
Required: False ,
}
string ,
threatURI:
{
Description: threat details link ,
Format: uri ,
Required: False ,
}
string ,
threatSeverity:
{
Description: Threat Severity Types ,
Enum:
{
Critical: No description available. ,
High: No description available. ,
Warning: No description available. ,
Informational: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceGuardProxies_Get (new)
Description :  List the ResourceGuardProxies under vault
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ResourceGuardProxyBaseResource properties ,
Required: False ,
}
{
resourceGuardResourceId:
{
Required: True ,
}
string ,
resourceGuardOperationDetails:
{
Required: False ,
}
[
{
vaultCriticalOperation:
{
Required: False ,
}
string ,
defaultResourceRequest:
{
Required: False ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceGuardProxy_Get (new)
Description :  Returns ResourceGuardProxy under vault and with the name referenced in request
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}
{
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 ,
resourceGuardProxyName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ResourceGuardProxyBaseResource properties ,
Required: False ,
}
{
resourceGuardResourceId:
{
Required: True ,
}
string ,
resourceGuardOperationDetails:
{
Required: False ,
}
[
{
vaultCriticalOperation:
{
Required: False ,
}
string ,
defaultResourceRequest:
{
Required: False ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceGuardProxy_Put (new)
Description :  Add or Update ResourceGuardProxy under vault Secures vault critical operations
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}
{
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 ,
resourceGuardProxyName:
{
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
properties:
{
Description: ResourceGuardProxyBaseResource properties ,
Required: False ,
}
{
resourceGuardResourceId:
{
Required: True ,
}
string ,
resourceGuardOperationDetails:
{
Required: False ,
}
[
{
vaultCriticalOperation:
{
Required: False ,
}
string ,
defaultResourceRequest:
{
Required: False ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ResourceGuardProxyBaseResource properties ,
Required: False ,
}
{
resourceGuardResourceId:
{
Required: True ,
}
string ,
resourceGuardOperationDetails:
{
Required: False ,
}
[
{
vaultCriticalOperation:
{
Required: False ,
}
string ,
defaultResourceRequest:
{
Required: False ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceGuardProxy_Delete (new)
Description :  Delete ResourceGuardProxy under vault
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}
{
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 ,
resourceGuardProxyName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceGuardProxy_UnlockDelete (new)
Description :  Secures delete ResourceGuardProxy operations.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}/unlockDelete
{
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 ,
resourceGuardProxyName:
{
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
resourceGuardOperationRequests:
{
Required: False ,
}
[
string ,
]
,
resourceToBeDeleted:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
unlockDeleteExpiryTime:
{
Description: This is the time when unlock delete privileges will get expired. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
FetchTieringCost_Post (new)
Description :  Provides the details of the tiering related sizes and cost. Status of the operation can be fetched using GetTieringCostOperationStatus API and result using GetTieringCostOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupTieringCost/default/fetchTieringCost
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
parameters:
{
Description: Fetch Tiering Cost Request ,
Required: True ,
}
{
sourceTierType:
{
Description: Source tier for the request ,
Enum:
{
Invalid: No description available. ,
InstantRP: No description available. ,
HardenedRP: No description available. ,
ArchivedRP: No description available. ,
}
,
Required: True ,
}
enum ,
targetTierType:
{
Description: target tier for the request ,
Enum:
{
Invalid: No description available. ,
InstantRP: No description available. ,
HardenedRP: No description available. ,
ArchivedRP: No description available. ,
}
,
Required: True ,
}
enum ,
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GetTieringCostOperationResult_Get (new)
Description :  Gets the result of async operation for tiering cost
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupTieringCost/default/operationResults/{operationId}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
operationId:
{
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
TieringCostOperationStatus_Get (new)
Description :  Gets the status of async operations of tiering cost
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupTieringCost/default/operationsStatus/{operationId}
{
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
operationId:
{
Required: True ,
}
string ,
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ID of the operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Operation start time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: Error code of the operation failure. ,
Required: False ,
}
string ,
message:
{
Description: Error message displayed if the operation failure. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: An identifier for the error. Codes are invariant and are intended to be consumed programmatically. ,
Required: False ,
}
string ,
message:
{
Description: A message describing the error, intended to be suitable for display in a user interface. ,
Required: False ,
}
string ,
target:
{
Description: The target of the particular error. For example, the name of the property in error. ,
Required: False ,
}
string ,
details:
{
Description: A list of additional details about the error. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}