backups

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

Overview

Name	backups
Type	Resource
Id	azure.recovery_services_backup.backups

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, subscription_id		Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the operation, call 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.
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.

Lifecycle Methods

trigger

Triggers backup for specified backed up item. This is an asynchronous operation. To know the status of the operation, call GetProtectedItemOperationResult API.

EXEC azure.recovery_services_backup.backups.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, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"eTag": "{{ eTag }}", 
"properties": "{{ properties }}"
}'
;