Microsoft.RecoveryServices (stable:2016-12-01)

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

BackupEngines_List (new)
Description :  Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: BackupEngineBaseResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the backup engine. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backup engine. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: Registration status of the backup engine with the Recovery Services Vault. ,
Required: False ,
}
string ,
backupEngineState:
{
Description: Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed} ,
Required: False ,
}
string ,
healthStatus:
{
Description: Backup status of the backup engine. ,
Required: False ,
}
string ,
backupEngineType:
{
Description: Type of the backup engine. ,
Enum:
{
Invalid: No description available. ,
DpmBackupEngine: No description available. ,
AzureBackupServerEngine: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
,
}
,
]
,
}
BackupEngines_Get (new)
Description :  Returns backup management server registered to Recovery Services Vault.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: BackupEngineBaseResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the backup engine. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backup engine. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: Registration status of the backup engine with the Recovery Services Vault. ,
Required: False ,
}
string ,
backupEngineState:
{
Description: Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed} ,
Required: False ,
}
string ,
healthStatus:
{
Description: Backup status of the backup engine. ,
Required: False ,
}
string ,
backupEngineType:
{
Description: Type of the backup engine. ,
Enum:
{
Invalid: No description available. ,
DpmBackupEngine: No description available. ,
AzureBackupServerEngine: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
,
}
ProtectionContainerRefreshOperationResults_Get (new)
Description :  Provides the result of the refresh operation triggered by the BeginRefresh operation.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/operationResults/{operationId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the container. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation ID associated with the operation whose result needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ProtectableContainers_List (new)
Description :  Lists the containers that can be registered to Recovery Services Vault.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ProtectableContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
protectableContainerType:
{
Description: Type of the container. The value of this property for 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
,
]
,
}
ProtectionContainers_Get (new)
Description :  Gets details of the specific container registered to your Recovery Services Vault.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Name of the fabric where the container belongs. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

PUT:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the container. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container to be registered. ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
properties:
{
Description: ProtectionContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: Status of registration of the container with the Recovery Services Vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerType:
{
Description: Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}
ProtectionContainers_Unregister (new)
Description :  Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine whether the backend service has finished processing the request, call Get Container Operation Result API.
Reference :  Link ¶

⚼ Request

DELETE:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Name of the fabric where the container belongs. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container which needs to be unregistered from the Recovery Services Vault. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ProtectionContainers_Inquire (new)
Description :  This is an async operation and the results should be tracked using location header or Azure-async-url.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/inquire
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric Name associated with the container. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container in which inquiry needs to be triggered. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
BackupWorkloadItems_List (new)
Description :  Provides a pageable list of workload item of a specific container according to the query filter and the pagination parameters.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: WorkloadItemResource properties ,
Required: False ,
}
{
backupManagementType:
{
Description: Type of backup management to backup an item. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of workload for the backup management ,
Required: False ,
}
string ,
workloadItemType:
{
Description: Type of the backup item. ,
Required: False ,
}
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 ,
}
,
}
,
]
,
}
ProtectionContainerOperationResults_Get (new)
Description :  Fetches the result of any operation on the container.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/operationResults/{operationId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the container. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name whose information should be fetched. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation ID which represents the operation whose result needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{}

⚐ Response (204)

{}
Backups_Trigger (new)
Description :  Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the operation, call GetProtectedItemOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/backup
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backup item for which backup needs to be triggered. ,
Required: True ,
}
string ,
parameters:
{
Description: resource backup request ,
Required: True ,
}
{
properties:
{
Description: BackupRequestResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ProtectedItemOperationStatuses_Get (new)
Description :  Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations create jobs. This method returns the list of jobs associated with the operation.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationsStatus/{operationId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backup item name whose details are to be fetched. ,
Required: True ,
}
string ,
operationId:
{
Description: OperationID represents the operation whose status needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ID of the operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Operation start time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: Error code of the operation failure. ,
Required: False ,
}
string ,
message:
{
Description: Error message displayed if the operation failure. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
ItemLevelRecoveryConnections_Provision (new)
Description :  Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file explorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of provisioning, call GetProtectedItemOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/provisionInstantItemRecovery
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the backed up items. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name associated with the backed up items. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose files/folders are to be restored. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: Recovery point ID which represents backed up data. iSCSI connection will be provisioned for this backed up data. ,
Required: True ,
}
string ,
parameters:
{
Description: resource ILR request ,
Required: True ,
}
{
properties:
{
Description: ILRRequestResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ItemLevelRecoveryConnections_Revoke (new)
Description :  Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer displaying all recoverable files and folders. This is an asynchronous operation.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/revokeInstantItemRecovery
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the backed up items. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name associated with the backed up items. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose files/folders are to be restored. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: Recovery point ID which represents backed up data. iSCSI connection will be revoked for this backed up data. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}
ProtectionContainers_Refresh (new)
Description :  Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an asynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{}
BackupOperationResults_Get (new)
Description :  Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the status code in the response would be Accepted. It will continue to be in this state till it reaches completion. On successful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is part of the Location header of the operation response.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
BackupOperationStatuses_Get (new)
Description :  Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs when the operation is complete.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: ID of the operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Operation start time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: Error code of the operation failure. ,
Required: False ,
}
string ,
message:
{
Description: Error message displayed if the operation failure. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
ProtectionPolicies_Delete (new)
Description :  Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.
Reference :  Link ¶

⚼ Request

DELETE:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
policyName:
{
Description: Backup policy to be deleted. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
ProtectionPolicyOperationStatuses_Get (new)
Description :  Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed or failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs associated with operation.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}/operations/{operationId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
policyName:
{
Description: Backup policy name whose operation's status needs to be fetched. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation ID which represents an operation whose status needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ID of the operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Operation start time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: Error code of the operation failure. ,
Required: False ,
}
string ,
message:
{
Description: Error message displayed if the operation failure. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
BackupProtectableItems_List (new)
Description :  Provides a pageable list of protectable objects within your subscription according to the query filter and the pagination parameters.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: WorkloadProtectableItemResource properties ,
Required: False ,
}
{
backupManagementType:
{
Description: Type of backup management to backup an item. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of workload for the backup management ,
Required: False ,
}
string ,
protectableItemType:
{
Description: Type of the backup item. ,
Required: False ,
}
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 ,
}
,
}
,
]
,
}
BackupProtectionContainers_List (new)
Description :  Lists the containers registered to Recovery Services Vault.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ProtectionContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: Status of registration of the container with the Recovery Services Vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerType:
{
Description: Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
SecurityPINs_Get (new)
Description :  Get the security PIN.
Reference :  Link ¶

⚼ Request

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

⚐ 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 ,
}
BackupResourceStorageConfigs_Get (new)
Description :  Fetches resource storage config.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: BackupResourceConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
BackupResourceStorageConfigs_Update (new)
Description :  Updates vault storage model type.
Reference :  Link ¶

⚼ Request

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

⚐ 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. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
BackupResourceStorageConfigs_Patch (new)
Description :  Updates vault storage model type.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}
BackupEngines_List (removed)
Description :  Backup management servers registered to Recovery Services Vault. Returns a pageable list of servers.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: BackupEngineBaseResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the backup engine. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backup engine. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: Registration status of the backup engine with the Recovery Services Vault. ,
Required: False ,
}
string ,
backupEngineState:
{
Description: Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed} ,
Required: False ,
}
string ,
healthStatus:
{
Description: Backup status of the backup engine. ,
Required: False ,
}
string ,
backupEngineType:
{
Description: Type of the backup engine. ,
Enum:
{
Invalid: No description available. ,
DpmBackupEngine: No description available. ,
AzureBackupServerEngine: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
,
}
,
]
,
}
BackupEngines_Get (removed)
Description :  Returns backup management server registered to Recovery Services Vault.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: BackupEngineBaseResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the backup engine. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the backup engine. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: Registration status of the backup engine with the Recovery Services Vault. ,
Required: False ,
}
string ,
backupEngineState:
{
Description: Status of the backup engine with the Recovery Services Vault. = {Active/Deleting/DeleteFailed} ,
Required: False ,
}
string ,
healthStatus:
{
Description: Backup status of the backup engine. ,
Required: False ,
}
string ,
backupEngineType:
{
Description: Type of the backup engine. ,
Enum:
{
Invalid: No description available. ,
DpmBackupEngine: No description available. ,
AzureBackupServerEngine: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
,
}
ProtectionContainerRefreshOperationResults_Get (removed)
Description :  Provides the result of the refresh operation triggered by the BeginRefresh operation.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/operationResults/{operationId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the container. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation ID associated with the operation whose result needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ProtectableContainers_List (removed)
Description :  Lists the containers that can be registered to Recovery Services Vault.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ProtectableContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
protectableContainerType:
{
Description: Type of the container. The value of this property for 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
}
,
Required: False ,
}
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 ,
}
,
}
,
]
,
}
ProtectionContainers_Get (removed)
Description :  Gets details of the specific container registered to your Recovery Services Vault.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Name of the fabric where the container belongs. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container whose details need to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚼ Request

