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 | vault_name, resource_group_name, fabric_name, container_name, protected_item_name, recovery_point_id, subscription_id | 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 |
|---|---|---|
container_name | string | Name of the container whose details need to be fetched. Required. |
fabric_name | string | The name of the BackupFabricResource. Required. |
protected_item_name | string | Backed up item name whose details are to be fetched. Required. |
recovery_point_id | string | RecoveryPointID represents the backed up data to be fetched. Required. |
resource_group_name | string | The name of the resource group. The name is case insensitive. Required. |
subscription_id | string | |
vault_name | string | The name of the VaultResource. Required. |
x-ms-authorization-auxiliary | string | Default value is None. |
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
@vault_name='{{ vault_name }}' --required,
@resource_group_name='{{ resource_group_name }}' --required,
@fabric_name='{{ fabric_name }}' --required,
@container_name='{{ container_name }}' --required,
@protected_item_name='{{ protected_item_name }}' --required,
@recovery_point_id='{{ recovery_point_id }}' --required,
@subscription_id='{{ subscription_id }}' --required,
@x-ms-authorization-auxiliary='{{ x-ms-authorization-auxiliary }}'
@@json=
'{
"location": "{{ location }}",
"tags": "{{ tags }}",
"eTag": "{{ eTag }}",
"properties": "{{ properties }}"
}'
;