item_level_recovery_connections

Creates, updates, deletes, gets or lists an item_level_recovery_connections resource.

Overview

Name	item_level_recovery_connections
Type	Resource
Id	azure.recovery_services_backup.item_level_recovery_connections

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
provision	exec	vaultName, resourceGroupName, subscriptionId, fabricName, containerName, protectedItemName, recoveryPointId	api-version	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.
revoke	exec	vaultName, resourceGroupName, subscriptionId, fabricName, containerName, protectedItemName, recoveryPointId	api-version	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.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

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

Lifecycle Methods

provision

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.

EXEC azure.recovery_services_backup.item_level_recovery_connections.provision 
@vaultName='{{ vaultName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@containerName='{{ containerName }}' --required, 
@protectedItemName='{{ protectedItemName }}' --required, 
@recoveryPointId='{{ recoveryPointId }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;

revoke

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.

EXEC azure.recovery_services_backup.item_level_recovery_connections.revoke 
@vaultName='{{ vaultName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@fabricName='{{ fabricName }}' --required, 
@containerName='{{ containerName }}' --required, 
@protectedItemName='{{ protectedItemName }}' --required, 
@recoveryPointId='{{ recoveryPointId }}' --required, 
@api-version='{{ api-version }}'
;