PUT:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the container. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container to be registered. ,
Required: True ,
}
string ,
parameters:
{
Description: Request body for operation ,
Required: True ,
}
{
properties:
{
Description: ProtectionContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: Status of registration of the container with the Recovery Services Vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerType:
{
Description: Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ 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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (202)

{}
ProtectionContainers_Unregister (removed)
Description :  Unregisters the given container from your Recovery Services Vault. This is an asynchronous operation. To determine whether the backend service has finished processing the request, call Get Container Operation Result API.
Reference :  Link ¶

⚼ Request

DELETE:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Name of the fabric where the container belongs. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container which needs to be unregistered from the Recovery Services Vault. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ProtectionContainers_Inquire (removed)
Description :  This is an async operation and the results should be tracked using location header or Azure-async-url.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/inquire
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric Name associated with the container. ,
Required: True ,
}
string ,
containerName:
{
Description: Name of the container in which inquiry needs to be triggered. ,
Required: True ,
}
string ,
$filter:
{
Description: OData filter options. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
BackupWorkloadItems_List (removed)
Description :  Provides a pageable list of workload item of a specific container according to the query filter and the pagination parameters.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: WorkloadItemResource properties ,
Required: False ,
}
{
backupManagementType:
{
Description: Type of backup management to backup an item. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of workload for the backup management ,
Required: False ,
}
string ,
workloadItemType:
{
Description: Type of the backup item. ,
Required: False ,
}
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 ,
}
,
}
,
]
,
}
ProtectionContainerOperationResults_Get (removed)
Description :  Fetches the result of any operation on the container.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/operationResults/{operationId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the container. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name whose information should be fetched. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation ID which represents the operation whose result needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

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

⚐ Response (202)

{}

⚐ Response (204)

{}
Backups_Trigger (removed)
Description :  Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the operation, call GetProtectedItemOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/backup
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backup item for which backup needs to be triggered. ,
Required: True ,
}
string ,
parameters:
{
Description: resource backup request ,
Required: True ,
}
{
properties:
{
Description: BackupRequestResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ProtectedItemOperationStatuses_Get (removed)
Description :  Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of the operation. Some operations create jobs. This method returns the list of jobs associated with the operation.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationsStatus/{operationId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backup item name whose details are to be fetched. ,
Required: True ,
}
string ,
operationId:
{
Description: OperationID represents the operation whose status needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ID of the operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Operation start time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: Error code of the operation failure. ,
Required: False ,
}
string ,
message:
{
Description: Error message displayed if the operation failure. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
ItemLevelRecoveryConnections_Provision (removed)
Description :  Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file explorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of provisioning, call GetProtectedItemOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/provisionInstantItemRecovery
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the backed up items. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name associated with the backed up items. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose files/folders are to be restored. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: Recovery point ID which represents backed up data. iSCSI connection will be provisioned for this backed up data. ,
Required: True ,
}
string ,
parameters:
{
Description: resource ILR request ,
Required: True ,
}
{
properties:
{
Description: ILRRequestResource properties ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ItemLevelRecoveryConnections_Revoke (removed)
Description :  Revokes an iSCSI connection which can be used to download a script. Executing this script opens a file explorer displaying all recoverable files and folders. This is an asynchronous operation.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/revokeInstantItemRecovery
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
fabricName:
{
Description: Fabric name associated with the backed up items. ,
Required: True ,
}
string ,
containerName:
{
Description: Container name associated with the backed up items. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: Backed up item name whose files/folders are to be restored. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: Recovery point ID which represents backed up data. iSCSI connection will be revoked for this backed up data. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}
ProtectionContainers_Refresh (removed)
Description :  Discovers all the containers in the subscription that can be backed up to Recovery Services Vault. This is an asynchronous operation. To know the status of the operation, call GetRefreshOperationResult API.
Reference :  Link ¶

⚼ Request

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

⚐ Response (202)

{}
BackupOperationResults_Get (removed)
Description :  Provides the status of the delete operations such as deleting backed up item. Once the operation has started, the status code in the response would be Accepted. It will continue to be in this state till it reaches completion. On successful completion, the status code will be OK. This method expects OperationID as an argument. OperationID is part of the Location header of the operation response.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
BackupOperationStatuses_Get (removed)
Description :  Fetches the status of an operation such as triggering a backup, restore. The status can be in progress, completed or failed. You can refer to the OperationStatus enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs when the operation is complete.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
id:
{
Description: ID of the operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Operation start time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: Error code of the operation failure. ,
Required: False ,
}
string ,
message:
{
Description: Error message displayed if the operation failure. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
ProtectionPolicies_Delete (removed)
Description :  Deletes specified backup policy from your Recovery Services Vault. This is an asynchronous operation. Status of the operation can be fetched using GetPolicyOperationResult API.
Reference :  Link ¶

⚼ Request

DELETE:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
policyName:
{
Description: Backup policy to be deleted. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
ProtectionPolicyOperationStatuses_Get (removed)
Description :  Provides the status of the asynchronous operations like backup, restore. The status can be in progress, completed or failed. You can refer to the Operation Status enum for all the possible states of an operation. Some operations create jobs. This method returns the list of jobs associated with operation.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}/operations/{operationId}
{
api-version:
{
Description: Client Api Version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the recovery services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group where the recovery services vault is present. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription Id. ,
Required: True ,
}
string ,
policyName:
{
Description: Backup policy name whose operation's status needs to be fetched. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation ID which represents an operation whose status needs to be fetched. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: ID of the operation. ,
Required: False ,
}
string ,
name:
{
Description: Name of the operation. ,
Required: False ,
}
string ,
status:
{
Description: Operation status. ,
Enum:
{
Invalid: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
Canceled: No description available. ,
}
,
Required: False ,
}
enum ,
startTime:
{
Description: Operation start time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: Operation end time. Format: ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: Error code of the operation failure. ,
Required: False ,
}
string ,
message:
{
Description: Error message displayed if the operation failure. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: True ,
}
string ,
}
,
}
BackupProtectableItems_List (removed)
Description :  Provides a pageable list of protectable objects within your subscription according to the query filter and the pagination parameters.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: WorkloadProtectableItemResource properties ,
Required: False ,
}
{
backupManagementType:
{
Description: Type of backup management to backup an item. ,
Required: False ,
}
string ,
workloadType:
{
Description: Type of workload for the backup management ,
Required: False ,
}
string ,
protectableItemType:
{
Description: Type of the backup item. ,
Required: False ,
}
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 ,
}
,
}
,
]
,
}
BackupProtectionContainers_List (removed)
Description :  Lists the containers registered to Recovery Services Vault.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: ProtectionContainerResource properties ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: Type of backup management for the container. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
AzureStorage: No description available. ,
AzureWorkload: No description available. ,
DefaultBackup: No description available. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: Status of registration of the container with the Recovery Services Vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: Status of health of the container. ,
Required: False ,
}
string ,
containerType:
{
Description: Type of the container. The value of this property for: 1. Compute Azure VM is Microsoft.Compute/virtualMachines 2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines 3. Windows machines (like MAB, DPM etc) is Windows 4. Azure SQL instance is AzureSqlContainer. 5. Storage containers is StorageContainer. 6. Azure workload Backup is VMAppContainer ,
Enum:
{
Invalid: No description available. ,
Unknown: No description available. ,
IaasVMContainer: No description available. ,
IaasVMServiceContainer: No description available. ,
DPMContainer: No description available. ,
AzureBackupServerContainer: No description available. ,
MABContainer: No description available. ,
Cluster: No description available. ,
AzureSqlContainer: No description available. ,
Windows: No description available. ,
VCenter: No description available. ,
VMAppContainer: No description available. ,
SQLAGWorkLoadContainer: No description available. ,
StorageContainer: No description available. ,
GenericContainer: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
SecurityPINs_Get (removed)
Description :  Get the security PIN.
Reference :  Link ¶

⚼ Request

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

⚐ 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 ,
}
BackupResourceStorageConfigs_Get (removed)
Description :  Fetches resource storage config.
Reference :  Link ¶

⚼ Request

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

⚐ Response (200)

{
properties:
{
Description: BackupResourceConfigResource properties ,
Required: False ,
}
{
storageModelType:
{
Description: Storage type ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
BackupResourceStorageConfigs_Update (removed)
Description :  Updates vault storage model type.
Reference :  Link ¶

⚼ Request

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

⚐ 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. ,
}
,
Required: False ,
}
enum ,
storageType:
{
Description: Storage type. ,
Enum:
{
Invalid: No description available. ,
GeoRedundant: No description available. ,
LocallyRedundant: No description available. ,
}
,
Required: False ,
}
enum ,
storageTypeState:
{
Description: Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. ,
Enum:
{
Invalid: No description available. ,
Locked: No description available. ,
Unlocked: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
BackupResourceStorageConfigs_Patch (removed)
Description :  Updates vault storage model type.
Reference :  Link ¶

⚼ Request

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

⚐ Response (204)

{}