Microsoft.RecoveryServices (stable:2021-11-15)

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

BackupUsageSummariesCRR_List (new)
Description :  Fetches the backup management usage summaries of the vault.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AadProperties_Get (new)
Description :  Fetches the AAD properties from target region BCM stamp.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupAadProperties
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AADPropertiesResource properties ,
Required: False ,
}
{
servicePrincipalClientId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
authority:
{
Required: False ,
}
string ,
audience:
{
Required: False ,
}
string ,
servicePrincipalObjectId:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CrossRegionRestore_Trigger (new)
Description :  Restores the specified backed up data in a different region as compared to where the data is backed up.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupCrossRegionRestore
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: resource cross region restore request ,
Required: True ,
}
{
crossRegionRestoreAccessDetails:
{
Description: Access details for cross region restore ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
accessTokenString:
{
Description: Access token used for authentication ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id of the source vault ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Resource Group name of the source vault ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource Name of the source vault ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id of the source vault ,
Required: False ,
}
string ,
protectionContainerId:
{
Description: Protected item container id ,
Format: int64 ,
Required: False ,
}
integer ,
recoveryPointId:
{
Description: Recovery Point Id ,
Required: False ,
}
string ,
recoveryPointTime:
{
Description: Recovery Point Time ,
Required: False ,
}
string ,
containerName:
{
Description: Container Unique name ,
Required: False ,
}
string ,
containerType:
{
Description: Container Type ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Backup Management Type ,
Required: False ,
}
string ,
datasourceType:
{
Description: Datasource Type ,
Required: False ,
}
string ,
datasourceName:
{
Description: Datasource Friendly Name ,
Required: False ,
}
string ,
datasourceId:
{
Description: Datasource Id ,
Required: False ,
}
string ,
datasourceContainerName:
{
Description: Datasource Container Unique Name ,
Required: False ,
}
string ,
coordinatorServiceStampId:
{
Description: CoordinatorServiceStampId to be used by BCM in restore call ,
Required: False ,
}
string ,
coordinatorServiceStampUri:
{
Description: CoordinatorServiceStampUri to be used by BCM in restore call ,
Required: False ,
}
string ,
protectionServiceStampId:
{
Description: ProtectionServiceStampId to be used by BCM in restore call ,
Required: False ,
}
string ,
protectionServiceStampUri:
{
Description: ProtectionServiceStampUri to be used by BCM in restore call ,
Required: False ,
}
string ,
tokenExtendedInformation:
{
Description: Extended Information about the token like FileSpec etc. ,
Required: False ,
}
string ,
rpTierInformation:
{
Description: Recovery point Tier Information ,
Required: False ,
}
object ,
rpOriginalSAOption:
{
Description: Recovery point information: Original SA option ,
Required: False ,
}
boolean ,
rpIsManagedVirtualMachine:
{
Description: Recovery point information: Managed virtual machine ,
Required: False ,
}
boolean ,
rpVMSizeDescription:
{
Description: Recovery point information: VM size description ,
Required: False ,
}
string ,
bMSActiveRegion:
{
Description: Active region name of BMS Stamp ,
Required: False ,
}
string ,
}
,
restoreRequest:
{
Description: Request object for triggering restore ,
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 (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupCrrJobDetails_Get (new)
Description :  Get CRR job details from target region.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupCrrJob
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: CRR Job request ,
Required: True ,
}
{
resourceId:
{
Description: Entire ARM resource id of the resource ,
Required: False ,
}
string ,
jobName:
{
Description: Job Name of the job to be fetched ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: JobResource properties ,
Required: False ,
}
{
entityFriendlyName:
{
Description: Friendly name of the entity on which the current job is executing. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Backup management type to execute the current job. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
operation:
{
Description: The operation name. ,
Required: False ,
}
string ,
status:
{
Description: Job status. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
activityId:
{
Description: ActivityId of job. ,
Required: False ,
}
string ,
jobType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupCrrJobs_List (new)
Description :  Gets the list of CRR jobs from the target region.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupCrrJobs
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Backup CRR Job request ,
Required: True ,
}
{
resourceId:
{
Description: Entire ARM resource id of the resource ,
Required: False ,
}
string ,
jobName:
{
Description: Job Name of the job to be fetched ,
Required: False ,
}
string ,
}
,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken Filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: JobResource properties ,
Required: False ,
}
{
entityFriendlyName:
{
Description: Friendly name of the entity on which the current job is executing. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Backup management type to execute the current job. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
operation:
{
Description: The operation name. ,
Required: False ,
}
string ,
status:
{
Description: Job status. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
activityId:
{
Description: ActivityId of job. ,
Required: False ,
}
string ,
jobType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupCrrOperationResults/{operationId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
operationId:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

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

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupCrrOperationsStatus/{operationId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
operationId:
{
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPoints_GetAccessToken (new)
Description :  Returns the Access token for communication between BMS and Protection service
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/accessToken
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the container. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Name of the Protected Item. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: Recovery Point Id ,
Required: True ,
}
string ,
parameters:
{
Description: Get Access Token request ,
Required: True ,
}
{
properties:
{
Description: AADPropertiesResource properties ,
Required: False ,
}
{
servicePrincipalClientId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
authority:
{
Required: False ,
}
string ,
audience:
{
Required: False ,
}
string ,
servicePrincipalObjectId:
{
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: CrrAccessTokenResource properties ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
accessTokenString:
{
Description: Access token used for authentication ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id of the source vault ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Resource Group name of the source vault ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource Name of the source vault ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id of the source vault ,
Required: False ,
}
string ,
protectionContainerId:
{
Description: Protected item container id ,
Format: int64 ,
Required: False ,
}
integer ,
recoveryPointId:
{
Description: Recovery Point Id ,
Required: False ,
}
string ,
recoveryPointTime:
{
Description: Recovery Point Time ,
Required: False ,
}
string ,
containerName:
{
Description: Container Unique name ,
Required: False ,
}
string ,
containerType:
{
Description: Container Type ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Backup Management Type ,
Required: False ,
}
string ,
datasourceType:
{
Description: Datasource Type ,
Required: False ,
}
string ,
datasourceName:
{
Description: Datasource Friendly Name ,
Required: False ,
}
string ,
datasourceId:
{
Description: Datasource Id ,
Required: False ,
}
string ,
datasourceContainerName:
{
Description: Datasource Container Unique Name ,
Required: False ,
}
string ,
coordinatorServiceStampId:
{
Description: CoordinatorServiceStampId to be used by BCM in restore call ,
Required: False ,
}
string ,
coordinatorServiceStampUri:
{
Description: CoordinatorServiceStampUri to be used by BCM in restore call ,
Required: False ,
}
string ,
protectionServiceStampId:
{
Description: ProtectionServiceStampId to be used by BCM in restore call ,
Required: False ,
}
string ,
protectionServiceStampUri:
{
Description: ProtectionServiceStampUri to be used by BCM in restore call ,
Required: False ,
}
string ,
tokenExtendedInformation:
{
Description: Extended Information about the token like FileSpec etc. ,
Required: False ,
}
string ,
rpTierInformation:
{
Description: Recovery point Tier Information ,
Required: False ,
}
object ,
rpOriginalSAOption:
{
Description: Recovery point information: Original SA option ,
Required: False ,
}
boolean ,
rpIsManagedVirtualMachine:
{
Description: Recovery point information: Managed virtual machine ,
Required: False ,
}
boolean ,
rpVMSizeDescription:
{
Description: Recovery point information: VM size description ,
Required: False ,
}
string ,
bMSActiveRegion:
{
Description: Active region name of BMS Stamp ,
Required: False ,
}
string ,
}
,
}

⚐ Response (400)

{}

⚐ Response (default)

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

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Vault storage config request ,
Required: True ,
}
{
properties:
{
Description: BackupResourceConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestoreFlag:
{
Description: Opt in details of Cross Region Restore feature. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Vault storage config request ,
Required: True ,
}
{
properties:
{
Description: BackupResourceConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestoreFlag:
{
Description: Opt in details of Cross Region Restore feature. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPointsCrr_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 ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPointsCrr_Get (new)
Description :  Provides the information of the backed up data identified using RecoveryPointID.
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupProtectedItemsCrr_List (new)
Description :  Provides a pageable list of all items that are backed up within a vault.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ProtectedItemResource properties ,
Required: False ,
}
{
protectedItemType:
{
Description: backup item type. ,
Required: True ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: Type of workload this item represents. ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
VMwareVM: No description available. ,
SystemState: No description available. ,
Client: No description available. ,
GenericDataSource: No description available. ,
SQLDataBase: No description available. ,
AzureFileShare: No description available. ,
SAPHanaDatabase: No description available. ,
SAPAseDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
containerName:
{
Description: Unique name of container ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: Timestamp when the last (latest) backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
backupSetName:
{
Description: Name of the backup set the backup item belongs to ,
Required: False ,
}
string ,
createMode:
{
Description: Create mode to indicate recovery of existing soft deleted data source or creation of new data source. ,
Enum:
{
Invalid: No description available. ,
Default: No description available. ,
Recover: No description available. ,
}
,
Required: False ,
}
enum ,
deferredDeleteTimeInUTC:
{
Description: Time for deferred deletion in UTC ,
Format: date-time ,
Required: False ,
}
string ,
isScheduledForDeferredDelete:
{
Description: Flag to identify whether the DS is scheduled for deferred delete ,
Required: False ,
}
boolean ,
deferredDeleteTimeRemaining:
{
Description: Time remaining before the DS marked for deferred delete is permanently deleted ,
Required: False ,
}
string ,
isDeferredDeleteScheduleUpcoming:
{
Description: Flag to identify whether the deferred deleted DS is to be purged soon ,
Required: False ,
}
boolean ,
isRehydrate:
{
Description: Flag to identify that deferred deleted DS is to be moved into Pause state ,
Required: False ,
}
boolean ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupUsageSummariesCRR_List (removed)
Description :  Fetches the backup management usage summaries of the vault.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AadProperties_Get (removed)
Description :  Fetches the AAD properties from target region BCM stamp.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupAadProperties
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: AADPropertiesResource properties ,
Required: False ,
}
{
servicePrincipalClientId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
authority:
{
Required: False ,
}
string ,
audience:
{
Required: False ,
}
string ,
servicePrincipalObjectId:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CrossRegionRestore_Trigger (removed)
Description :  Restores the specified backed up data in a different region as compared to where the data is backed up.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupCrossRegionRestore
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: resource cross region restore request ,
Required: True ,
}
{
crossRegionRestoreAccessDetails:
{
Description: Access details for cross region restore ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
accessTokenString:
{
Description: Access token used for authentication ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id of the source vault ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Resource Group name of the source vault ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource Name of the source vault ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id of the source vault ,
Required: False ,
}
string ,
protectionContainerId:
{
Description: Protected item container id ,
Format: int64 ,
Required: False ,
}
integer ,
recoveryPointId:
{
Description: Recovery Point Id ,
Required: False ,
}
string ,
recoveryPointTime:
{
Description: Recovery Point Time ,
Required: False ,
}
string ,
containerName:
{
Description: Container Unique name ,
Required: False ,
}
string ,
containerType:
{
Description: Container Type ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Backup Management Type ,
Required: False ,
}
string ,
datasourceType:
{
Description: Datasource Type ,
Required: False ,
}
string ,
datasourceName:
{
Description: Datasource Friendly Name ,
Required: False ,
}
string ,
datasourceId:
{
Description: Datasource Id ,
Required: False ,
}
string ,
datasourceContainerName:
{
Description: Datasource Container Unique Name ,
Required: False ,
}
string ,
coordinatorServiceStampId:
{
Description: CoordinatorServiceStampId to be used by BCM in restore call ,
Required: False ,
}
string ,
coordinatorServiceStampUri:
{
Description: CoordinatorServiceStampUri to be used by BCM in restore call ,
Required: False ,
}
string ,
protectionServiceStampId:
{
Description: ProtectionServiceStampId to be used by BCM in restore call ,
Required: False ,
}
string ,
protectionServiceStampUri:
{
Description: ProtectionServiceStampUri to be used by BCM in restore call ,
Required: False ,
}
string ,
tokenExtendedInformation:
{
Description: Extended Information about the token like FileSpec etc. ,
Required: False ,
}
string ,
rpTierInformation:
{
Description: Recovery point Tier Information ,
Required: False ,
}
object ,
rpOriginalSAOption:
{
Description: Recovery point information: Original SA option ,
Required: False ,
}
boolean ,
rpIsManagedVirtualMachine:
{
Description: Recovery point information: Managed virtual machine ,
Required: False ,
}
boolean ,
rpVMSizeDescription:
{
Description: Recovery point information: VM size description ,
Required: False ,
}
string ,
bMSActiveRegion:
{
Description: Active region name of BMS Stamp ,
Required: False ,
}
string ,
}
,
restoreRequest:
{
Description: Request object for triggering restore ,
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 (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupCrrJobDetails_Get (removed)
Description :  Get CRR job details from target region.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupCrrJob
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: CRR Job request ,
Required: True ,
}
{
resourceId:
{
Description: Entire ARM resource id of the resource ,
Required: False ,
}
string ,
jobName:
{
Description: Job Name of the job to be fetched ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: JobResource properties ,
Required: False ,
}
{
entityFriendlyName:
{
Description: Friendly name of the entity on which the current job is executing. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Backup management type to execute the current job. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
operation:
{
Description: The operation name. ,
Required: False ,
}
string ,
status:
{
Description: Job status. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
activityId:
{
Description: ActivityId of job. ,
Required: False ,
}
string ,
jobType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupCrrJobs_List (removed)
Description :  Gets the list of CRR jobs from the target region.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupCrrJobs
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Backup CRR Job request ,
Required: True ,
}
{
resourceId:
{
Description: Entire ARM resource id of the resource ,
Required: False ,
}
string ,
jobName:
{
Description: Job Name of the job to be fetched ,
Required: False ,
}
string ,
}
,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken Filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: JobResource properties ,
Required: False ,
}
{
entityFriendlyName:
{
Description: Friendly name of the entity on which the current job is executing. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Backup management type to execute the current job. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
operation:
{
Description: The operation name. ,
Required: False ,
}
string ,
status:
{
Description: Job status. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
activityId:
{
Description: ActivityId of job. ,
Required: False ,
}
string ,
jobType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CrrOperationResults_Get (removed)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupCrrOperationResults/{operationId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
operationId:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CrrOperationStatus_Get (removed)
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupCrrOperationsStatus/{operationId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
operationId:
{
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPoints_GetAccessToken (removed)
Description :  Returns the Access token for communication between BMS and Protection service
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/accessToken
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the container. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Name of the Protected Item. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: Recovery Point Id ,
Required: True ,
}
string ,
parameters:
{
Description: Get Access Token request ,
Required: True ,
}
{
properties:
{
Description: AADPropertiesResource properties ,
Required: False ,
}
{
servicePrincipalClientId:
{
Required: False ,
}
string ,
tenantId:
{
Required: False ,
}
string ,
authority:
{
Required: False ,
}
string ,
audience:
{
Required: False ,
}
string ,
servicePrincipalObjectId:
{
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: CrrAccessTokenResource properties ,
Required: False ,
}
{
objectType:
{
Description: Type of the specific object - used for deserializing ,
Required: True ,
}
string ,
accessTokenString:
{
Description: Access token used for authentication ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription Id of the source vault ,
Required: False ,
}
string ,
resourceGroupName:
{
Description: Resource Group name of the source vault ,
Required: False ,
}
string ,
resourceName:
{
Description: Resource Name of the source vault ,
Required: False ,
}
string ,
resourceId:
{
Description: Resource Id of the source vault ,
Required: False ,
}
string ,
protectionContainerId:
{
Description: Protected item container id ,
Format: int64 ,
Required: False ,
}
integer ,
recoveryPointId:
{
Description: Recovery Point Id ,
Required: False ,
}
string ,
recoveryPointTime:
{
Description: Recovery Point Time ,
Required: False ,
}
string ,
containerName:
{
Description: Container Unique name ,
Required: False ,
}
string ,
containerType:
{
Description: Container Type ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Backup Management Type ,
Required: False ,
}
string ,
datasourceType:
{
Description: Datasource Type ,
Required: False ,
}
string ,
datasourceName:
{
Description: Datasource Friendly Name ,
Required: False ,
}
string ,
datasourceId:
{
Description: Datasource Id ,
Required: False ,
}
string ,
datasourceContainerName:
{
Description: Datasource Container Unique Name ,
Required: False ,
}
string ,
coordinatorServiceStampId:
{
Description: CoordinatorServiceStampId to be used by BCM in restore call ,
Required: False ,
}
string ,
coordinatorServiceStampUri:
{
Description: CoordinatorServiceStampUri to be used by BCM in restore call ,
Required: False ,
}
string ,
protectionServiceStampId:
{
Description: ProtectionServiceStampId to be used by BCM in restore call ,
Required: False ,
}
string ,
protectionServiceStampUri:
{
Description: ProtectionServiceStampUri to be used by BCM in restore call ,
Required: False ,
}
string ,
tokenExtendedInformation:
{
Description: Extended Information about the token like FileSpec etc. ,
Required: False ,
}
string ,
rpTierInformation:
{
Description: Recovery point Tier Information ,
Required: False ,
}
object ,
rpOriginalSAOption:
{
Description: Recovery point information: Original SA option ,
Required: False ,
}
boolean ,
rpIsManagedVirtualMachine:
{
Description: Recovery point information: Managed virtual machine ,
Required: False ,
}
boolean ,
rpVMSizeDescription:
{
Description: Recovery point information: VM size description ,
Required: False ,
}
string ,
bMSActiveRegion:
{
Description: Active region name of BMS Stamp ,
Required: False ,
}
string ,
}
,
}

⚐ Response (400)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupResourceStorageConfigs_Get (removed)
Description :  Fetches resource storage config.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Vault storage config request ,
Required: True ,
}
{
properties:
{
Description: BackupResourceConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestoreFlag:
{
Description: Opt in details of Cross Region Restore feature. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
parameters:
{
Description: Vault storage config request ,
Required: True ,
}
{
properties:
{
Description: BackupResourceConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestoreFlag:
{
Description: Opt in details of Cross Region Restore feature. ,
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPointsCrr_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 ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPointsCrr_Get (removed)
Description :  Provides the information of the backed up data identified using RecoveryPointID.
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 ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupProtectedItemsCrr_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: True ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: Type of workload this item represents. ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
VMwareVM: No description available. ,
SystemState: No description available. ,
Client: No description available. ,
GenericDataSource: No description available. ,
SQLDataBase: No description available. ,
AzureFileShare: No description available. ,
SAPHanaDatabase: No description available. ,
SAPAseDatabase: No description available. ,
}
,
Required: False ,
}
enum ,
containerName:
{
Description: Unique name of container ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: Timestamp when the last (latest) backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
backupSetName:
{
Description: Name of the backup set the backup item belongs to ,
Required: False ,
}
string ,
createMode:
{
Description: Create mode to indicate recovery of existing soft deleted data source or creation of new data source. ,
Enum:
{
Invalid: No description available. ,
Default: No description available. ,
Recover: No description available. ,
}
,
Required: False ,
}
enum ,
deferredDeleteTimeInUTC:
{
Description: Time for deferred deletion in UTC ,
Format: date-time ,
Required: False ,
}
string ,
isScheduledForDeferredDelete:
{
Description: Flag to identify whether the DS is scheduled for deferred delete ,
Required: False ,
}
boolean ,
deferredDeleteTimeRemaining:
{
Description: Time remaining before the DS marked for deferred delete is permanently deleted ,
Required: False ,
}
string ,
isDeferredDeleteScheduleUpcoming:
{
Description: Flag to identify whether the deferred deleted DS is to be purged soon ,
Required: False ,
}
boolean ,
isRehydrate:
{
Description: Flag to identify that deferred deleted DS is to be moved into Pause state ,
Required: False ,
}
boolean ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}