Item Level Recovery Connections - Provision

Service:

Recovery Services - Backup

API Version:

2024-04-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=2024-04-01

URI Parameters

Name	In	Required	Type	Description
containerName	path	True	string	Container name associated with the backed up items.
fabricName	path	True	string	Fabric name associated with the backed up items.
protectedItemName	path	True	string	Backed up item name whose files/folders are to be restored.
recoveryPointId	path	True	string	Recovery point ID which represents backed up data. iSCSI connection will be provisioned for this backed up data.
resourceGroupName	path	True	string	The name of the resource group where the recovery services vault is present.
subscriptionId	path	True	string	The subscription Id.
vaultName	path	True	string	The name of the recovery services vault.
api-version	query	True	string	Client Api Version.

Request Body

Name	Type	Description
eTag	string	Optional ETag.
location	string	Resource location.
properties	ILRRequest: AzureFileShareProvisionILRRequest IaasVMILRRegistrationRequest	ILRRequestResource properties
tags	object	Resource tags.

Responses

Name	Type	Description
202 Accepted		Accepted
Other Status Codes	CloudError	Error response describing why the operation failed.

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

HTTP

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=2024-04-01

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

Java

import com.azure.resourcemanager.recoveryservicesbackup.models.IaasVmilrRegistrationRequest;
import com.azure.resourcemanager.recoveryservicesbackup.models.IlrRequestResource;

/**
 * Samples for ItemLevelRecoveryConnections Provision.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/
     * AzureIaasVm/Provision_Ilr.json
     */
    /**
     * Sample code: Provision Instant Item Level Recovery for Azure Vm.
     * 
     * @param manager Entry point to RecoveryServicesBackupManager.
     */
    public static void provisionInstantItemLevelRecoveryForAzureVm(
        com.azure.resourcemanager.recoveryservicesbackup.RecoveryServicesBackupManager manager) {
        manager.itemLevelRecoveryConnections().provisionWithResponse("PySDKBackupTestRsVault", "PythonSDKBackupTestRg",
            "Azure", "iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1",
            "vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", "1",
            new IlrRequestResource().withProperties(new IaasVmilrRegistrationRequest()
                .withRecoveryPointId("38823086363464")
                .withVirtualMachineId(
                    "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/pysdktestrg/providers/Microsoft.Compute/virtualMachines/pysdktestv2vm1")
                .withInitiatorName("Hello World").withRenewExistingRegistration(true)),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.recoveryservicesbackup.activestamp import RecoveryServicesBackupClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-recoveryservicesbackup
# USAGE
    python provision_ilr.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = RecoveryServicesBackupClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    client.item_level_recovery_connections.provision(
        vault_name="PySDKBackupTestRsVault",
        resource_group_name="PythonSDKBackupTestRg",
        fabric_name="Azure",
        container_name="iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1",
        protected_item_name="vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1",
        recovery_point_id="1",
        parameters={
            "properties": {
                "initiatorName": "Hello World",
                "objectType": "IaasVMILRRegistrationRequest",
                "recoveryPointId": "38823086363464",
                "renewExistingRegistration": True,
                "virtualMachineId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/pysdktestrg/providers/Microsoft.Compute/virtualMachines/pysdktestv2vm1",
            }
        },
    )


# x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/AzureIaasVm/Provision_Ilr.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armrecoveryservicesbackup_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/recoveryservices/armrecoveryservicesbackup/v4"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/33c4457b1d13f83965f4fe3367dca4a6df898100/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/AzureIaasVm/Provision_Ilr.json
func ExampleItemLevelRecoveryConnectionsClient_Provision() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armrecoveryservicesbackup.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	_, err = clientFactory.NewItemLevelRecoveryConnectionsClient().Provision(ctx, "PySDKBackupTestRsVault", "PythonSDKBackupTestRg", "Azure", "iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", "vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1", "1", armrecoveryservicesbackup.ILRRequestResource{
		Properties: &armrecoveryservicesbackup.IaasVMILRRegistrationRequest{
			ObjectType:                to.Ptr("IaasVMILRRegistrationRequest"),
			InitiatorName:             to.Ptr("Hello World"),
			RecoveryPointID:           to.Ptr("38823086363464"),
			RenewExistingRegistration: to.Ptr(true),
			VirtualMachineID:          to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/pysdktestrg/providers/Microsoft.Compute/virtualMachines/pysdktestv2vm1"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { RecoveryServicesBackupClient } = require("@azure/arm-recoveryservicesbackup");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to 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.
 *
 * @summary 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.
 * x-ms-original-file: specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2024-04-01/examples/AzureIaasVm/Provision_Ilr.json
 */
async function provisionInstantItemLevelRecoveryForAzureVM() {
  const subscriptionId =
    process.env["RECOVERYSERVICESBACKUP_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const vaultName = "PySDKBackupTestRsVault";
  const resourceGroupName =
    process.env["RECOVERYSERVICESBACKUP_RESOURCE_GROUP"] || "PythonSDKBackupTestRg";
  const fabricName = "Azure";
  const containerName = "iaasvmcontainer;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1";
  const protectedItemName = "vm;iaasvmcontainerv2;pysdktestrg;pysdktestv2vm1";
  const recoveryPointId = "1";
  const parameters = {
    properties: {
      initiatorName: "Hello World",
      objectType: "IaasVMILRRegistrationRequest",
      recoveryPointId: "38823086363464",
      renewExistingRegistration: true,
      virtualMachineId:
        "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/pysdktestrg/providers/Microsoft.Compute/virtualMachines/pysdktestv2vm1",
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new RecoveryServicesBackupClient(credential, subscriptionId);
  const result = await client.itemLevelRecoveryConnections.provision(
    vaultName,
    resourceGroupName,
    fabricName,
    containerName,
    protectedItemName,
    recoveryPointId,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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.
CloudError	An error response from the Container Instance service.
CloudErrorBody	An error response from the Container Instance service.
ErrorAdditionalInfo	The resource management error additional info.
IaasVMILRRegistrationRequest	Restore files/folders from a backup copy of IaaS VM.
ILRRequestResource	Parameters to Provision ILR API.

AzureFileShareProvisionILRRequest

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

CloudError

An error response from the Container Instance service.

Name	Type	Description
error	CloudErrorBody	The error object.

CloudErrorBody

An error response from the Container Instance service.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

IaasVMILRRegistrationRequest

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

Parameters to Provision ILR API.

Name	Type	Description
eTag	string	Optional ETag.
id	string	Resource Id represents the complete path to the resource.
location	string	Resource location.
name	string	Resource name associated with the resource.
properties	ILRRequest: AzureFileShareProvisionILRRequest IaasVMILRRegistrationRequest	ILRRequestResource properties
tags	object	Resource tags.
type	string	Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...