Microsoft.RecoveryServices (stable:2019-05-13)

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

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. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: 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. ,
}
,
Required: False ,
}
enum ,
}
,
}
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. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: 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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: 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. ,
}
,
Required: False ,
}
enum ,
}
,
}
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: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
}
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: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ProtectedItemResource properties ,
Required: False ,
}
{
protectedItemType:
{
Description: backup item type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
}

⚐ Response (202)

{}
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 (202)

{}

⚐ Response (204)

{}
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: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
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 ,
}
,
}
,
]
,
}
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 ,
}
,
}
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 ,
}
,
}
,
}

⚐ Response (202)

{}
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 ,
}
,
}
,
]
,
}
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 ,
}
,
}
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
}

⚐ Response (202)

{}
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 ,
}
,
}
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 ,
}
,
}
,
]
,
}
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 ,
}
,
}
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)

{}
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)

{}
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 ,
}
,
}
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)

{}
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: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
}
,
]
,
}
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 ,
}
{
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 ,
]
,
}
,
]
,
}
,
}
BackupResourceVaultConfigs_Get (removed)
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. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: 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. ,
}
,
Required: False ,
}
enum ,
}
,
}
BackupResourceVaultConfigs_Update (removed)
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. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: 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. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: 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. ,
}
,
Required: False ,
}
enum ,
}
,
}
ProtectedItems_Get (removed)
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: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
}
ProtectedItems_CreateOrUpdate (removed)
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: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ProtectedItemResource properties ,
Required: False ,
}
{
protectedItemType:
{
Description: backup item type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
}

⚐ Response (202)

{}
ProtectedItems_Delete (removed)
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 (202)

{}

⚐ Response (204)

{}
ProtectedItemOperationResults_Get (removed)
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: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
RecoveryPoints_List (removed)
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 ,
}
,
}
,
]
,
}
RecoveryPoints_Get (removed)
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 ,
}
,
}
Restores_Trigger (removed)
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 ,
}
,
}
,
}

⚐ Response (202)

{}
BackupPolicies_List (removed)
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 ,
}
,
}
,
]
,
}
ProtectionPolicies_Get (removed)
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 ,
}
,
}
ProtectionPolicies_CreateOrUpdate (removed)
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 ,
}
,
}
,
}

⚐ 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 ,
}
,
}

⚐ Response (202)

{}
ProtectionPolicyOperationResults_Get (removed)
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 ,
}
,
}
BackupJobs_List (removed)
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 ,
}
,
}
,
]
,
}
JobDetails_Get (removed)
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 ,
}
,
}
JobCancellations_Trigger (removed)
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)

{}
JobOperationResults_Get (removed)
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)

{}
ExportJobsOperationResults_Get (removed)
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 ,
}
,
}
Jobs_Export (removed)
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)

{}
BackupProtectedItems_List (removed)
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: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
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. ,
}
,
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 ,
}
,
}
,
]
,
}
Operation_Validate (removed)
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 ,
}
{
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 ,
]
,
}
,
]
,
}
,
}