operations

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

Overview

Name	operations
Type	Resource
Id	azure.recovery_services_backup.operations

Fields

The following fields are returned by SELECT queries:

list

Name	Datatype	Description
name	string	Name of the Operation.
display	object	Contains the localized display information for this particular operation
origin	string	The intended executor of the operation;governs the display of the operation in the RBAC UX and the audit logs UX
properties	object	ShoeBox properties for the given operation.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select		api-version	Returns the list of available operations.
bms_prepare_data_move	exec	vaultName, resourceGroupName, subscriptionId, targetResourceId, targetRegion, dataMoveLevel	api-version	Prepares source vault for Data Move operation
bms_trigger_data_move	exec	vaultName, resourceGroupName, subscriptionId, sourceResourceId, sourceRegion, dataMoveLevel, correlationId	api-version	Triggers Data Move Operation on target vault
validate	exec	vaultName, resourceGroupName, subscriptionId, id, properties	api-version	Validate operation for specified backed up item. This is a synchronous operation.
move_recovery_point	exec	vaultName, resourceGroupName, subscriptionId, fabricName, containerName, protectedItemName, recoveryPointId	api-version

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
fabricName	string
protectedItemName	string
recoveryPointId	string
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.

SELECT examples

list

Returns the list of available operations.

SELECT
name,
display,
origin,
properties
FROM azure.recovery_services_backup.operations
WHERE api-version = '{{ api-version }}'
;

Lifecycle Methods

bms_prepare_data_move

Prepares source vault for Data Move operation

EXEC azure.recovery_services_backup.operations.bms_prepare_data_move 
@vaultName='{{ vaultName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"targetResourceId": "{{ targetResourceId }}", 
"targetRegion": "{{ targetRegion }}", 
"dataMoveLevel": "{{ dataMoveLevel }}", 
"sourceContainerArmIds": "{{ sourceContainerArmIds }}", 
"ignoreMoved": {{ ignoreMoved }}
}'
;

bms_trigger_data_move

Triggers Data Move Operation on target vault

EXEC azure.recovery_services_backup.operations.bms_trigger_data_move 
@vaultName='{{ vaultName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"sourceResourceId": "{{ sourceResourceId }}", 
"sourceRegion": "{{ sourceRegion }}", 
"dataMoveLevel": "{{ dataMoveLevel }}", 
"correlationId": "{{ correlationId }}", 
"sourceContainerArmIds": "{{ sourceContainerArmIds }}", 
"pauseGC": {{ pauseGC }}
}'
;

validate

Validate operation for specified backed up item. This is a synchronous operation.

EXEC azure.recovery_services_backup.operations.validate 
@vaultName='{{ vaultName }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@api-version='{{ api-version }}' 
@@json=
'{
"id": "{{ id }}", 
"properties": "{{ properties }}"
}'
;

move_recovery_point

Accepted

EXEC azure.recovery_services_backup.operations.move_recovery_point 
@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=
'{
"objectType": "{{ objectType }}", 
"sourceTierType": "{{ sourceTierType }}", 
"targetTierType": "{{ targetTierType }}"
}'
;