Microsoft.RecoveryServices (stable:2025-02-01)

2025/09/23 • 11 new, 69 updated methods

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

⚼ Request

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

⚐ Response (200)

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

⚐ 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 ,
}
,
]
,
}
,
}
BackupStatus_Get (new)
Description :  Get the container backup status
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
protectionStatus:
{
Description: Specifies whether the container is registered or not ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
vaultId:
{
Description: Specifies the arm resource id of the vault ,
Required: False ,
}
string ,
fabricName:
{
Description: Specifies the fabric name - Azure or AD ,
Enum:
{
Invalid: No description available. ,
Azure: No description available. ,
}
,
Required: False ,
}
enum ,
containerName:
{
Description: Specifies the product specific container name. E.g. iaasvmcontainer;iaasvmcontainer;csname;vmname. ,
Required: False ,
}
string ,
protectedItemName:
{
Description: Specifies the product specific ds name. E.g. vm;iaasvmcontainer;csname;vmname. ,
Required: False ,
}
string ,
errorCode:
{
Description: ErrorCode in case of intent failed ,
Required: False ,
}
string ,
errorMessage:
{
Description: ErrorMessage in case of intent failed. ,
Required: False ,
}
string ,
policyName:
{
Description: Specifies the policy name which is used for protection ,
Required: False ,
}
string ,
registrationStatus:
{
Description: Container registration status ,
Required: False ,
}
string ,
protectedItemsCount:
{
Description: Number of protected items ,
Format: int32 ,
Required: False ,
}
integer ,
acquireStorageAccountLock:
{
Description: Specifies whether the storage account lock has been acquired or not ,
Enum:
{
Acquire: No description available. ,
NotAcquire: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ 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 ,
}
,
]
,
}
,
}
FeatureSupport_Validate (new)
Description :  It will validate if given feature with resource properties is supported in service
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.RecoveryServices/locations/{azureRegion}/backupValidateFeatures
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
azureRegion:
{
Description: Azure region to hit Api ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: Feature support request object ,
Required: True ,
}
{
featureType:
{
Description: backup support feature type. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
supportStatus:
{
Description: Support status of feature ,
Enum:
{
Invalid: No description available. ,
Supported: No description available. ,
DefaultOFF: No description available. ,
DefaultON: No description available. ,
NotSupported: No description available. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectionIntent_Get (new)
Description :  Provides the details of the protection intent up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
intentObjectName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionIntentResource properties ,
Required: False ,
}
{
protectionIntentItemType:
{
Description: backup protectionIntent type. ,
Enum:
{
Invalid: No description available. ,
AzureResourceItem: No description available. ,
RecoveryServiceVaultItem: No description available. ,
AzureWorkloadContainerAutoProtectionIntent: No description available. ,
AzureWorkloadAutoProtectionIntent: No description available. ,
AzureWorkloadSQLAutoProtectionIntent: No description available. ,
}
,
Required: True ,
}
enum ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
itemId:
{
Description: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
protectionState:
{
Description: Backup state of this backup item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
ProtectionIntent_CreateOrUpdate (new)
Description :  Create Intent for Enabling backup of an item. This is a synchronous operation.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
intentObjectName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
parameters:
{
Description: resource backed up item ,
Required: True ,
}
{
properties:
{
Description: ProtectionIntentResource properties ,
Required: False ,
}
{
protectionIntentItemType:
{
Description: backup protectionIntent type. ,
Enum:
{
Invalid: No description available. ,
AzureResourceItem: No description available. ,
RecoveryServiceVaultItem: No description available. ,
AzureWorkloadContainerAutoProtectionIntent: No description available. ,
AzureWorkloadAutoProtectionIntent: No description available. ,
AzureWorkloadSQLAutoProtectionIntent: No description available. ,
}
,
Required: True ,
}
enum ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
itemId:
{
Description: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
protectionState:
{
Description: Backup state of this backup item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionIntentResource properties ,
Required: False ,
}
{
protectionIntentItemType:
{
Description: backup protectionIntent type. ,
Enum:
{
Invalid: No description available. ,
AzureResourceItem: No description available. ,
RecoveryServiceVaultItem: No description available. ,
AzureWorkloadContainerAutoProtectionIntent: No description available. ,
AzureWorkloadAutoProtectionIntent: No description available. ,
AzureWorkloadSQLAutoProtectionIntent: No description available. ,
}
,
Required: True ,
}
enum ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
itemId:
{
Description: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
protectionState:
{
Description: Backup state of this backup item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
ProtectionIntent_Delete (new)
Description :  Used to remove intent from an item
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/backupProtectionIntent/{intentObjectName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
intentObjectName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}
BackupProtectionIntent_List (new)
Description :  Provides a pageable list of all intents that are present within a vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectionIntents
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken Filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ProtectionIntentResource properties ,
Required: False ,
}
{
protectionIntentItemType:
{
Description: backup protectionIntent type. ,
Enum:
{
Invalid: No description available. ,
AzureResourceItem: No description available. ,
RecoveryServiceVaultItem: No description available. ,
AzureWorkloadContainerAutoProtectionIntent: No description available. ,
AzureWorkloadAutoProtectionIntent: No description available. ,
AzureWorkloadSQLAutoProtectionIntent: No description available. ,
}
,
Required: True ,
}
enum ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
itemId:
{
Description: ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
protectionState:
{
Description: Backup state of this backup item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
BackupUsageSummaries_List (new)
Description :  Fetches the backup management usage summaries of the vault.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupUsageSummaries
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
}
,
]
,
}
,
}
BackupResourceStorageConfigsNonCRR_Get (new)
Description :  Fetches resource storage config.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: BackupResourceConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestoreFlag:
{
Description: Opt in details of Cross Region Restore feature. ,
Required: False ,
}
boolean ,
dedupState:
{
Description: Vault Dedup state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
xcoolState:
{
Description: Vault x-cool state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
BackupResourceStorageConfigsNonCRR_Update (new)
Description :  Updates vault storage model type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
parameters:
{
Description: Vault storage config request ,
Required: True ,
}
{
properties:
{
Description: BackupResourceConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestoreFlag:
{
Description: Opt in details of Cross Region Restore feature. ,
Required: False ,
}
boolean ,
dedupState:
{
Description: Vault Dedup state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
xcoolState:
{
Description: Vault x-cool state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: BackupResourceConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestoreFlag:
{
Description: Opt in details of Cross Region Restore feature. ,
Required: False ,
}
boolean ,
dedupState:
{
Description: Vault Dedup state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
xcoolState:
{
Description: Vault x-cool state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
BackupResourceStorageConfigsNonCRR_Patch (new)
Description :  Updates vault storage model type.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
parameters:
{
Description: Vault storage config request ,
Required: True ,
}
{
properties:
{
Description: BackupResourceConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
crossRegionRestoreFlag:
{
Description: Opt in details of Cross Region Restore feature. ,
Required: False ,
}
boolean ,
dedupState:
{
Description: Vault Dedup state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
xcoolState:
{
Description: Vault x-cool state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ 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 ,
}
,
]
,
}
,
}
Operations_List (updated)
Description :  List the operations for the provider
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "Returns the list of available operations."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    }
  ],
  "$responses": {
    "@added_0023ce095ed747cfbf5554f51585093a": {
      "default": {
        "Description": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "Type": "object",
        "$properties": [
          {
            "#name": "error",
            "Description": "The error object.",
            "Required": false,
            "Type": "object",
            "$properties": [
              {
                "#name": "code",
                "Description": "The error code.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "message",
                "Description": "The error message.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              },
              {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              },
              {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.RecoveryServices/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ 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 ,
}
,
]
,
}
,
}
DeletedProtectionContainers_List (updated)
Description :  Lists the soft deleted containers registered to Recovery Services Vault.
Reference :  Link ¶

⚶ Changes

{
  "#id": "DeletedProtectionContainers_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "containerType",
                "Description": {
                  "new": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\nBackup is VMAppContainer",
                  "old": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\r\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\r\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\r\nBackup is VMAppContainer"
                }
              }
            ],
            "@added_fca65128306d4a3b94bbb940cc3e1552": {
              "#name": "tags",
              "Description": "Resource tags.",
              "Required": false,
              "Type": "object"
            },
            "@added_673c9dcee2d84e29a9c2178f1f56d4d2": {
              "#name": "location",
              "Description": "The geo-location where the resource lives",
              "Required": false,
              "Type": "string"
            },
            "@added_2625bebc330c4bc6a2fed092db9b0793": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupDeletedProtectionContainers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

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

⚶ Changes

{
  "#id": "BackupResourceEncryptionConfigs_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_4fd6f30f35fb4b9c923492925ae414fd": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_0c9d074a1f9445069a03791d15896847": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_e267100e93974e619d75e030e56de36d": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The resource management error response."
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEncryptionConfigs/backupResourceEncryptionConfig
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: BackupResourceEncryptionConfigExtendedResource properties ,
Required: False ,
}
{
userAssignedIdentity:
{
Description: User Assigned Identity Id ,
Required: False ,
}
string ,
useSystemAssignedIdentity:
{
Description: bool to indicate whether to use system Assigned Identity or not ,
Required: False ,
}
boolean ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
BackupResourceEncryptionConfigs_Update (updated)
Description :  Updates Vault encryption config.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupResourceEncryptionConfigs_Update",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@added_391ac58a0ed94c498370cceb5c43bccf": {
            "#name": "tags",
            "Description": "Resource tags.",
            "Required": false,
            "Type": "object"
          },
          "@added_e6e2191a5cdb4def8cfd67bdca2be1bf": {
            "#name": "location",
            "Description": "The geo-location where the resource lives",
            "Required": false,
            "Type": "string"
          },
          "@added_5229758fb29049599d75c9ebc039a8a8": {
            "#name": "eTag",
            "Description": "Optional ETag.",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The resource management error response."
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEncryptionConfigs/backupResourceEncryptionConfig
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
parameters:
{
Description: Vault encryption input config request ,
Required: True ,
}
{
properties:
{
Description: BackupResourceEncryptionConfigResource properties ,
Required: False ,
}
{
encryptionAtRestType:
{
Description: Encryption At Rest Type ,
Enum:
{
Invalid: No description available. ,
MicrosoftManaged: No description available. ,
CustomerManaged: No description available. ,
}
,
Required: False ,
}
enum ,
keyUri:
{
Description: Key Vault Key URI ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Key Vault Subscription Id ,
Required: False ,
}
string ,
lastUpdateStatus:
{
Enum:
{
Invalid: No description available. ,
NotEnabled: No description available. ,
PartiallySucceeded: No description available. ,
PartiallyFailed: No description available. ,
Failed: No description available. ,
Succeeded: No description available. ,
Initialized: No description available. ,
FirstInitialization: No description available. ,
}
,
Required: False ,
}
enum ,
infrastructureEncryptionState:
{
Enum:
{
Invalid: No description available. ,
Disabled: No description available. ,
Enabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupEngines_List (updated)
Description :  Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupEngines_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_8d707365d1e14d8c8bdb09fdf314fa74": {
              "#name": "tags",
              "Description": "Resource tags.",
              "Required": false,
              "Type": "object"
            },
            "@added_48c204dad4634485ad577ddbba23f7f3": {
              "#name": "location",
              "Description": "The geo-location where the resource lives",
              "Required": false,
              "Type": "string"
            },
            "@added_70139dcd67634a53aa339c1d3812ec1d": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEngines
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken Filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: BackupEngineBaseResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the backup engine. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backup engine. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: Registration status of the backup engine with the Recovery Services Vault. ,
Required: False ,
}
string ,
backupEngineState:
{
Description: Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed} ,
Required: False ,
}
string ,
healthStatus:
{
Description: Backup status of the backup engine. ,
Required: False ,
}
string ,
backupEngineType:
{
Description: Type of the backup engine. ,
Enum:
{
Invalid: No description available. ,
DpmBackupEngine: No description available. ,
AzureBackupServerEngine: No description available. ,
}
,
Required: True ,
}
enum ,
canReRegister:
{
Description: Flag indicating if the backup engine be registered, once already registered. ,
Required: False ,
}
boolean ,
backupEngineId:
{
Description: ID of the backup engine. ,
Required: False ,
}
string ,
dpmVersion:
{
Description: Backup engine version ,
Required: False ,
}
string ,
azureBackupAgentVersion:
{
Description: Backup agent version ,
Required: False ,
}
string ,
isAzureBackupAgentUpgradeAvailable:
{
Description: To check if backup agent upgrade available ,
Required: False ,
}
boolean ,
isDpmUpgradeAvailable:
{
Description: To check if backup engine upgrade available ,
Required: False ,
}
boolean ,
extendedInfo:
{
Description: Extended info of the backupengine ,
Required: False ,
}
{
databaseName:
{
Description: Database name of backup engine. ,
Required: False ,
}
string ,
protectedItemsCount:
{
Description: Number of protected items in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
protectedServersCount:
{
Description: Number of protected servers in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
diskCount:
{
Description: Number of disks in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDiskSpace:
{
Description: Disk space used in the backup engine. ,
Format: double ,
Required: False ,
}
number ,
availableDiskSpace:
{
Description: Disk space currently available in the backup engine. ,
Format: double ,
Required: False ,
}
number ,
refreshedAt:
{
Description: Last refresh time in the backup engine. ,
Format: date-time ,
Required: False ,
}
string ,
azureProtectedInstances:
{
Description: Protected instances in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
BackupEngines_Get (updated)
Description :  Returns backup management server registered to Recovery Services Vault.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupEngines_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_89d31588c1344d4ca33221cfcda8569a": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_c16fbd21e3a6437dad86dea57e0a4ab2": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_9828814860174d65a6bb3c6985ce0b12": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupEngines/{backupEngineName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
backupEngineName:
{
Description: Name of the backup management server. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken Filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: BackupEngineBaseResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the backup engine. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backup engine. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: Registration status of the backup engine with the Recovery Services Vault. ,
Required: False ,
}
string ,
backupEngineState:
{
Description: Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed} ,
Required: False ,
}
string ,
healthStatus:
{
Description: Backup status of the backup engine. ,
Required: False ,
}
string ,
backupEngineType:
{
Description: Type of the backup engine. ,
Enum:
{
Invalid: No description available. ,
DpmBackupEngine: No description available. ,
AzureBackupServerEngine: No description available. ,
}
,
Required: True ,
}
enum ,
canReRegister:
{
Description: Flag indicating if the backup engine be registered, once already registered. ,
Required: False ,
}
boolean ,
backupEngineId:
{
Description: ID of the backup engine. ,
Required: False ,
}
string ,
dpmVersion:
{
Description: Backup engine version ,
Required: False ,
}
string ,
azureBackupAgentVersion:
{
Description: Backup agent version ,
Required: False ,
}
string ,
isAzureBackupAgentUpgradeAvailable:
{
Description: To check if backup agent upgrade available ,
Required: False ,
}
boolean ,
isDpmUpgradeAvailable:
{
Description: To check if backup engine upgrade available ,
Required: False ,
}
boolean ,
extendedInfo:
{
Description: Extended info of the backupengine ,
Required: False ,
}
{
databaseName:
{
Description: Database name of backup engine. ,
Required: False ,
}
string ,
protectedItemsCount:
{
Description: Number of protected items in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
protectedServersCount:
{
Description: Number of protected servers in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
diskCount:
{
Description: Number of disks in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
usedDiskSpace:
{
Description: Disk space used in the backup engine. ,
Format: double ,
Required: False ,
}
number ,
availableDiskSpace:
{
Description: Disk space currently available in the backup engine. ,
Format: double ,
Required: False ,
}
number ,
refreshedAt:
{
Description: Last refresh time in the backup engine. ,
Format: date-time ,
Required: False ,
}
string ,
azureProtectedInstances:
{
Description: Protected instances in the backup engine. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
ProtectionContainerRefreshOperationResults_Get (updated)
Description :  Provides the result of the refresh operation triggered by the BeginRefresh operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProtectionContainerRefreshOperationResults_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/operationResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the container. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation ID associated with the operation whose result needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
ProtectableContainers_List (updated)
Description :  Lists the containers that can be registered to Recovery Services Vault.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProtectableContainers_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_62d2e6a02b36465e9e842458966ff693": {
              "#name": "location",
              "Description": "Resource location.",
              "Required": false,
              "Type": "string"
            },
            "@added_9f9ace9311284554b0fd22f74da047db": {
              "#name": "tags",
              "Description": "Resource tags.",
              "Required": false,
              "Type": "object"
            },
            "@added_45444ee0ac0c4954b67e1682a9c7aeef": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            },
            "properties": [
              {
                "#name": "protectableContainerType",
                "Description": {
                  "new": "Type of the container. The value of this property for\n1. Compute Azure VM is Microsoft.Compute/virtualMachines\n2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines",
                  "old": "Type of the container. The value of this property for\r\n1. Compute Azure VM is Microsoft.Compute/virtualMachines\r\n2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines"
                }
              }
            ]
          }
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectableContainers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
fabricName:
{
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
properties:
{
Description: ProtectableContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
protectableContainerType:
{
Description: Type of the container. The value of this property for 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
Microsoft.ClassicCompute/virtualMachines: No description available. ,
Microsoft.Compute/virtualMachines: No description available. ,
AzureWorkloadContainer: No description available. ,
}
,
Required: True ,
}
enum ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerId:
{
Description: Fabric Id of the container such as ARM Id. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
ProtectionContainers_Get (updated)
Description :  Gets details of the specific container registered to your Recovery Services Vault.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProtectionContainers_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "The name of the BackupFabricResource",
        "old": "Name of the fabric where the container belongs."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "containerType",
            "Description": {
              "new": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\nBackup is VMAppContainer",
              "old": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\r\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\r\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\r\nBackup is VMAppContainer"
            }
          }
        ],
        "@added_1bc9b9126572498fa024aeb9a80c2896": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_5c6ca87006454e7296001ac8a2b89635": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_908e5c771aed4a4d94b79c06bb5e8faa": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: Status of registration of the container with the Recovery Services Vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerType:
{
Description: Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
Microsoft.ClassicCompute/virtualMachines: No description available. ,
Microsoft.Compute/virtualMachines: No description available. ,
AzureWorkloadContainer: No description available. ,
}
,
Required: True ,
}
enum ,
protectableObjectType:
{
Description: Type of the protectable object associated with this container ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
ProtectionContainers_Register (updated)
Description :  Registers the container with Recovery Services vault. This is an asynchronous operation. To track the operation status, use location header to call get latest status of the operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProtectionContainers_Register",
  "Description": {
    "new": "Registers the container with Recovery Services vault.\nThis is an asynchronous operation. To track the operation status, use location header to call get latest status of\nthe operation.",
    "old": "Registers the container with Recovery Services vault.\r\nThis is an asynchronous operation. To track the operation status, use location header to call get latest status of\r\nthe operation."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "The name of the BackupFabricResource",
        "old": "Fabric name associated with the container."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "Name of the container whose details need to be fetched.",
        "old": "Name of the container to be registered."
      }
    },
    {
      "parameters": {
        "$properties": {
          "properties": [
            {
              "#name": "containerType",
              "Description": {
                "new": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\nBackup is VMAppContainer",
                "old": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\r\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\r\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\r\nBackup is VMAppContainer"
              }
            }
          ],
          "@added_848e90b362ed45248dd3716b3bcceb97": {
            "#name": "tags",
            "Description": "Resource tags.",
            "Required": false,
            "Type": "object"
          },
          "@added_c013ce2b90c147028aeb70062faa74e4": {
            "#name": "location",
            "Description": "The geo-location where the resource lives",
            "Required": false,
            "Type": "string"
          },
          "@added_5adcf562790a4ba8ba93c1bbbb14df1d": {
            "#name": "eTag",
            "Description": "Optional ETag.",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "containerType",
            "Description": {
              "new": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\nBackup is VMAppContainer",
              "old": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\r\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\r\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\r\nBackup is VMAppContainer"
            }
          }
        ],
        "@added_2786d493f9bd417488d611be3d54ffa8": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_4b96abecff234a82be6518d6c57c7078": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_4ef9722f48844232b4ce271df4067de6": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
properties:
{
Description: ProtectionContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: Status of registration of the container with the Recovery Services Vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerType:
{
Description: Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
Microsoft.ClassicCompute/virtualMachines: No description available. ,
Microsoft.Compute/virtualMachines: No description available. ,
AzureWorkloadContainer: No description available. ,
}
,
Required: True ,
}
enum ,
protectableObjectType:
{
Description: Type of the protectable object associated with this container ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: Status of registration of the container with the Recovery Services Vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerType:
{
Description: Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
Microsoft.ClassicCompute/virtualMachines: No description available. ,
Microsoft.Compute/virtualMachines: No description available. ,
AzureWorkloadContainer: No description available. ,
}
,
Required: True ,
}
enum ,
protectableObjectType:
{
Description: Type of the protectable object associated with this container ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
ProtectionContainers_Unregister (updated)
Description :  Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine whether the backend service has finished processing the request, call Get Container Operation Result API.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProtectionContainers_Unregister",
  "Description": {
    "new": "Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine\nwhether the backend service has finished processing the request, call Get Container Operation Result API.",
    "old": "Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine\r\nwhether the backend service has finished processing the request, call Get Container Operation Result API."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "The name of the BackupFabricResource",
        "old": "Name of the fabric where the container belongs."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "Name of the container whose details need to be fetched.",
        "old": "Name of the container which needs to be unregistered from the Recovery Services Vault."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ProtectionContainers_Inquire (updated)
Description :  This is an async operation and the results should be tracked using location header or Azure-async-url.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProtectionContainers_Inquire",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "The name of the BackupFabricResource",
        "old": "Fabric Name associated with the container."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "Name of the container whose details need to be fetched.",
        "old": "Name of the container in which inquiry needs to be triggered."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/inquire
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupWorkloadItems_List (updated)
Description :  Provides a pageable list of workload item of a specific container according to the query filter and the pagination parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupWorkloadItems_List",
  "Description": {
    "new": "Provides a pageable list of workload item of a specific container according to the query filter and the pagination\nparameters.",
    "old": "Provides a pageable list of workload item of a specific container according to the query filter and the pagination\r\nparameters."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "The name of the BackupFabricResource",
        "old": "Fabric name associated with the container."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "Name of the container whose details need to be fetched.",
        "old": "Name of the container."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_481e5e1276f74c61a244d0e674155b3b": {
              "#name": "location",
              "Description": "Resource location.",
              "Required": false,
              "Type": "string"
            },
            "@added_cb93d36f4bc84d8994e4ba49989a39fb": {
              "#name": "tags",
              "Description": "Resource tags.",
              "Required": false,
              "Type": "object"
            },
            "@added_e3d79c56c6b54eacbeb22bde2ed1118c": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/items
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
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 ,
}
[
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
properties:
{
Description: WorkloadItemResource properties ,
Required: False ,
}
{
backupManagementType:
{
Description: Type of backup management to backup an item. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of workload for the backup management ,
Required: False ,
}
string ,
workloadItemType:
{
Description: Type of the backup item. ,
Required: True ,
}
string ,
friendlyName:
{
Description: Friendly name of the backup item. ,
Required: False ,
}
string ,
protectionState:
{
Description: State of the back up item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
ProtectionContainerOperationResults_Get (updated)
Description :  Fetches the result of any operation on the container.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProtectionContainerOperationResults_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "vaults",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "backupFabrics",
        "old": "Fabric name associated with the container."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "The name of the ProtectionContainerResource",
        "old": "Container name whose information should be fetched."
      }
    },
    {
      "#name": "operationId",
      "Description": {
        "new": "The name of the ProtectionContainerResource",
        "old": "Operation ID which represents the operation whose result needs to be fetched."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "containerType",
            "Description": {
              "new": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\nBackup is VMAppContainer",
              "old": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\r\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\r\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\r\nBackup is VMAppContainer"
            }
          }
        ],
        "@added_40876a18b6664f9abfe41b9ac93c4b35": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_910db48a40a448408f67435880d8f245": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_d7652cc1babc41db920e2ac1d9180964": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/operationResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: vaults ,
Required: True ,
}
string ,
fabricName:
{
Description: backupFabrics ,
Required: True ,
}
string ,
containerName:
{
Description: The name of the ProtectionContainerResource ,
Required: True ,
}
string ,
operationId:
{
Description: The name of the ProtectionContainerResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: Status of registration of the container with the Recovery Services Vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerType:
{
Description: Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
Microsoft.ClassicCompute/virtualMachines: No description available. ,
Microsoft.Compute/virtualMachines: No description available. ,
AzureWorkloadContainer: No description available. ,
}
,
Required: True ,
}
enum ,
protectableObjectType:
{
Description: Type of the protectable object associated with this container ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ProtectedItems_Get (updated)
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 ¶

⚶ Changes

{
  "#id": "ProtectedItems_Get",
  "Description": {
    "new": "Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation,\ncall the GetItemOperationResult API.",
    "old": "Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation,\r\ncall the GetItemOperationResult API."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "The name of the BackupFabricResource",
        "old": "Fabric name associated with the backed up item."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "Name of the container whose details need to be fetched.",
        "old": "Container name associated with the backed up item."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_34e6d0c34d61492cbd2c226d159dc947": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_ef51aa93924249d191c1260daf70e08b": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_625d6c8c66e648ae889587e03ff8783d": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectedItemResource properties ,
Required: False ,
}
{
protectedItemType:
{
Description: backup item type. ,
Required: True ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: Type of workload this item represents. ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
VMwareVM: No description available. ,
SystemState: No description available. ,
Client: No description available. ,
GenericDataSource: No description available. ,
SQLDataBase: No description available. ,
AzureFileShare: No description available. ,
SAPHanaDatabase: No description available. ,
SAPAseDatabase: No description available. ,
SAPHanaDBInstance: No description available. ,
}
,
Required: False ,
}
enum ,
containerName:
{
Description: Unique name of container ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: Timestamp when the last (latest) backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
backupSetName:
{
Description: Name of the backup set the backup item belongs to ,
Required: False ,
}
string ,
createMode:
{
Description: Create mode to indicate recovery of existing soft deleted data source or creation of new data source. ,
Enum:
{
Invalid: No description available. ,
Default: No description available. ,
Recover: No description available. ,
}
,
Required: False ,
}
enum ,
deferredDeleteTimeInUTC:
{
Description: Time for deferred deletion in UTC ,
Format: date-time ,
Required: False ,
}
string ,
isScheduledForDeferredDelete:
{
Description: Flag to identify whether the DS is scheduled for deferred delete ,
Required: False ,
}
boolean ,
deferredDeleteTimeRemaining:
{
Description: Time remaining before the DS marked for deferred delete is permanently deleted ,
Required: False ,
}
string ,
isDeferredDeleteScheduleUpcoming:
{
Description: Flag to identify whether the deferred deleted DS is to be purged soon ,
Required: False ,
}
boolean ,
isRehydrate:
{
Description: Flag to identify that deferred deleted DS is to be moved into Pause state ,
Required: False ,
}
boolean ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
isArchiveEnabled:
{
Description: Flag to identify whether datasource is protected in archive ,
Required: False ,
}
boolean ,
policyName:
{
Description: Name of the policy used for protection ,
Required: False ,
}
string ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
vaultId:
{
Description: ID of the vault which protects this item ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
ProtectedItems_CreateOrUpdate (updated)
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 ¶

⚶ Changes

{
  "#id": "ProtectedItems_CreateOrUpdate",
  "Description": {
    "new": "Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an\nasynchronous operation. To know the status of the operation, call the GetItemOperationResult API.",
    "old": "Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an\r\nasynchronous operation. To know the status of the operation, call the GetItemOperationResult API."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "The name of the BackupFabricResource",
        "old": "Fabric name associated with the backup item."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "Name of the container whose details need to be fetched.",
        "old": "Container name associated with the backup item."
      }
    },
    {
      "#name": "protectedItemName",
      "Description": {
        "new": "Backed up item name whose details are to be fetched.",
        "old": "Item name to be backed up."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@added_9405b3a097d64887ae7b834caa95139e": {
            "#name": "tags",
            "Description": "Resource tags.",
            "Required": false,
            "Type": "object"
          },
          "@added_0c68d866e1cc4a9e97da54b1b9cde53b": {
            "#name": "location",
            "Description": "The geo-location where the resource lives",
            "Required": false,
            "Type": "string"
          },
          "@added_98a5e69e59c34ff69a707bc0a9b638fc": {
            "#name": "eTag",
            "Description": "Optional ETag.",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_c56b91b7155444bf8682ef542990d253": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_1fcbb46995d14b0583c3a018bca8ef21": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_00fbf7e5f6f04a42a2a52cf0ebeb8319": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
parameters:
{
Description: resource backed up item ,
Required: True ,
}
{
properties:
{
Description: ProtectedItemResource properties ,
Required: False ,
}
{
protectedItemType:
{
Description: backup item type. ,
Required: True ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: Type of workload this item represents. ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
VMwareVM: No description available. ,
SystemState: No description available. ,
Client: No description available. ,
GenericDataSource: No description available. ,
SQLDataBase: No description available. ,
AzureFileShare: No description available. ,
SAPHanaDatabase: No description available. ,
SAPAseDatabase: No description available. ,
SAPHanaDBInstance: No description available. ,
}
,
Required: False ,
}
enum ,
containerName:
{
Description: Unique name of container ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: Timestamp when the last (latest) backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
backupSetName:
{
Description: Name of the backup set the backup item belongs to ,
Required: False ,
}
string ,
createMode:
{
Description: Create mode to indicate recovery of existing soft deleted data source or creation of new data source. ,
Enum:
{
Invalid: No description available. ,
Default: No description available. ,
Recover: No description available. ,
}
,
Required: False ,
}
enum ,
deferredDeleteTimeInUTC:
{
Description: Time for deferred deletion in UTC ,
Format: date-time ,
Required: False ,
}
string ,
isScheduledForDeferredDelete:
{
Description: Flag to identify whether the DS is scheduled for deferred delete ,
Required: False ,
}
boolean ,
deferredDeleteTimeRemaining:
{
Description: Time remaining before the DS marked for deferred delete is permanently deleted ,
Required: False ,
}
string ,
isDeferredDeleteScheduleUpcoming:
{
Description: Flag to identify whether the deferred deleted DS is to be purged soon ,
Required: False ,
}
boolean ,
isRehydrate:
{
Description: Flag to identify that deferred deleted DS is to be moved into Pause state ,
Required: False ,
}
boolean ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
isArchiveEnabled:
{
Description: Flag to identify whether datasource is protected in archive ,
Required: False ,
}
boolean ,
policyName:
{
Description: Name of the policy used for protection ,
Required: False ,
}
string ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
vaultId:
{
Description: ID of the vault which protects this item ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (202)

{}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "ProtectedItems_Delete",
  "Description": {
    "new": "Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the\nrequest, call the GetItemOperationResult API.",
    "old": "Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the\r\nrequest, call the GetItemOperationResult API."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "The name of the BackupFabricResource",
        "old": "Fabric name associated with the backed up item."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "Name of the container whose details need to be fetched.",
        "old": "Container name associated with the backed up item."
      }
    },
    {
      "#name": "protectedItemName",
      "Description": {
        "new": "Backed up item name whose details are to be fetched.",
        "old": "Backed up item to be deleted."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
Backups_Trigger (updated)
Description :  Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the operation, call GetProtectedItemOperationResult API.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Backups_Trigger",
  "Description": {
    "new": "Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the\noperation, call GetProtectedItemOperationResult API.",
    "old": "Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the\r\noperation, call GetProtectedItemOperationResult API."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "The name of the BackupFabricResource",
        "old": "Fabric name associated with the backup item."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "Name of the container whose details need to be fetched.",
        "old": "Container name associated with the backup item."
      }
    },
    {
      "#name": "protectedItemName",
      "Description": {
        "new": "Backed up item name whose details are to be fetched.",
        "old": "Backup item for which backup needs to be triggered."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@added_bc933f4beb554a0facd7fe0bb5c855da": {
            "#name": "location",
            "Description": "Resource location.",
            "Required": false,
            "Type": "string"
          },
          "@added_566380315998477c9cd0f3aec65bb853": {
            "#name": "tags",
            "Description": "Resource tags.",
            "Required": false,
            "Type": "object"
          },
          "@added_c917a59994fc4cc7a3fa5c099424bee2": {
            "#name": "eTag",
            "Description": "Optional ETag.",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/backup
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
parameters:
{
Description: resource backup request ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
properties:
{
Description: BackupRequestResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
ProtectedItemOperationResults_Get (updated)
Description :  Fetches the result of any operation on the backup item.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProtectedItemOperationResults_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "vaults",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "backupFabrics",
        "old": "Fabric name associated with the backup item."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "The name of the ProtectionContainerResource",
        "old": "Container name associated with the backup item."
      }
    },
    {
      "#name": "protectedItemName",
      "Description": {
        "new": "The name of the ProtectedItemResource",
        "old": "Backup item name whose details are to be fetched."
      }
    },
    {
      "#name": "operationId",
      "Description": {
        "new": "The name of the ProtectedItemResource",
        "old": "OperationID which represents the operation whose result needs to be fetched."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_dbe30e37f91e401193a373a3e6c40422": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_47df04724ff14dd1a5705eae334d4628": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_9a2857b3fc1346fb82b8ad6e5d3f95c2": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: vaults ,
Required: True ,
}
string ,
fabricName:
{
Description: backupFabrics ,
Required: True ,
}
string ,
containerName:
{
Description: The name of the ProtectionContainerResource ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of the ProtectedItemResource ,
Required: True ,
}
string ,
operationId:
{
Description: The name of the ProtectedItemResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ProtectedItemOperationStatuses_Get (updated)
Description :  Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations create jobs. This method returns the list of jobs associated with the operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProtectedItemOperationStatuses_Get",
  "Description": {
    "new": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed\nor failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations\ncreate jobs. This method returns the list of jobs associated with the operation.",
    "old": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed\r\nor failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations\r\ncreate jobs. This method returns the list of jobs associated with the operation."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "vaults",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "backupFabrics",
        "old": "Fabric name associated with the backup item."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "The name of the ProtectionContainerResource",
        "old": "Container name associated with the backup item."
      }
    },
    {
      "#name": "protectedItemName",
      "Description": {
        "new": "The name of the ProtectedItemResource",
        "old": "Backup item name whose details are to be fetched."
      }
    },
    {
      "#name": "operationId",
      "Description": {
        "new": "The name of the ProtectedItemResource",
        "old": "OperationID represents the operation whose status needs to be fetched."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationsStatus/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: vaults ,
Required: True ,
}
string ,
fabricName:
{
Description: backupFabrics ,
Required: True ,
}
string ,
containerName:
{
Description: The name of the ProtectionContainerResource ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of the ProtectedItemResource ,
Required: True ,
}
string ,
operationId:
{
Description: The name of the ProtectedItemResource ,
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_List (updated)
Description :  Lists the backup copies for the backed up item.
Reference :  Link ¶

⚶ Changes

{
  "#id": "RecoveryPoints_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "The name of the BackupFabricResource",
        "old": "Fabric name associated with the backed up item."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "Name of the container whose details need to be fetched.",
        "old": "Container name associated with the backed up item."
      }
    },
    {
      "#name": "protectedItemName",
      "Description": {
        "new": "Backed up item name whose details are to be fetched.",
        "old": "Backed up item whose backup copies are to be fetched."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_bf367ede80584ccd97b50208496b8fe9": {
              "#name": "tags",
              "Description": "Resource tags.",
              "Required": false,
              "Type": "object"
            },
            "@added_421d1d3873154ebfaa5041bdabbe605b": {
              "#name": "location",
              "Description": "The geo-location where the resource lives",
              "Required": false,
              "Type": "string"
            },
            "@added_aa40d5c9bca64e6d87470f44e8bb2bc6": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
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)

{
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 ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
RecoveryPoints_Get (updated)
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 ¶

⚶ Changes

{
  "#id": "RecoveryPoints_Get",
  "Description": {
    "new": "Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation.\nTo know the status of the operation, call the GetProtectedItemOperationResult API.",
    "old": "Provides the information of the backed up data identified using RecoveryPointID. This is an asynchronous operation.\r\nTo know the status of the operation, call the GetProtectedItemOperationResult API."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "The name of the BackupFabricResource",
        "old": "Fabric name associated with backed up item."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "Name of the container whose details need to be fetched.",
        "old": "Container name associated with backed up item."
      }
    },
    {
      "#name": "protectedItemName",
      "Description": {
        "new": "Backed up item name whose details are to be fetched.",
        "old": "Backed up item name whose backup data needs to be fetched."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_357fa3cccf4c4486b78f3ed6535395ef": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_0fa188237cb34b07bb0079df20f37393": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_beb01829416147099db9137d7a5c5973": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose details are 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 ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
MoveRecoveryPoint (updated)
Description :  Move recovery point from one datastore to another store.
Reference :  Link ¶

⚶ Changes

{
  "#id": "MoveRecoveryPoint",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/move
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: RecoveryPointID represents the backed up data to be fetched. ,
Required: True ,
}
string ,
parameters:
{
Description: Move Resource Across Tiers Request ,
Required: True ,
}
{
objectType:
{
Description: Gets the class type. ,
Required: False ,
}
string ,
sourceTierType:
{
Description: Source tier from where RP needs to be moved ,
Enum:
{
Invalid: No description available. ,
InstantRP: No description available. ,
HardenedRP: No description available. ,
ArchivedRP: No description available. ,
}
,
Required: False ,
}
enum ,
targetTierType:
{
Description: Target tier where RP needs to be moved ,
Enum:
{
Invalid: No description available. ,
InstantRP: No description available. ,
HardenedRP: No description available. ,
ArchivedRP: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
ItemLevelRecoveryConnections_Provision (updated)
Description :  Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file explorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of provisioning, call GetProtectedItemOperationResult API.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ItemLevelRecoveryConnections_Provision",
  "Description": {
    "new": "Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file\nexplorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of\nprovisioning, call GetProtectedItemOperationResult API.",
    "old": "Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file\r\nexplorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of\r\nprovisioning, call GetProtectedItemOperationResult API."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "The name of the BackupFabricResource",
        "old": "Fabric name associated with the backed up items."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "Name of the container whose details need to be fetched.",
        "old": "Container name associated with the backed up items."
      }
    },
    {
      "#name": "protectedItemName",
      "Description": {
        "new": "Backed up item name whose details are to be fetched.",
        "old": "Backed up item name whose files/folders are to be restored."
      }
    },
    {
      "#name": "recoveryPointId",
      "Description": {
        "new": "RecoveryPointID represents the backed up data to be fetched.",
        "old": "Recovery point ID which represents backed up data. iSCSI connection will be provisioned\r\nfor this backed up data."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@added_e309653f607b46f4ac7068d3978b5d0a": {
            "#name": "location",
            "Description": "Resource location.",
            "Required": false,
            "Type": "string"
          },
          "@added_d5289b200b5d4046aa8c12e3fe6a1dba": {
            "#name": "tags",
            "Description": "Resource tags.",
            "Required": false,
            "Type": "object"
          },
          "@added_50be14f9db5b45fbb421b113a5404b57": {
            "#name": "eTag",
            "Description": "Optional ETag.",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/provisionInstantItemRecovery
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: RecoveryPointID represents the backed up data to be fetched. ,
Required: True ,
}
string ,
parameters:
{
Description: resource ILR request ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
properties:
{
Description: ILRRequestResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Restores_Trigger (updated)
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 ¶

⚶ Changes

{
  "#id": "Restores_Trigger",
  "Description": {
    "new": "Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use\nGetProtectedItemOperationResult API.",
    "old": "Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use\r\nGetProtectedItemOperationResult API."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "The name of the BackupFabricResource",
        "old": "Fabric name associated with the backed up items."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "Name of the container whose details need to be fetched.",
        "old": "Container name associated with the backed up items."
      }
    },
    {
      "#name": "protectedItemName",
      "Description": {
        "new": "Backed up item name whose details are to be fetched.",
        "old": "Backed up item to be restored."
      }
    },
    {
      "#name": "recoveryPointId",
      "Description": {
        "new": "RecoveryPointID represents the backed up data to be fetched.",
        "old": "Recovery point ID which represents the backed up data to be restored."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@added_7f6b61ff81804ff990349a5d6421a8af": {
            "#name": "location",
            "Description": "Resource location.",
            "Required": false,
            "Type": "string"
          },
          "@added_f1a8f1b6b7204a03825eb698f6c9a9f4": {
            "#name": "tags",
            "Description": "Resource tags.",
            "Required": false,
            "Type": "object"
          },
          "@added_a8c291e7228a4b8dabe3c7c85eab62fc": {
            "#name": "eTag",
            "Description": "Optional ETag.",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/restore
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: RecoveryPointID represents the backed up data to be fetched. ,
Required: True ,
}
string ,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
parameters:
{
Description: resource restore request ,
Required: True ,
}
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
properties:
{
Description: RestoreRequestResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
ItemLevelRecoveryConnections_Revoke (updated)
Description :  Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer displaying all recoverable files and folders. This is an asynchronous operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ItemLevelRecoveryConnections_Revoke",
  "Description": {
    "new": "Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer\ndisplaying all recoverable files and folders. This is an asynchronous operation.",
    "old": "Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer\r\ndisplaying all recoverable files and folders. This is an asynchronous operation."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "fabricName",
      "Description": {
        "new": "The name of the BackupFabricResource",
        "old": "Fabric name associated with the backed up items."
      }
    },
    {
      "#name": "containerName",
      "Description": {
        "new": "Name of the container whose details need to be fetched.",
        "old": "Container name associated with the backed up items."
      }
    },
    {
      "#name": "protectedItemName",
      "Description": {
        "new": "Backed up item name whose details are to be fetched.",
        "old": "Backed up item name whose files/folders are to be restored."
      }
    },
    {
      "#name": "recoveryPointId",
      "Description": {
        "new": "RecoveryPointID represents the backed up data to be fetched.",
        "old": "Recovery point ID which represents backed up data. iSCSI connection will be revoked for\r\nthis backed up data."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/revokeInstantItemRecovery
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: RecoveryPointID represents the backed up data to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
RecoveryPointsRecommendedForMove_List (updated)
Description :  Lists the recovery points recommended for move to another tier
Reference :  Link ¶

⚶ Changes

{
  "#id": "RecoveryPointsRecommendedForMove_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_1de324f6079a48a3a4bcb8c1e391af80": {
              "#name": "tags",
              "Description": "Resource tags.",
              "Required": false,
              "Type": "object"
            },
            "@added_625e15d55a104b369c83c2d07133f296": {
              "#name": "location",
              "Description": "The geo-location where the resource lives",
              "Required": false,
              "Type": "string"
            },
            "@added_7fea3d81f4544e4cbabf463c7d450696": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPointsRecommendedForMove
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
fabricName:
{
Description: The name of the BackupFabricResource ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose details are to be fetched. ,
Required: True ,
}
string ,
parameters:
{
Description: List Recovery points Recommended for Move Request ,
Required: True ,
}
{
objectType:
{
Description: Gets the class type. ,
Required: False ,
}
string ,
excludedRPList:
{
Description: List of Recovery Points excluded from Move ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: RecoveryPointResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
ProtectionContainers_Refresh (updated)
Description :  Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an asynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProtectionContainers_Refresh",
  "Description": {
    "new": "Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an\nasynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.",
    "old": "Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an\r\nasynchronous operation. To know the status of the operation, call GetRefreshOperationResult API."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/refreshContainers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated the container. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
BackupJobs_List (updated)
Description :  Provides a pageable list of jobs.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupJobs_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_5394603ef5424be2bb604c53bb0a9979": {
              "#name": "tags",
              "Description": "Resource tags.",
              "Required": false,
              "Type": "object"
            },
            "@added_e1e3b2b0955148bdb64ed0bc41be3f82": {
              "#name": "location",
              "Description": "The geo-location where the resource lives",
              "Required": false,
              "Type": "string"
            },
            "@added_8287808cd98f4392aa992d1bf11234fb": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
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 ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
JobDetails_Get (updated)
Description :  Gets extended information associated with the job.
Reference :  Link ¶

⚶ Changes

{
  "#id": "JobDetails_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_a34bd52014314bd18739542e47c53d43": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_ff69cb7757b844cf8b90e52aeb9df072": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_00adf4a136574f13b5cc0131144beb9a": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
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 ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
JobCancellations_Trigger (updated)
Description :  Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call GetCancelOperationResult API.
Reference :  Link ¶

⚶ Changes

{
  "#id": "JobCancellations_Trigger",
  "Description": {
    "new": "Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call\nGetCancelOperationResult API.",
    "old": "Cancels a job. This is an asynchronous operation. To know the status of the cancellation, call\r\nGetCancelOperationResult API."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "jobName",
      "Description": {
        "new": "Name of the job whose details are to be fetched.",
        "old": "Name of the job to cancel."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/cancel
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
jobName:
{
Description: Name of the job whose details are to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
JobOperationResults_Get (updated)
Description :  Fetches the result of any operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "JobOperationResults_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "vaults",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "jobName",
      "Description": {
        "new": "The name of the JobResource",
        "old": "Job name whose operation result has to be fetched."
      }
    },
    {
      "#name": "operationId",
      "Description": {
        "new": "The name of the JobResource",
        "old": "OperationID which represents the operation whose result has to be fetched."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/operationResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: vaults ,
Required: True ,
}
string ,
jobName:
{
Description: The name of the JobResource ,
Required: True ,
}
string ,
operationId:
{
Description: The name of the JobResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ExportJobsOperationResults_Get (updated)
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 ¶

⚶ Changes

{
  "#id": "ExportJobsOperationResults_Get",
  "Description": {
    "new": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also\ncontains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format.",
    "old": "Gets the operation result of operation triggered by Export Jobs API. If the operation is successful, then it also\r\ncontains URL of a Blob and a SAS key to access the same. The blob contains exported jobs in JSON serialized format."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "vaults",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "operationId",
      "Description": {
        "new": "The name of the JobResource",
        "old": "OperationID which represents the export job."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/operationResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: vaults ,
Required: True ,
}
string ,
operationId:
{
Description: The name of the JobResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
Jobs_Export (updated)
Description :  Triggers export of jobs specified by filters and returns an OperationID to track.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Jobs_Export",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobsExport
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
BackupOperationResults_Get (updated)
Description :  Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the status code in the response would be Accepted. It will continue to be in this state till it reaches completion. On successful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is part of the Location header of the operation response.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupOperationResults_Get",
  "Description": {
    "new": "Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the\nstatus code in the response would be Accepted. It will continue to be in this state till it reaches completion. On\nsuccessful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is\npart of the Location header of the operation response.",
    "old": "Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the\r\nstatus code in the response would be Accepted. It will continue to be in this state till it reaches completion. On\r\nsuccessful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is\r\npart of the Location header of the operation response."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupOperationResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
operationId:
{
Description: OperationID which represents the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
BackupOperationStatuses_Get (updated)
Description :  Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs when the operation is complete.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupOperationStatuses_Get",
  "Description": {
    "new": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed\nor failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations\ncreate jobs. This method returns the list of jobs when the operation is complete.",
    "old": "Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed\r\nor failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations\r\ncreate jobs. This method returns the list of jobs when the operation is complete."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupOperations/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
operationId:
{
Description: OperationID which represents the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
BackupPolicies_List (updated)
Description :  Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch scoped results.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupPolicies_List",
  "Description": {
    "new": "Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch\nscoped results.",
    "old": "Lists of backup policies associated with Recovery Services Vault. API provides pagination parameters to fetch\r\nscoped results."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_e548144579f9441f888253cf8aede2de": {
              "#name": "tags",
              "Description": "Resource tags.",
              "Required": false,
              "Type": "object"
            },
            "@added_9aff4e5dea724dc8a4d0f0f897f1ff31": {
              "#name": "location",
              "Description": "The geo-location where the resource lives",
              "Required": false,
              "Type": "string"
            },
            "@added_b01e689716c94491b5ba7d6564d83873": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ProtectionPolicyResource properties ,
Required: False ,
}
{
protectedItemsCount:
{
Description: Number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
ProtectionPolicies_Get (updated)
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 ¶

⚶ Changes

{
  "#id": "ProtectionPolicies_Get",
  "Description": {
    "new": "Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous\noperation. Status of the operation can be fetched using GetPolicyOperationResult API.",
    "old": "Provides the details of the backup policies associated to Recovery Services Vault. This is an asynchronous\r\noperation. Status of the operation can be fetched using GetPolicyOperationResult API."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_efbc0c6d99864276836ba22194e7b2f9": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_9da390a9110e4b609007ef9a509d39ae": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_8342b1a7684c492ca6fc29b2dab94f6a": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
policyName:
{
Description: Backup policy information to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionPolicyResource properties ,
Required: False ,
}
{
protectedItemsCount:
{
Description: Number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
ProtectionPolicies_CreateOrUpdate (updated)
Description :  Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProtectionPolicies_CreateOrUpdate",
  "Description": {
    "new": "Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched\nusing GetPolicyOperationResult API.",
    "old": "Creates or modifies a backup policy. This is an asynchronous operation. Status of the operation can be fetched\r\nusing GetPolicyOperationResult API."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "policyName",
      "Description": {
        "new": "Backup policy information to be fetched.",
        "old": "Backup policy to be created."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@added_40cf677a6b8f4278ab84653d1d37fa6e": {
            "#name": "tags",
            "Description": "Resource tags.",
            "Required": false,
            "Type": "object"
          },
          "@added_3bfe1a68e17d41abb08faca7ddcfc82b": {
            "#name": "location",
            "Description": "The geo-location where the resource lives",
            "Required": false,
            "Type": "string"
          },
          "@added_a1b1598f79c742ecb53cd281a032df0b": {
            "#name": "eTag",
            "Description": "Optional ETag.",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_2db2c13e762442c294ac52015239bd84": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_9a244dfd94da48cba5e64f6778beba4d": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_3e008f213bd345b084c39dfb53daf701": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
policyName:
{
Description: Backup policy information to be fetched. ,
Required: True ,
}
string ,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
parameters:
{
Description: resource backup policy ,
Required: True ,
}
{
properties:
{
Description: ProtectionPolicyResource properties ,
Required: False ,
}
{
protectedItemsCount:
{
Description: Number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionPolicyResource properties ,
Required: False ,
}
{
protectedItemsCount:
{
Description: Number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProtectionPolicies_Delete (updated)
Description :  Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the operation can be fetched using GetProtectionPolicyOperationResult API.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProtectionPolicies_Delete",
  "Description": {
    "new": "Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the\noperation can be fetched using GetProtectionPolicyOperationResult API.",
    "old": "Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the\r\noperation can be fetched using GetProtectionPolicyOperationResult API."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "policyName",
      "Description": {
        "new": "Backup policy information to be fetched.",
        "old": "Backup policy to be deleted."
      }
    }
  ],
  "$responses": {
    "@added_d8aac0021ab4436ab5d9a762ae9f2253": {
      "202": [
        {
          "#name": "location",
          "Description": "The Location header contains the URL where the status of the long running operation can be checked.",
          "Type": "string"
        },
        {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
policyName:
{
Description: Backup policy information to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
ProtectionPolicyOperationResults_Get (updated)
Description :  Provides the result of an operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProtectionPolicyOperationResults_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "vaults",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "policyName",
      "Description": {
        "new": "The name of the ProtectionPolicyResource",
        "old": "Backup policy name whose operation's result needs to be fetched."
      }
    },
    {
      "#name": "operationId",
      "Description": {
        "new": "The name of the ProtectionPolicyResource",
        "old": "Operation ID which represents the operation whose result needs to be fetched."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_55e8cb6bdd554d5aaf7fe0b9aa90a2dd": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_69ea19d2c8a64aa6b0246591519871bf": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_6726f935a7004cf18cca24fac41bb141": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}/operationResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: vaults ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the ProtectionPolicyResource ,
Required: True ,
}
string ,
operationId:
{
Description: The name of the ProtectionPolicyResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ProtectionPolicyResource properties ,
Required: False ,
}
{
protectedItemsCount:
{
Description: Number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
ProtectionPolicyOperationStatuses_Get (updated)
Description :  Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed or failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs associated with operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ProtectionPolicyOperationStatuses_Get",
  "Description": {
    "new": "Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed\nor failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations\ncreate jobs. This method returns the list of jobs associated with operation.",
    "old": "Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed\r\nor failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations\r\ncreate jobs. This method returns the list of jobs associated with operation."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "vaults",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "policyName",
      "Description": {
        "new": "The name of the ProtectionPolicyResource",
        "old": "Backup policy name whose operation's status needs to be fetched."
      }
    },
    {
      "#name": "operationId",
      "Description": {
        "new": "The name of the ProtectionPolicyResource",
        "old": "Operation ID which represents an operation whose status needs to be fetched."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}/operations/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: vaults ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the ProtectionPolicyResource ,
Required: True ,
}
string ,
operationId:
{
Description: The name of the ProtectionPolicyResource ,
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 ,
}
,
]
,
}
,
}
BackupProtectableItems_List (updated)
Description :  Provides a pageable list of protectable objects within your subscription according to the query filter and the pagination parameters.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupProtectableItems_List",
  "Description": {
    "new": "Provides a pageable list of protectable objects within your subscription according to the query filter and the\npagination parameters.",
    "old": "Provides a pageable list of protectable objects within your subscription according to the query filter and the\r\npagination parameters."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_3aac106c8882400abc015836bfc31bff": {
              "#name": "location",
              "Description": "Resource location.",
              "Required": false,
              "Type": "string"
            },
            "@added_8f8c68346f11420b9781a156f1e3c6fd": {
              "#name": "tags",
              "Description": "Resource tags.",
              "Required": false,
              "Type": "object"
            },
            "@added_0b882ae8c72949cb989379c1b0ec59ab": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectableItems
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
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 ,
}
[
{
location:
{
Description: Resource location. ,
Required: False ,
}
string ,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
properties:
{
Description: WorkloadProtectableItemResource properties ,
Required: False ,
}
{
backupManagementType:
{
Description: Type of backup management to backup an item. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of workload for the backup management ,
Required: False ,
}
string ,
protectableItemType:
{
Description: Type of the backup item. ,
Required: True ,
}
string ,
friendlyName:
{
Description: Friendly name of the backup item. ,
Required: False ,
}
string ,
protectionState:
{
Description: State of the back up item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
ProtectionFailed: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
BackupProtectedItems_List (updated)
Description :  Provides a pageable list of all items that are backed up within a vault.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupProtectedItems_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_1b6ecda9620743fbbec3d3c2ffa78eaa": {
              "#name": "tags",
              "Description": "Resource tags.",
              "Required": false,
              "Type": "object"
            },
            "@added_62e1d41944ac44de8c39165bac2a379e": {
              "#name": "location",
              "Description": "The geo-location where the resource lives",
              "Required": false,
              "Type": "string"
            },
            "@added_0d5f293e469746feb7b57324cc02f649": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectedItems
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
$skipToken:
{
Description: skipToken Filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ProtectedItemResource properties ,
Required: False ,
}
{
protectedItemType:
{
Description: backup item type. ,
Required: True ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backed up item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: Type of workload this item represents. ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
VMwareVM: No description available. ,
SystemState: No description available. ,
Client: No description available. ,
GenericDataSource: No description available. ,
SQLDataBase: No description available. ,
AzureFileShare: No description available. ,
SAPHanaDatabase: No description available. ,
SAPAseDatabase: No description available. ,
SAPHanaDBInstance: No description available. ,
}
,
Required: False ,
}
enum ,
containerName:
{
Description: Unique name of container ,
Required: False ,
}
string ,
sourceResourceId:
{
Description: ARM ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: ID of the backup policy with which this item is backed up. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: Timestamp when the last (latest) backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
backupSetName:
{
Description: Name of the backup set the backup item belongs to ,
Required: False ,
}
string ,
createMode:
{
Description: Create mode to indicate recovery of existing soft deleted data source or creation of new data source. ,
Enum:
{
Invalid: No description available. ,
Default: No description available. ,
Recover: No description available. ,
}
,
Required: False ,
}
enum ,
deferredDeleteTimeInUTC:
{
Description: Time for deferred deletion in UTC ,
Format: date-time ,
Required: False ,
}
string ,
isScheduledForDeferredDelete:
{
Description: Flag to identify whether the DS is scheduled for deferred delete ,
Required: False ,
}
boolean ,
deferredDeleteTimeRemaining:
{
Description: Time remaining before the DS marked for deferred delete is permanently deleted ,
Required: False ,
}
string ,
isDeferredDeleteScheduleUpcoming:
{
Description: Flag to identify whether the deferred deleted DS is to be purged soon ,
Required: False ,
}
boolean ,
isRehydrate:
{
Description: Flag to identify that deferred deleted DS is to be moved into Pause state ,
Required: False ,
}
boolean ,
resourceGuardOperationRequests:
{
Description: ResourceGuardOperationRequests on which LAC check will be performed ,
Required: False ,
}
[
string ,
]
,
isArchiveEnabled:
{
Description: Flag to identify whether datasource is protected in archive ,
Required: False ,
}
boolean ,
policyName:
{
Description: Name of the policy used for protection ,
Required: False ,
}
string ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
vaultId:
{
Description: ID of the vault which protects this item ,
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
BackupProtectionContainers_List (updated)
Description :  Lists the containers registered to Recovery Services Vault.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupProtectionContainers_List",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "properties": [
              {
                "#name": "containerType",
                "Description": {
                  "new": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\nBackup is VMAppContainer",
                  "old": "Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2.\r\nClassic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is\r\nWindows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload\r\nBackup is VMAppContainer"
                }
              }
            ],
            "@added_0d0293fee1b0489eaf6bec65dc37ea4f": {
              "#name": "tags",
              "Description": "Resource tags.",
              "Required": false,
              "Type": "object"
            },
            "@added_9154f48a67254d7e8e6d903736f7b2b7": {
              "#name": "location",
              "Description": "The geo-location where the resource lives",
              "Required": false,
              "Type": "string"
            },
            "@added_c5c9be2459d4455ebd2306d1b15342f6": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectionContainers
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (200)

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

⚶ Changes

{
  "#id": "ResourceGuardProxies_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "value": {
          "$properties": {
            "@added_323ed869bec74a7a94ce7bfd0a4aa252": {
              "#name": "tags",
              "Description": "Resource tags.",
              "Required": false,
              "Type": "object"
            },
            "@added_53642c7db1044929a2756f5d3fed709d": {
              "#name": "location",
              "Description": "The geo-location where the resource lives",
              "Required": false,
              "Type": "string"
            },
            "@added_37672a3cda0f4d4081d6c58a336f4f23": {
              "#name": "eTag",
              "Description": "Optional ETag.",
              "Required": false,
              "Type": "string"
            }
          }
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ResourceGuardProxyBaseResource properties ,
Required: False ,
}
{
resourceGuardResourceId:
{
Required: True ,
}
string ,
resourceGuardOperationDetails:
{
Required: False ,
}
[
{
vaultCriticalOperation:
{
Required: False ,
}
string ,
defaultResourceRequest:
{
Required: False ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
ResourceGuardProxy_Get (updated)
Description :  Returns ResourceGuardProxy under vault and with the name referenced in request
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuardProxy_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_9eded138c97d4d5b9edcb41f1ba76e9a": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_4fc095ffec8e4ba286a4f728d39f7efe": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_59da26808263430ea199406946ab90c7": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
resourceGuardProxyName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: ResourceGuardProxyBaseResource properties ,
Required: False ,
}
{
resourceGuardResourceId:
{
Required: True ,
}
string ,
resourceGuardOperationDetails:
{
Required: False ,
}
[
{
vaultCriticalOperation:
{
Required: False ,
}
string ,
defaultResourceRequest:
{
Required: False ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
ResourceGuardProxy_Put (updated)
Description :  Add or Update ResourceGuardProxy under vault Secures vault critical operations
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuardProxy_Put",
  "Description": {
    "new": "Add or Update ResourceGuardProxy under vault\nSecures vault critical operations",
    "old": "Add or Update ResourceGuardProxy under vault\r\nSecures vault critical operations"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@added_26920090f1cc4fd382dbe1bb16535a6f": {
            "#name": "tags",
            "Description": "Resource tags.",
            "Required": false,
            "Type": "object"
          },
          "@added_7857846cf5894dfea1d6200bd568f70b": {
            "#name": "location",
            "Description": "The geo-location where the resource lives",
            "Required": false,
            "Type": "string"
          },
          "@added_a021093a24ae4c9ebfb7c01f72636a59": {
            "#name": "eTag",
            "Description": "Optional ETag.",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_15b6c7fde4b04cfbbc67787396bdc912": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_8720f259cce748a1a0b83a1bf0b0db0b": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_19335ac928514c2bb47be50036b9b38b": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
resourceGuardProxyName:
{
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
properties:
{
Description: ResourceGuardProxyBaseResource properties ,
Required: False ,
}
{
resourceGuardResourceId:
{
Required: True ,
}
string ,
resourceGuardOperationDetails:
{
Required: False ,
}
[
{
vaultCriticalOperation:
{
Required: False ,
}
string ,
defaultResourceRequest:
{
Required: False ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: ResourceGuardProxyBaseResource properties ,
Required: False ,
}
{
resourceGuardResourceId:
{
Required: True ,
}
string ,
resourceGuardOperationDetails:
{
Required: False ,
}
[
{
vaultCriticalOperation:
{
Required: False ,
}
string ,
defaultResourceRequest:
{
Required: False ,
}
string ,
}
,
]
,
lastUpdatedTime:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
ResourceGuardProxy_Delete (updated)
Description :  Delete ResourceGuardProxy under vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuardProxy_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
resourceGuardProxyName:
{
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ 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 ,
}
,
]
,
}
,
}
ResourceGuardProxy_UnlockDelete (updated)
Description :  Secures delete ResourceGuardProxy operations.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ResourceGuardProxy_UnlockDelete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupResourceGuardProxies/{resourceGuardProxyName}/unlockDelete
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
resourceGuardProxyName:
{
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
resourceGuardOperationRequests:
{
Required: False ,
}
[
string ,
]
,
resourceToBeDeleted:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
SecurityPINs_Get (updated)
Description :  Get the security PIN.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SecurityPINs_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupSecurityPIN
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
parameters:
{
Description: security pin request ,
Required: False ,
}
{
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
FetchTieringCost_Post (updated)
Description :  Provides the details of the tiering related sizes and cost. Status of the operation can be fetched using GetTieringCostOperationStatus API and result using GetTieringCostOperationResult API.
Reference :  Link ¶

⚶ Changes

{
  "#id": "FetchTieringCost_Post",
  "Description": {
    "new": "Provides the details of the tiering related sizes and cost.\nStatus of the operation can be fetched using GetTieringCostOperationStatus API and result using GetTieringCostOperationResult API.",
    "old": "Provides the details of the tiering related sizes and cost.\r\nStatus of the operation can be fetched using GetTieringCostOperationStatus API and result using GetTieringCostOperationResult API."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "parameters": {
        "Description": {
          "new": "Base class for tiering cost request.\nSpecific cost request types are derived from this class.",
          "old": "Base class for tiering cost request.\r\nSpecific cost request types are derived from this class."
        }
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "@added_b1b05a282a754710bfbd8d4f7023435c": {
          "#name": "retry-after",
          "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "Type": "integer"
        }
      }
    ],
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

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

⚐ Response (200)

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

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
GetTieringCostOperationResult_Get (updated)
Description :  Gets the result of async operation for tiering cost
Reference :  Link ¶

⚶ Changes

{
  "#id": "GetTieringCostOperationResult_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupTieringCost/default/operationResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
operationId:
{
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (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 ,
}
,
]
,
}
,
}
TieringCostOperationStatus_Get (updated)
Description :  Gets the status of async operations of tiering cost
Reference :  Link ¶

⚶ Changes

{
  "#id": "TieringCostOperationStatus_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupTieringCost/default/operationsStatus/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
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 ,
}
,
]
,
}
,
}
ValidateOperation_Trigger (updated)
Description :  Validate operation for specified backed up item in the form of an asynchronous operation. Returns tracking headers which can be tracked using GetValidateOperationResult API.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ValidateOperation_Trigger",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupTriggerValidateOperation
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: resource validate operation request ,
Required: True ,
}
{
id:
{
Description: Recovery point ID. ,
Required: True ,
}
string ,
properties:
{
Description: ValidateOperationRequestResource properties ,
Required: True ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
Operation_Validate (updated)
Description :  Validate operation for specified backed up item. This is a synchronous operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "Operation_Validate",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperation
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
parameters:
{
Description: resource validate operation request ,
Required: True ,
}
{
id:
{
Description: Recovery point ID. ,
Required: True ,
}
string ,
properties:
{
Description: ValidateOperationRequestResource properties ,
Required: True ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (200)

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

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
ValidateOperationResults_Get (updated)
Description :  Fetches the result of a triggered validate operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ValidateOperationResults_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperationResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
operationId:
{
Description: OperationID which represents the operation whose result needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: 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 ,
}
,
]
,
}
,
}
ValidateOperationStatuses_Get (updated)
Description :  Fetches the status of a triggered validate operation. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of the operation. If operation has completed, this method returns the list of errors obtained while validating the operation.
Reference :  Link ¶

⚶ Changes

{
  "#id": "ValidateOperationStatuses_Get",
  "Description": {
    "new": "Fetches the status of a triggered validate operation. The status can be in progress, completed\nor failed. You can refer to the OperationStatus enum for all the possible states of the operation.\nIf operation has completed, this method returns the list of errors obtained while validating the operation.",
    "old": "Fetches the status of a triggered validate operation. The status can be in progress, completed\r\nor failed. You can refer to the OperationStatus enum for all the possible states of the operation.\r\nIf operation has completed, this method returns the list of errors obtained while validating the operation."
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupValidateOperationsStatuses/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
operationId:
{
Description: OperationID represents the operation whose status needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚶ Changes

{
  "#id": "BackupResourceVaultConfigs_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_ce2ab4031a974821b67debb044a6ead7": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_488afff6b29a400fac3129ae3930d72c": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_0c10ceb4c0a14b799b400f2b99976635": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The resource management error response."
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupconfig/vaultconfig
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: BackupResourceVaultConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
enhancedSecurityState:
{
Description: Enabled or Disabled. ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteFeatureState:
{
Description: Soft Delete feature state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
isSoftDeleteFeatureStateEditable:
{
Description: This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault ,
Required: False ,
}
boolean ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
BackupResourceVaultConfigs_Put (updated)
Description :  Updates vault security config.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupResourceVaultConfigs_Put",
  "Description": {
    "new": "Updates vault security config.",
    "old": "Updates vault security config. "
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@added_e4a5606e88ff4d738b451105a5a20058": {
            "#name": "tags",
            "Description": "Resource tags.",
            "Required": false,
            "Type": "object"
          },
          "@added_65691d9a6ba74209b2e7a69922757ec2": {
            "#name": "location",
            "Description": "The geo-location where the resource lives",
            "Required": false,
            "Type": "string"
          },
          "@added_843c9ded967942588ec0b69987c38321": {
            "#name": "eTag",
            "Description": "Optional ETag.",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_4cb0fcb8157a4715a44ac40ed20ecfce": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_62769295f8b149329314380749e79370": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_a7e470146d804fbb8393f5b7d977c685": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The resource management error response."
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupconfig/vaultconfig
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
parameters:
{
Description: resource config request ,
Required: True ,
}
{
properties:
{
Description: BackupResourceVaultConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
enhancedSecurityState:
{
Description: Enabled or Disabled. ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteFeatureState:
{
Description: Soft Delete feature state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
isSoftDeleteFeatureStateEditable:
{
Description: This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault ,
Required: False ,
}
boolean ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: BackupResourceVaultConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
enhancedSecurityState:
{
Description: Enabled or Disabled. ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteFeatureState:
{
Description: Soft Delete feature state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
isSoftDeleteFeatureStateEditable:
{
Description: This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault ,
Required: False ,
}
boolean ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
BackupResourceVaultConfigs_Update (updated)
Description :  Updates vault security config.
Reference :  Link ¶

⚶ Changes

{
  "#id": "BackupResourceVaultConfigs_Update",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@added_aa0df691e31d4d459e345b5a18f4f605": {
            "#name": "tags",
            "Description": "Resource tags.",
            "Required": false,
            "Type": "object"
          },
          "@added_e94eee38639b4e4ea5329f2357aec55f": {
            "#name": "location",
            "Description": "The geo-location where the resource lives",
            "Required": false,
            "Type": "string"
          },
          "@added_3ab302e5cc8541329e9f6a79ae04af9c": {
            "#name": "eTag",
            "Description": "Optional ETag.",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_e30970e6babe44f0b039a8a09a34fcdb": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_3c66d9eadb4f4d0da0a16196dd904358": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_411f26cb730b4ee9955435af2259a181": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The resource management error response."
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupconfig/vaultconfig
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
x-ms-authorization-auxiliary:
{
Required: False ,
}
string ,
parameters:
{
Description: resource config request ,
Required: True ,
}
{
properties:
{
Description: BackupResourceVaultConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
enhancedSecurityState:
{
Description: Enabled or Disabled. ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteFeatureState:
{
Description: Soft Delete feature state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
isSoftDeleteFeatureStateEditable:
{
Description: This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault ,
Required: False ,
}
boolean ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
properties:
{
Description: BackupResourceVaultConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
ZoneRedundant: No description available. ,
ReadAccessGeoZoneRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
enhancedSecurityState:
{
Description: Enabled or Disabled. ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteFeatureState:
{
Description: Soft Delete feature state ,
Enum:
{
Invalid: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
AlwaysON: No description available. ,
}
,
Required: False ,
}
enum ,
softDeleteRetentionPeriodInDays:
{
Description: Soft delete retention period in days ,
Format: int32 ,
Required: False ,
}
integer ,
resourceGuardOperationRequests:
{
Description: ResourceGuard Operation Requests ,
Required: False ,
}
[
string ,
]
,
isSoftDeleteFeatureStateEditable:
{
Description: This flag is no longer in use. Please use 'softDeleteFeatureState' to set the soft delete state for the vault ,
Required: False ,
}
boolean ,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
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 ,
}
,
]
,
}
,
}
BMSPrepareDataMoveOperationResult_Get (updated)
Description :  Fetches operation status for data move operation on vault
Reference :  Link ¶

⚶ Changes

{
  "#id": "BMSPrepareDataMoveOperationResult_Get",
  "Description": {
    "new": "Fetches operation status for data move operation on vault",
    "old": "Fetches Operation Result for Prepare Data Move"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "vaults",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The resource management error response."
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/operationResults/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: vaults ,
Required: True ,
}
string ,
operationId:
{
Description: The name of the BackupResourceConfigResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "GetOperationStatus",
  "Description": {
    "new": "Fetches Operation Result for Prepare Data Move",
    "old": "Fetches operation status for data move operation on vault"
  },
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "vaults",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The resource management error response."
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/operationStatus/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: vaults ,
Required: True ,
}
string ,
operationId:
{
Description: The name of the BackupResourceConfigResource ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚶ Changes

{
  "#id": "BMSPrepareDataMove",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "parameters": {
        "$properties": [
          {
            "#name": "sourceContainerArmIds",
            "Description": {
              "new": "Source Container ArmIds\nThis needs to be populated only if DataMoveLevel is set to container",
              "old": "Source Container ArmIds\r\nThis needs to be populated only if DataMoveLevel is set to container"
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The resource management error response."
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/prepareDataMove
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
parameters:
{
Description: Prepare data move request ,
Required: True ,
}
{
targetResourceId:
{
Description: ARM Id of target vault ,
Required: True ,
}
string ,
targetRegion:
{
Description: Target Region ,
Required: True ,
}
string ,
dataMoveLevel:
{
Description: DataMove Level ,
Enum:
{
Invalid: No description available. ,
Vault: No description available. ,
Container: No description available. ,
}
,
Required: True ,
}
enum ,
sourceContainerArmIds:
{
Description: Source Container ArmIds This needs to be populated only if DataMoveLevel is set to container ,
Required: False ,
}
[
string ,
]
,
ignoreMoved:
{
Description: Ignore the artifacts which are already moved. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "BMSTriggerDataMove",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The resource management error response."
      }
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupstorageconfig/vaultstorageconfig/triggerDataMove
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
parameters:
{
Description: Trigger data move request ,
Required: True ,
}
{
sourceResourceId:
{
Description: ARM Id of source vault ,
Required: True ,
}
string ,
sourceRegion:
{
Description: Source Region ,
Required: True ,
}
string ,
dataMoveLevel:
{
Description: DataMove Level ,
Enum:
{
Invalid: No description available. ,
Vault: No description available. ,
Container: No description available. ,
}
,
Required: True ,
}
enum ,
correlationId:
{
Description: Correlation Id ,
Required: True ,
}
string ,
sourceContainerArmIds:
{
Description: Source Container ArmIds ,
Required: False ,
}
[
string ,
]
,
pauseGC:
{
Description: Pause GC ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "PrivateEndpointConnection_Get",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_627355c684e44521a54d48c2fed4811f": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_19d13e3347164cb89625951e6bd1d151": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_c05276139498408cb35342d42cef7812": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The resource management error response."
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (default)

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

⚶ Changes

{
  "#id": "PrivateEndpointConnection_Put",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "parameters": {
        "$properties": {
          "@added_b9b9a0783198469dbc21f6ebe900e565": {
            "#name": "tags",
            "Description": "Resource tags.",
            "Required": false,
            "Type": "object"
          },
          "@added_88c2e330f4c342188247e4a5649911b5": {
            "#name": "location",
            "Description": "The geo-location where the resource lives",
            "Required": false,
            "Type": "string"
          },
          "@added_c1738239dcb64d5fb9d8c8346ab1c993": {
            "#name": "eTag",
            "Description": "Optional ETag.",
            "Required": false,
            "Type": "string"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "@added_9a4c0b89bdfe4ff399802024ce4c722e": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_9b01ee485f6c437d9d17f51356988e5d": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_ddcece097cfb493ba9f8e826c394b3d8": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "201": {
      "$properties": {
        "@added_63bbff5351c04fe79e3dbc6ec91c90d4": {
          "#name": "tags",
          "Description": "Resource tags.",
          "Required": false,
          "Type": "object"
        },
        "@added_dfdb225aeab0416381301c504a0c24cc": {
          "#name": "location",
          "Description": "The geo-location where the resource lives",
          "Required": false,
          "Type": "string"
        },
        "@added_9dfa1b17380e421c8ea83332d5e82d1c": {
          "#name": "eTag",
          "Description": "Optional ETag.",
          "Required": false,
          "Type": "string"
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
properties:
{
Description: PrivateEndpointConnectionResource properties ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Gets or sets private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Gets or sets id ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required ,
Required: False ,
}
string ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

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

⚐ Response (201)

{
$headers:
{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}
,
$schema:
{
Description: Private Endpoint Connection Response Properties ,
}
{
properties:
{
Description: PrivateEndpointConnectionResource properties ,
Required: False ,
}
{
provisioningState:
{
Description: Gets or sets provisioning state of the private endpoint connection ,
Enum:
{
Succeeded: No description available. ,
Deleting: No description available. ,
Failed: No description available. ,
Pending: No description available. ,
}
,
Required: False ,
}
enum ,
privateEndpoint:
{
Description: Gets or sets private endpoint associated with the private endpoint connection ,
Required: False ,
}
{
id:
{
Description: Gets or sets id ,
Required: False ,
}
string ,
}
,
groupIds:
{
Description: Group Ids for the Private Endpoint ,
Required: False ,
}
[
string ,
]
,
privateLinkServiceConnectionState:
{
Description: Gets or sets private link service connection state ,
Required: False ,
}
{
status:
{
Description: Gets or sets the status ,
Enum:
{
Pending: No description available. ,
Approved: No description available. ,
Rejected: No description available. ,
Disconnected: No description available. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Gets or sets description ,
Required: False ,
}
string ,
actionsRequired:
{
Description: Gets or sets actions required ,
Required: False ,
}
string ,
}
,
}
,
tags:
{
Description: Resource tags. ,
Required: False ,
}
object ,
location:
{
Description: The geo-location where the resource lives ,
Required: False ,
}
string ,
eTag:
{
Description: Optional ETag. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "PrivateEndpointConnection_Delete",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "The name of the VaultResource",
        "old": "The name of the recovery services vault."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "An error response from the Container Instance service."
      },
      "$properties": {
        "error": [
          {
            "#name": "code",
            "Description": {
              "new": "The error code.",
              "old": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically."
            }
          },
          {
            "#name": "message",
            "Description": {
              "new": "The error message.",
              "old": "A message describing the error, intended to be suitable for display in a user interface."
            }
          },
          {
            "#name": "target",
            "Description": {
              "new": "The error target.",
              "old": "The target of the particular error. For example, the name of the property in error."
            }
          },
          {
            "#name": "details",
            "Description": {
              "new": "The error details.",
              "old": "A list of additional details about the error."
            }
          }
        ]
      }
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the VaultResource ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the private endpoint connection. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{
location:
{
Description: The Location header contains the URL where the status of the long running operation can be checked. ,
}
string ,
retry-after:
{
Description: The Retry-After header can indicate how long the client should wait before polling the operation status. ,
}
integer ,
}

⚐ 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 ,
}
,
]
,
}
,
}
PrivateEndpoint_GetOperationStatus (updated)
Description :  Gets the operation status for a private endpoint connection.
Reference :  Link ¶

⚶ Changes

{
  "#id": "PrivateEndpoint_GetOperationStatus",
  "$parameters": [
    {
      "#name": "api-version",
      "Description": {
        "new": "The API version to use for this operation.",
        "old": "Client Api Version."
      }
    },
    {
      "#name": "subscriptionId",
      "Description": {
        "new": "The ID of the target subscription.",
        "old": "The subscription Id."
      }
    },
    {
      "#name": "resourceGroupName",
      "Description": {
        "new": "The name of the resource group. The name is case insensitive.",
        "old": "The name of the resource group where the recovery services vault is present."
      }
    },
    {
      "#name": "vaultName",
      "Description": {
        "new": "vaults",
        "old": "The name of the recovery services vault."
      }
    },
    {
      "#name": "privateEndpointConnectionName",
      "Description": {
        "new": "The name of the PrivateEndpointConnectionResource",
        "old": "The name of the private endpoint connection."
      }
    },
    {
      "#name": "operationId",
      "Description": {
        "new": "The name of the PrivateEndpointConnectionResource",
        "old": "Operation id"
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "The resource management error response."
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/privateEndpointConnections/{privateEndpointConnectionName}/operationsStatus/{operationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
vaultName:
{
Description: vaults ,
Required: True ,
}
string ,
privateEndpointConnectionName:
{
Description: The name of the PrivateEndpointConnectionResource ,
Required: True ,
}
string ,
operationId:
{
Description: The name of the PrivateEndpointConnectionResource ,
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 ,
}
,
]
,
}
,
}