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

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

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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup items. The value allowed is Azure. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup items. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of the backup items whose files or folders will be restored. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: The string that identifies the recovery point. The iSCSI connection will be revoked for this protected data. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}
ItemLevelRecoveryConnections_Provision (new)
Description :  Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens File Explorer which displays the recoverable files and folders. This is an asynchronous operation. To get the provisioning status, 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup items. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup items. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of the backup item whose files or folders are to be restored. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: The recovery point ID for backup data. The iSCSI connection will be provisioned for this backup data. ,
Required: True ,
}
string ,
resourceILRRequest:
{
Description: The resource Item Level Recovery (ILR) request. ,
Required: True ,
}
{
properties:
{
Description: Parameters to restore file or folders API. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
Restores_Trigger (new)
Description :  Restores the specified backup data. This is an asynchronous operation. To know the status of this API call, use GetProtectedItemOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/restore
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup items. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup items. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The backup item to be restored. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: The recovery point ID for the backup data to be restored. ,
Required: True ,
}
string ,
resourceRestoreRequest:
{
Description: The resource restore request. ,
Required: True ,
}
{
properties:
{
Description: The base class for restore requests. Workload-specific restore requests are derived from this class. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ProtectionPolicyOperationStatuses_Get (new)
Description :  Provides the status of the asynchronous operations like backup or restore. The status can be: in progress, completed, or failed. You can refer to the Operation Status enumeration for the possible states of an 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}/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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
policyName:
{
Description: The backup policy name used in this GET operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID associated with this GET 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: The operation start time. The format of the time is ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The operation end time. The format of the time is ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: The error code for the failed operation. ,
Required: False ,
}
string ,
message:
{
Description: The error message for the failed operation. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding between types, in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
ProtectionPolicyOperationResults_Get (new)
Description :  Provides the result of an operation.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}/operationResults/{operationId}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
policyName:
{
Description: The backup policy name used in this GET operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID associated with this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for a backup policy. Workload-specific backup policies are derived from this class. ,
Required: False ,
}
{
protectedItemsCount:
{
Description: The number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
ProtectionPolicies_Get (new)
Description :  Gets the details of the backup policy associated with the Recovery Services vault. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
policyName:
{
Description: The backup policy name used in this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for a backup policy. Workload-specific backup policies are derived from this class. ,
Required: False ,
}
{
protectedItemsCount:
{
Description: The number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
ProtectionPolicies_CreateOrUpdate (new)
Description :  Creates or modifies a backup policy. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.
Reference :  Link ¶

⚼ Request

PUT:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
policyName:
{
Description: The backup policy to be created. ,
Required: True ,
}
string ,
resourceProtectionPolicy:
{
Description: The resource backup policy. ,
Required: True ,
}
{
properties:
{
Description: The base class for a backup policy. Workload-specific backup policies are derived from this class. ,
Required: False ,
}
{
protectedItemsCount:
{
Description: The number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The base class for a backup policy. Workload-specific backup policies are derived from this class. ,
Required: False ,
}
{
protectedItemsCount:
{
Description: The number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ProtectionPolicies_Delete (new)
Description :  Deletes the specified backup policy from your Recovery Services vault. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.
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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the backup policy to be deleted. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
ProtectionPolicies_List (new)
Description :  Lists the backup policies associated with the Recovery Services vault. The API provides parameters to Get scoped results.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: The following equation can be used to filter the list of backup policies. backupManagementType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql}. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The base class for a backup policy. Workload-specific backup policies are derived from this class. ,
Required: False ,
}
{
protectedItemsCount:
{
Description: The number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ProtectionContainerOperationResults_Get (new)
Description :  Gets 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the container. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name used for this GET operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The operation ID used for this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for a container with backup items. Containers with specific workloads are derived from this class. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type 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. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: The container's registration status with the Recovery Services vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: The status of the container's health. ,
Required: False ,
}
string ,
containerType:
{
Description: The type assigned to the container. The values to use for each of these properties are:
1. Compute Azure VM is Microsoft.Compute/virtualMachines
2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines
3. Windows machines (like Azure Backup Server and DPM) is Windows
4. Azure SQL instance is AzureSqlContainer. ,
Required: False ,
}
string ,
protectableObjectType:
{
Description: The protectable object type associated with the container. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the container. ,
Required: True ,
}
string ,
operationId:
{
Description: The operation ID used for this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the container. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name used for this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for a container with backup items. Containers with specific workloads are derived from this class. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type 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. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: The container's registration status with the Recovery Services vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: The status of the container's health. ,
Required: False ,
}
string ,
containerType:
{
Description: The type assigned to the container. The values to use for each of these properties are:
1. Compute Azure VM is Microsoft.Compute/virtualMachines
2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines
3. Windows machines (like Azure Backup Server and DPM) is Windows
4. Azure SQL instance is AzureSqlContainer. ,
Required: False ,
}
string ,
protectableObjectType:
{
Description: The protectable object type associated with the container. ,
Required: False ,
}
string ,
}
,
}
ProtectionContainers_List (new)
Description :  Lists the containers registered to the 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: The following equation is used to sort or filter the containers registered to the vault. providerType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql} and status eq {Unknown, NotRegistered, Registered, Registering} and friendlyName eq {containername} and backupManagementType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql}. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The base class for a container with backup items. Containers with specific workloads are derived from this class. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type 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. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: The container's registration status with the Recovery Services vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: The status of the container's health. ,
Required: False ,
}
string ,
containerType:
{
Description: The type assigned to the container. The values to use for each of these properties are:
1. Compute Azure VM is Microsoft.Compute/virtualMachines
2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines
3. Windows machines (like Azure Backup Server and DPM) is Windows
4. Azure SQL instance is AzureSqlContainer. ,
Required: False ,
}
string ,
protectableObjectType:
{
Description: The protectable object type associated with the container. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ProtectionContainers_Refresh (new)
Description :  Discovers the containers in the subscription that can be protected in a Recovery Services vault. This is an asynchronous operation. To learn the status of the operation, use the 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the container. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}
RecoveryPoints_Get (new)
Description :  Provides the backup data for the RecoveryPointID. This is an asynchronous operation. To learn the status of the operation, call the GetProtectedItemOperationResult API.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of the backup item used in this GET operation. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: The RecoveryPointID associated with this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for backup copies. Workload-specific backup copies are derived from this class. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
RecoveryPoints_List (new)
Description :  Lists the recovery points, or backup copies, for the specified backup item.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of backup item used in this GET operation. ,
Required: True ,
}
string ,
$filter:
{
Description: startDate eq {yyyy-mm-dd hh:mm:ss PM} and endDate { yyyy-mm-dd hh:mm:ss PM}. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The base class for backup copies. Workload-specific backup copies are derived from this class. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Backups_Trigger (new)
Description :  Triggers the backup job for the specified backup 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of backup item used in this POST operation. ,
Required: True ,
}
string ,
resourceBackupRequest:
{
Description: The resource backup request. ,
Required: True ,
}
{
properties:
{
Description: The base class for a backup request. Workload-specific backup requests are derived from this class. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ProtectedItemOperationStatuses_Get (new)
Description :  Gets the status of an operation such as triggering a backup or 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of backup item used in this GET operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The OperationID used in this GET 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: The operation start time. The format of the time is ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The operation end time. The format of the time is ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: The error code for the failed operation. ,
Required: False ,
}
string ,
message:
{
Description: The error message for the failed operation. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding between types, in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
ProtectedItemOperationResults_Get (new)
Description :  Gets the result of any operation on the backup item.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationResults/{operationId}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of backup item used in this GET operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The OperationID used in this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for backup items. ,
Required: False ,
}
{
protectedItemType:
{
Description: The backup item type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type associated with the backup item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: The workload type for this item. ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
DPMUnknown: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: The ID of the backup policy associated with this backup item. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: The timestamp when the most recent backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ProtectedItems_List (new)
Description :  Provides a pageable list of all items in a subscription, that can be protected.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectedItems
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: itemType eq { VM , FileFolder , AzureSqlDb , SQLDB , Exchange , Sharepoint , DPMUnknown } and providerType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql } and policyName eq {policyName} and containerName eq {containername} and backupManagementType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql }. ,
Required: False ,
}
string ,
$skipToken:
{
Description: The Skip Token filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The base class for backup items. ,
Required: False ,
}
{
protectedItemType:
{
Description: The backup item type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type associated with the backup item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: The workload type for this item. ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
DPMUnknown: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: The ID of the backup policy associated with this backup item. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: The timestamp when the most recent backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ProtectedItems_Get (new)
Description :  Provides the details of the backup item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The backup item name used in this GET operation. ,
Required: True ,
}
string ,
$filter:
{
Description: expand eq {extendedInfo}. This filter enables you to choose (or filter) specific items in the list of backup items. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for backup items. ,
Required: False ,
}
{
protectedItemType:
{
Description: The backup item type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type associated with the backup item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: The workload type for this item. ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
DPMUnknown: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: The ID of the backup policy associated with this backup item. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: The timestamp when the most recent backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
ProtectedItems_CreateOrUpdate (new)
Description :  This operation enables an item to be backed up, or modifies the existing backup policy information for an item that has been backed up. This is an asynchronous operation. To learn the status of the operation, call the GetItemOperationResult API.
Reference :  Link ¶

⚼ Request

PUT:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of the backup item. ,
Required: True ,
}
string ,
resourceProtectedItem:
{
Description: The resource backup item. ,
Required: True ,
}
{
properties:
{
Description: The base class for backup items. ,
Required: False ,
}
{
protectedItemType:
{
Description: The backup item type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type associated with the backup item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: The workload type for this item. ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
DPMUnknown: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: The ID of the backup policy associated with this backup item. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: The timestamp when the most recent backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ProtectedItems_Delete (new)
Description :  Used to disable the backup job for an item within a container. This is an asynchronous operation. To learn the status of the request, call the GetItemOperationResult API.
Reference :  Link ¶

⚼ Request

DELETE:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The backup item to be deleted. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ProtectableItems_List (new)
Description :  Based on the query filter and the pagination parameters, this operation provides a pageable list of objects within the subscription that can be protected.
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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: Using the following query filters, you can sort a specific backup item based on: type of backup item, status, name of the item, and more. providerType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql } and status eq { NotProtected , Protecting , Protected } and friendlyName {name} and skipToken eq {string which provides the next set of list} and topToken eq {int} and backupManagementType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql }. ,
Required: False ,
}
string ,
$skipToken:
{
Description: The Skip Token filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The base class for backup item. Workload-specific backup items are derived from this class. ,
Required: False ,
}
{
backupManagementType:
{
Description: The backup management type. ,
Required: False ,
}
string ,
protectableItemType:
{
Description: The type of the backup item. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of the backup item. ,
Required: False ,
}
string ,
protectionState:
{
Description: The state of the back up item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
ExportJobsOperationResults_Get (new)
Description :  Gets the result of the operation triggered by the ExportJob API.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/operationResults/{operationId}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID associated with the export job. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for operation result information. ,
Required: False ,
}
{
objectType:
{
Description: This property is the discriminator for deciding between the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
JobOperationResults_Get (new)
Description :  Gets the result of the operation.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/operationResults/{operationId}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
jobName:
{
Description: Job name associated with this GET operation. ,
Required: True ,
}
string ,
operationId:
{
Description: OperationID associated with this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Jobs_Export (new)
Description :  Exports all jobs for a given Shared Access Signatures (SAS) URL. The SAS URL expires within 15 minutes of its creation.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobsExport
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: The OData filter options. status eq { InProgress , Completed , Failed , CompletedWithWarnings , Cancelled , Cancelling } and backupManagementType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql } and operation eq { ConfigureBackup , Backup , Restore , DisableBackup , DeleteBackupData } and jobId eq {guid} and startTime eq { yyyy-mm-dd hh:mm:ss PM } and endTime eq { yyyy-mm-dd hh:mm:ss PM }. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
JobCancellations_Trigger (new)
Description :  Cancels the job. This is an asynchronous operation. To know the status of the cancellation, call the GetCancelOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/cancel
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
jobName:
{
Description: Name of the job to cancel. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}
JobDetails_Get (new)
Description :  Gets extended information associated with the job.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
jobName:
{
Description: Name of the job associated with this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Defines workload-agnostic properties for a job. ,
Required: False ,
}
{
entityFriendlyName:
{
Description: The friendly name of the entity on which the current job is executing. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type for the current job. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
}
,
Required: False ,
}
enum ,
operation:
{
Description: The operation name. ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
activityId:
{
Description: ActivityId of job. ,
Required: False ,
}
string ,
jobType:
{
Description: This property is the discriminator for deciding between the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
Jobs_List (new)
Description :  Provides a pageable list of jobs.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: The following equation can be used to filter the list of jobs based on status, type, start date, and end date. status eq { InProgress , Completed , Failed , CompletedWithWarnings , Cancelled , Cancelling } and backupManagementType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql } and operation eq { ConfigureBackup , Backup , Restore , DisableBackup , DeleteBackupData } and jobId eq {guid} and startTime eq { yyyy-mm-dd hh:mm:ss PM } and endTime eq { yyyy-mm-dd hh:mm:ss PM }. ,
Required: False ,
}
string ,
$skipToken:
{
Description: The Skip Token filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: Defines workload-agnostic properties for a job. ,
Required: False ,
}
{
entityFriendlyName:
{
Description: The friendly name of the entity on which the current job is executing. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type for the current job. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
}
,
Required: False ,
}
enum ,
operation:
{
Description: The operation name. ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
activityId:
{
Description: ActivityId of job. ,
Required: False ,
}
string ,
jobType:
{
Description: This property is the discriminator for deciding between the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
BackupOperationStatuses_Get (new)
Description :  Gets the status of an operation such as triggering a backup or 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of 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: The operation start time. The format of the time is ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The operation end time. The format of the time is ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: The error code for the failed operation. ,
Required: False ,
}
string ,
message:
{
Description: The error message for the failed operation. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding between types, in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
BackupOperationResults_Get (new)
Description :  Provides the status of the delete operations, for example, deleting a backup item. Once the operation starts, the response status code is Accepted. The response status code remains in this state until the operation reaches completion. On successful completion, the status code changes to 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
BackupEngines_Get (new)
Description :  The backup management servers registered to a Recovery Services vault. This 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: Use this filter to choose the specific backup management server. backupManagementType { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql }. ,
Required: False ,
}
string ,
$skipToken:
{
Description: The Skip Token filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The base backup engine class. All workload-specific backup engines derive from this class. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name of the backup engine. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The type of backup management associated with 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. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: The status of the backup engine registration with the Recovery Services vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: The backup status of the backup engine. ,
Required: False ,
}
string ,
backupEngineType:
{
Description: The type of the backup engine. ,
Required: False ,
}
string ,
canReRegister:
{
Description: The flag indicating whether the backup engine be registered again, once the engine has been initially registered. ,
Required: False ,
}
boolean ,
backupEngineId:
{
Description: The ID of the backup engine. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ProtectionContainers_Unregister (new)
Description :  Unregisters the given container from your Recovery Services vault.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/registeredIdentities/{identityName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
identityName:
{
Description: Name of the protection container to unregister. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}
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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup items. The value allowed is Azure. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup items. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of the backup items whose files or folders will be restored. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: The string that identifies the recovery point. The iSCSI connection will be revoked for this protected data. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}
ItemLevelRecoveryConnections_Provision (removed)
Description :  Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens File Explorer which displays the recoverable files and folders. This is an asynchronous operation. To get the provisioning status, 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup items. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup items. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of the backup item whose files or folders are to be restored. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: The recovery point ID for backup data. The iSCSI connection will be provisioned for this backup data. ,
Required: True ,
}
string ,
resourceILRRequest:
{
Description: The resource Item Level Recovery (ILR) request. ,
Required: True ,
}
{
properties:
{
Description: Parameters to restore file or folders API. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
Restores_Trigger (removed)
Description :  Restores the specified backup data. This is an asynchronous operation. To know the status of this API call, use GetProtectedItemOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/restore
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup items. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup items. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The backup item to be restored. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: The recovery point ID for the backup data to be restored. ,
Required: True ,
}
string ,
resourceRestoreRequest:
{
Description: The resource restore request. ,
Required: True ,
}
{
properties:
{
Description: The base class for restore requests. Workload-specific restore requests are derived from this class. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ProtectionPolicyOperationStatuses_Get (removed)
Description :  Provides the status of the asynchronous operations like backup or restore. The status can be: in progress, completed, or failed. You can refer to the Operation Status enumeration for the possible states of an 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}/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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
policyName:
{
Description: The backup policy name used in this GET operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID associated with this GET 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: The operation start time. The format of the time is ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The operation end time. The format of the time is ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: The error code for the failed operation. ,
Required: False ,
}
string ,
message:
{
Description: The error message for the failed operation. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding between types, in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
ProtectionPolicyOperationResults_Get (removed)
Description :  Provides the result of an operation.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}/operationResults/{operationId}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
policyName:
{
Description: The backup policy name used in this GET operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID associated with this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for a backup policy. Workload-specific backup policies are derived from this class. ,
Required: False ,
}
{
protectedItemsCount:
{
Description: The number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
ProtectionPolicies_Get (removed)
Description :  Gets the details of the backup policy associated with the Recovery Services vault. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
policyName:
{
Description: The backup policy name used in this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for a backup policy. Workload-specific backup policies are derived from this class. ,
Required: False ,
}
{
protectedItemsCount:
{
Description: The number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
ProtectionPolicies_CreateOrUpdate (removed)
Description :  Creates or modifies a backup policy. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.
Reference :  Link ¶

⚼ Request

PUT:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies/{policyName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
policyName:
{
Description: The backup policy to be created. ,
Required: True ,
}
string ,
resourceProtectionPolicy:
{
Description: The resource backup policy. ,
Required: True ,
}
{
properties:
{
Description: The base class for a backup policy. Workload-specific backup policies are derived from this class. ,
Required: False ,
}
{
protectedItemsCount:
{
Description: The number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: The base class for a backup policy. Workload-specific backup policies are derived from this class. ,
Required: False ,
}
{
protectedItemsCount:
{
Description: The number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
ProtectionPolicies_Delete (removed)
Description :  Deletes the specified backup policy from your Recovery Services vault. This is an asynchronous operation. Use the GetPolicyOperationResult API to Get the operation status.
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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
policyName:
{
Description: The name of the backup policy to be deleted. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}
ProtectionPolicies_List (removed)
Description :  Lists the backup policies associated with the Recovery Services vault. The API provides parameters to Get scoped results.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupPolicies
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: The following equation can be used to filter the list of backup policies. backupManagementType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql}. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The base class for a backup policy. Workload-specific backup policies are derived from this class. ,
Required: False ,
}
{
protectedItemsCount:
{
Description: The number of items associated with this policy. ,
Format: int32 ,
Required: False ,
}
integer ,
backupManagementType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ProtectionContainerOperationResults_Get (removed)
Description :  Gets 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the container. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name used for this GET operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The operation ID used for this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for a container with backup items. Containers with specific workloads are derived from this class. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type 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. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: The container's registration status with the Recovery Services vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: The status of the container's health. ,
Required: False ,
}
string ,
containerType:
{
Description: The type assigned to the container. The values to use for each of these properties are:
1. Compute Azure VM is Microsoft.Compute/virtualMachines
2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines
3. Windows machines (like Azure Backup Server and DPM) is Windows
4. Azure SQL instance is AzureSqlContainer. ,
Required: False ,
}
string ,
protectableObjectType:
{
Description: The protectable object type associated with the container. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the container. ,
Required: True ,
}
string ,
operationId:
{
Description: The operation ID used for this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the container. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name used for this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for a container with backup items. Containers with specific workloads are derived from this class. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type 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. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: The container's registration status with the Recovery Services vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: The status of the container's health. ,
Required: False ,
}
string ,
containerType:
{
Description: The type assigned to the container. The values to use for each of these properties are:
1. Compute Azure VM is Microsoft.Compute/virtualMachines
2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines
3. Windows machines (like Azure Backup Server and DPM) is Windows
4. Azure SQL instance is AzureSqlContainer. ,
Required: False ,
}
string ,
protectableObjectType:
{
Description: The protectable object type associated with the container. ,
Required: False ,
}
string ,
}
,
}
ProtectionContainers_List (removed)
Description :  Lists the containers registered to the 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: The following equation is used to sort or filter the containers registered to the vault. providerType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql} and status eq {Unknown, NotRegistered, Registered, Registering} and friendlyName eq {containername} and backupManagementType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql}. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The base class for a container with backup items. Containers with specific workloads are derived from this class. ,
Required: False ,
}
{
friendlyName:
{
Description: Friendly name of the container. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type 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. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: The container's registration status with the Recovery Services vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: The status of the container's health. ,
Required: False ,
}
string ,
containerType:
{
Description: The type assigned to the container. The values to use for each of these properties are:
1. Compute Azure VM is Microsoft.Compute/virtualMachines
2. Classic Compute Azure VM is Microsoft.ClassicCompute/virtualMachines
3. Windows machines (like Azure Backup Server and DPM) is Windows
4. Azure SQL instance is AzureSqlContainer. ,
Required: False ,
}
string ,
protectableObjectType:
{
Description: The protectable object type associated with the container. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ProtectionContainers_Refresh (removed)
Description :  Discovers the containers in the subscription that can be protected in a Recovery Services vault. This is an asynchronous operation. To learn the status of the operation, use the 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the container. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}
RecoveryPoints_Get (removed)
Description :  Provides the backup data for the RecoveryPointID. This is an asynchronous operation. To learn the status of the operation, call the GetProtectedItemOperationResult API.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of the backup item used in this GET operation. ,
Required: True ,
}
string ,
recoveryPointId:
{
Description: The RecoveryPointID associated with this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for backup copies. Workload-specific backup copies are derived from this class. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
RecoveryPoints_List (removed)
Description :  Lists the recovery points, or backup copies, for the specified backup item.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of backup item used in this GET operation. ,
Required: True ,
}
string ,
$filter:
{
Description: startDate eq {yyyy-mm-dd hh:mm:ss PM} and endDate { yyyy-mm-dd hh:mm:ss PM}. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The base class for backup copies. Workload-specific backup copies are derived from this class. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
Backups_Trigger (removed)
Description :  Triggers the backup job for the specified backup 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of backup item used in this POST operation. ,
Required: True ,
}
string ,
resourceBackupRequest:
{
Description: The resource backup request. ,
Required: True ,
}
{
properties:
{
Description: The base class for a backup request. Workload-specific backup requests are derived from this class. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ProtectedItemOperationStatuses_Get (removed)
Description :  Gets the status of an operation such as triggering a backup or 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of backup item used in this GET operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The OperationID used in this GET 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: The operation start time. The format of the time is ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The operation end time. The format of the time is ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: The error code for the failed operation. ,
Required: False ,
}
string ,
message:
{
Description: The error message for the failed operation. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding between types, in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
ProtectedItemOperationResults_Get (removed)
Description :  Gets the result of any operation on the backup item.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/operationResults/{operationId}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of backup item used in this GET operation. ,
Required: True ,
}
string ,
operationId:
{
Description: The OperationID used in this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for backup items. ,
Required: False ,
}
{
protectedItemType:
{
Description: The backup item type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type associated with the backup item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: The workload type for this item. ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
DPMUnknown: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: The ID of the backup policy associated with this backup item. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: The timestamp when the most recent backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ProtectedItems_List (removed)
Description :  Provides a pageable list of all items in a subscription, that can be protected.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupProtectedItems
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: itemType eq { VM , FileFolder , AzureSqlDb , SQLDB , Exchange , Sharepoint , DPMUnknown } and providerType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql } and policyName eq {policyName} and containerName eq {containername} and backupManagementType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql }. ,
Required: False ,
}
string ,
$skipToken:
{
Description: The Skip Token filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The list of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The base class for backup items. ,
Required: False ,
}
{
protectedItemType:
{
Description: The backup item type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type associated with the backup item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: The workload type for this item. ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
DPMUnknown: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: The ID of the backup policy associated with this backup item. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: The timestamp when the most recent backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ProtectedItems_Get (removed)
Description :  Provides the details of the backup item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The backup item name used in this GET operation. ,
Required: True ,
}
string ,
$filter:
{
Description: expand eq {extendedInfo}. This filter enables you to choose (or filter) specific items in the list of backup items. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for backup items. ,
Required: False ,
}
{
protectedItemType:
{
Description: The backup item type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type associated with the backup item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: The workload type for this item. ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
DPMUnknown: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: The ID of the backup policy associated with this backup item. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: The timestamp when the most recent backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
ProtectedItems_CreateOrUpdate (removed)
Description :  This operation enables an item to be backed up, or modifies the existing backup policy information for an item that has been backed up. This is an asynchronous operation. To learn the status of the operation, call the GetItemOperationResult API.
Reference :  Link ¶

⚼ Request

PUT:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The name of the backup item. ,
Required: True ,
}
string ,
resourceProtectedItem:
{
Description: The resource backup item. ,
Required: True ,
}
{
properties:
{
Description: The base class for backup items. ,
Required: False ,
}
{
protectedItemType:
{
Description: The backup item type. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type associated with the backup item. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
}
,
Required: False ,
}
enum ,
workloadType:
{
Description: The workload type for this item. ,
Enum:
{
Invalid: No description available. ,
VM: No description available. ,
FileFolder: No description available. ,
AzureSqlDb: No description available. ,
SQLDB: No description available. ,
Exchange: No description available. ,
Sharepoint: No description available. ,
DPMUnknown: No description available. ,
}
,
Required: False ,
}
enum ,
sourceResourceId:
{
Description: The ID of the resource to be backed up. ,
Required: False ,
}
string ,
policyId:
{
Description: The ID of the backup policy associated with this backup item. ,
Required: False ,
}
string ,
lastRecoveryPoint:
{
Description: The timestamp when the most recent backup copy was created for this backup item. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (202)

{}
ProtectedItems_Delete (removed)
Description :  Used to disable the backup job for an item within a container. This is an asynchronous operation. To learn the status of the request, call the GetItemOperationResult API.
Reference :  Link ¶

⚼ Request

DELETE:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
fabricName:
{
Description: The fabric name associated with the backup item. ,
Required: True ,
}
string ,
containerName:
{
Description: The container name associated with the backup item. ,
Required: True ,
}
string ,
protectedItemName:
{
Description: The backup item to be deleted. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (204)

{}
ProtectableItems_List (removed)
Description :  Based on the query filter and the pagination parameters, this operation provides a pageable list of objects within the subscription that can be protected.
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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: Using the following query filters, you can sort a specific backup item based on: type of backup item, status, name of the item, and more. providerType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql } and status eq { NotProtected , Protecting , Protected } and friendlyName {name} and skipToken eq {string which provides the next set of list} and topToken eq {int} and backupManagementType eq { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql }. ,
Required: False ,
}
string ,
$skipToken:
{
Description: The Skip Token filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The base class for backup item. Workload-specific backup items are derived from this class. ,
Required: False ,
}
{
backupManagementType:
{
Description: The backup management type. ,
Required: False ,
}
string ,
protectableItemType:
{
Description: The type of the backup item. ,
Required: False ,
}
string ,
friendlyName:
{
Description: The friendly name of the backup item. ,
Required: False ,
}
string ,
protectionState:
{
Description: The state of the back up item. ,
Enum:
{
Invalid: No description available. ,
NotProtected: No description available. ,
Protecting: No description available. ,
Protected: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}
ExportJobsOperationResults_Get (removed)
Description :  Gets the result of the operation triggered by the ExportJob API.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/operationResults/{operationId}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID associated with the export job. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: The base class for operation result information. ,
Required: False ,
}
{
objectType:
{
Description: This property is the discriminator for deciding between the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (202)

{}
JobOperationResults_Get (removed)
Description :  Gets the result of the operation.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/operationResults/{operationId}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
jobName:
{
Description: Job name associated with this GET operation. ,
Required: True ,
}
string ,
operationId:
{
Description: OperationID associated with this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
Jobs_Export (removed)
Description :  Exports all jobs for a given Shared Access Signatures (SAS) URL. The SAS URL expires within 15 minutes of its creation.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobsExport
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: The OData filter options. status eq { InProgress , Completed , Failed , CompletedWithWarnings , Cancelled , Cancelling } and backupManagementType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql } and operation eq { ConfigureBackup , Backup , Restore , DisableBackup , DeleteBackupData } and jobId eq {guid} and startTime eq { yyyy-mm-dd hh:mm:ss PM } and endTime eq { yyyy-mm-dd hh:mm:ss PM }. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}
JobCancellations_Trigger (removed)
Description :  Cancels the job. This is an asynchronous operation. To know the status of the cancellation, call the GetCancelOperationResult API.
Reference :  Link ¶

⚼ Request

POST:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}/cancel
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
jobName:
{
Description: Name of the job to cancel. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}
JobDetails_Get (removed)
Description :  Gets extended information associated with the job.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs/{jobName}
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
jobName:
{
Description: Name of the job associated with this GET operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Defines workload-agnostic properties for a job. ,
Required: False ,
}
{
entityFriendlyName:
{
Description: The friendly name of the entity on which the current job is executing. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type for the current job. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
}
,
Required: False ,
}
enum ,
operation:
{
Description: The operation name. ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
activityId:
{
Description: ActivityId of job. ,
Required: False ,
}
string ,
jobType:
{
Description: This property is the discriminator for deciding between the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
Jobs_List (removed)
Description :  Provides a pageable list of jobs.
Reference :  Link ¶

⚼ Request

GET:  /Subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupJobs
{
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: The following equation can be used to filter the list of jobs based on status, type, start date, and end date. status eq { InProgress , Completed , Failed , CompletedWithWarnings , Cancelled , Cancelling } and backupManagementType eq {AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql } and operation eq { ConfigureBackup , Backup , Restore , DisableBackup , DeleteBackupData } and jobId eq {guid} and startTime eq { yyyy-mm-dd hh:mm:ss PM } and endTime eq { yyyy-mm-dd hh:mm:ss PM }. ,
Required: False ,
}
string ,
$skipToken:
{
Description: The Skip Token filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: Defines workload-agnostic properties for a job. ,
Required: False ,
}
{
entityFriendlyName:
{
Description: The friendly name of the entity on which the current job is executing. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The backup management type for the current job. ,
Enum:
{
Invalid: No description available. ,
AzureIaasVM: No description available. ,
MAB: No description available. ,
DPM: No description available. ,
AzureBackupServer: No description available. ,
AzureSql: No description available. ,
}
,
Required: False ,
}
enum ,
operation:
{
Description: The operation name. ,
Required: False ,
}
string ,
status:
{
Description: The job status. ,
Required: False ,
}
string ,
startTime:
{
Description: The start time. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The end time. ,
Format: date-time ,
Required: False ,
}
string ,
activityId:
{
Description: ActivityId of job. ,
Required: False ,
}
string ,
jobType:
{
Description: This property is the discriminator for deciding between the specific types in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
BackupOperationStatuses_Get (removed)
Description :  Gets the status of an operation such as triggering a backup or 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of 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: The operation start time. The format of the time is ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
endTime:
{
Description: The operation end time. The format of the time is ISO-8601. ,
Format: date-time ,
Required: False ,
}
string ,
error:
{
Description: Error information related to this operation. ,
Required: False ,
}
{
code:
{
Description: The error code for the failed operation. ,
Required: False ,
}
string ,
message:
{
Description: The error message for the failed operation. ,
Required: False ,
}
string ,
}
,
properties:
{
Description: Additional information associated with this operation. ,
Required: False ,
}
{
objectType:
{
Description: This property is used as the discriminator for deciding between types, in the polymorphic chain of types. ,
Required: False ,
}
string ,
}
,
}
BackupOperationResults_Get (removed)
Description :  Provides the status of the delete operations, for example, deleting a backup item. Once the operation starts, the response status code is Accepted. The response status code remains in this state until the operation reaches completion. On successful completion, the status code changes to 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
operationId:
{
Description: The ID of the operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (202)

{}

⚐ Response (204)

{}
BackupEngines_Get (removed)
Description :  The backup management servers registered to a Recovery Services vault. This 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 associated with the Recovery Services vault. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
$filter:
{
Description: Use this filter to choose the specific backup management server. backupManagementType { AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql }. ,
Required: False ,
}
string ,
$skipToken:
{
Description: The Skip Token filter. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: List of resources. ,
Required: False ,
}
[
{
properties:
{
Description: The base backup engine class. All workload-specific backup engines derive from this class. ,
Required: False ,
}
{
friendlyName:
{
Description: The friendly name of the backup engine. ,
Required: False ,
}
string ,
backupManagementType:
{
Description: The type of backup management associated with 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. ,
}
,
Required: False ,
}
enum ,
registrationStatus:
{
Description: The status of the backup engine registration with the Recovery Services vault. ,
Required: False ,
}
string ,
healthStatus:
{
Description: The backup status of the backup engine. ,
Required: False ,
}
string ,
backupEngineType:
{
Description: The type of the backup engine. ,
Required: False ,
}
string ,
canReRegister:
{
Description: The flag indicating whether the backup engine be registered again, once the engine has been initially registered. ,
Required: False ,
}
boolean ,
backupEngineId:
{
Description: The ID of the backup engine. ,
Required: False ,
}
string ,
}
,
}
,
]
,
}
ProtectionContainers_Unregister (removed)
Description :  Unregisters the given container from your Recovery Services vault.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/registeredIdentities/{identityName}
{
subscriptionId:
{
Description: The subscription ID. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group associated with the Recovery Services vault. ,
Required: True ,
}
string ,
vaultName:
{
Description: The name of the Recovery Services vault. ,
Required: True ,
}
string ,
api-version:
{
Description: Client API version. ,
Required: True ,
}
string ,
identityName:
{
Description: Name of the protection container to unregister. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}