restores

Creates, updates, deletes, gets or lists a restores resource.

Overview

Name	restores
Type	Resource
Id	azure.recovery_services_backup.restores

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
trigger	exec	vaultName, resourceGroupName, subscriptionId, fabricName, containerName, protectedItemName, recoveryPointId	api-version, x-ms-authorization-auxiliary	Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use GetProtectedItemOperationResult API.

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 to be restored.
recoveryPointId	string	Recovery point ID which represents the backed up data to be restored.
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.
x-ms-authorization-auxiliary	string

Lifecycle Methods

trigger

Restores the specified backed up data. This is an asynchronous operation. To know the status of this API call, use
GetProtectedItemOperationResult API.

EXEC azure.recovery_services_backup.restores.trigger 
@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 }}', 
@x-ms-authorization-auxiliary='{{ x-ms-authorization-auxiliary }}' 
@@json=
'{
"properties": "{{ properties }}"
}'
;