Share via

Item Level Recovery Connections - Provision

Service:
Recovery Services - Backup
API Version:
2025-08-01

Provisions a script which invokes an iSCSI connection to the backup data. Executing this script opens a file explorer displaying all the recoverable files and folders. This is an asynchronous operation. To know the status of provisioning, call GetProtectedItemOperationResult API.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.RecoveryServices/vaults/{vaultName}/backupFabrics/{fabricName}/protectionContainers/{containerName}/protectedItems/{protectedItemName}/recoveryPoints/{recoveryPointId}/provisionInstantItemRecovery?api-version=2025-08-01

URI Parameters

Name In Required Type Description
containerName
 path True

string

Name of the container whose details need to be fetched.
fabricName
 path True

string

The name of the BackupFabricResource
protectedItemName
 path True

string

Backed up item name whose details are to be fetched.
recoveryPointId
 path True

string

RecoveryPointID represents the backed up data to be fetched.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

The name of the resource group. The name is case insensitive.
subscriptionId
 path True

string

minLength: 1

The ID of the target subscription.
vaultName
 path True

string

The name of the VaultResource
api-version
 query True

string

minLength: 1

The API version to use for this operation.

Request Body

Name Type Description
eTag

string

Optional ETag.
location

string

Resource location.
properties ILRRequest:

ILRRequestResource properties
tags

object

Resource tags.

Responses

Name Type Description
202 Accepted

The request has been accepted for processing, but processing has not yet completed.
Other Status Codes

ErrorResponse

An unexpected error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

Provision Instant Item Level Recovery for Azure Vm

Sample request

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/protectedItems/vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/recoveryPoints/1/provisionInstantItemRecovery?api-version=2025-08-01

{
  "properties": {
    "initiatorName": "Hello World",
    "objectType": "IaasVMILRRegistrationRequest",
    "recoveryPointId": "38823086363464",
    "renewExistingRegistration": true,
    "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/pysdktestrg/providers/Microsoft.Compute/virtualMachines/pysdktestv2vm1"
  }
}

Sample response

Status code:
202 
Azure-AsyncOperation: https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/protectedItems/vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/operationsStatus/00000000-0000-0000-0000-000000000000?api-version=2016-12-01
Location: https://management.azure.com/Subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/PythonSDKBackupTestRg/providers/Microsoft.RecoveryServices/vaults/PySDKBackupTestRsVault/backupFabrics/Azure/protectionContainers/iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/protectedItems/vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1/operationResults/00000000-0000-0000-0000-000000000000?api-version=2016-12-01
Retry-After: 60

Definitions

Name Description
AzureFileShareProvisionILRRequest

Update snapshot Uri with the correct friendly Name of the source Azure file share.
createdByType

The type of identity that created the resource.
ErrorDetail

Error Detail class which encapsulates Code, Message and Recommendations.
ErrorResponse

Error response
IaasVMILRRegistrationRequest

Restore files/folders from a backup copy of IaaS VM.
ILRRequestResource

Parameters to Provision ILR API.
systemData

Metadata pertaining to creation and last modification of the resource.

AzureFileShareProvisionILRRequest

Object

Update snapshot Uri with the correct friendly Name of the source Azure file share.

Name Type Description
objectType string:

AzureFileShareProvisionILRRequest

This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
recoveryPointId

string

Recovery point ID.
sourceResourceId

string

Source Storage account ARM Id

createdByType

Enumeration

The type of identity that created the resource.

Value Description
User
Application
ManagedIdentity
Key

ErrorDetail

Object

Error Detail class which encapsulates Code, Message and Recommendations.

Name Type Description
code

string

Error code.
message

string

Error Message related to the Code.
recommendations

string[]

List of recommendation strings.

ErrorResponse

Object

Error response

Name Type Description
error

ErrorDetail

The error object.

IaasVMILRRegistrationRequest

Object

Restore files/folders from a backup copy of IaaS VM.

Name Type Description
initiatorName

string

iSCSI initiator name.
objectType string:

IaasVMILRRegistrationRequest

This property will be used as the discriminator for deciding the specific types in the polymorphic chain of types.
recoveryPointId

string

ID of the IaaS VM backup copy from where the files/folders have to be restored.
renewExistingRegistration

boolean

Whether to renew existing registration with the iSCSI server.
virtualMachineId

string

Fully qualified ARM ID of the virtual machine whose the files / folders have to be restored.

ILRRequestResource

Object

Parameters to Provision ILR API.

Name Type Description
eTag

string

Optional ETag.
id

string

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location

string

Resource location.
name

string

The name of the resource
properties ILRRequest:

ILRRequestResource properties
systemData

systemData

Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags

object

Resource tags.
type

string

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name Type Description
createdAt

string (date-time)

The timestamp of resource creation (UTC).
createdBy

string

The identity that created the resource.
createdByType

createdByType

The type of identity that created the resource.
lastModifiedAt

string (date-time)

The timestamp of resource last modification (UTC)
lastModifiedBy

string

The identity that last modified the resource.
lastModifiedByType

createdByType

The type of identity that last modified the resource.