backup_instances

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

Overview

Name	backup_instances
Type	Resource
Id	azure.data_protection.backup_instances

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Proxy Resource Id represents the complete path to the resource.
name	string	Proxy Resource name associated with the resource.
properties	object	BackupInstanceResource properties
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Proxy Resource tags.
type	string	Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

list

Name	Datatype	Description
id	string	Proxy Resource Id represents the complete path to the resource.
name	string	Proxy Resource name associated with the resource.
properties	object	BackupInstanceResource properties
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Proxy Resource tags.
type	string	Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, vaultName, backupInstanceName		Gets a backup instance with name in a backup vault
list	select	subscriptionId, resourceGroupName, vaultName		Gets a backup instances belonging to a backup vault
create_or_update	insert	subscriptionId, resourceGroupName, vaultName, backupInstanceName	x-ms-authorization-auxiliary	Create or update a backup instance in a backup vault
delete	delete	subscriptionId, resourceGroupName, vaultName, backupInstanceName	x-ms-authorization-auxiliary	Delete a backup instance in a backup vault
adhoc_backup	exec	subscriptionId, resourceGroupName, vaultName, backupInstanceName, backupRuleOptions		Trigger adhoc backup
validate_for_backup	exec	subscriptionId, resourceGroupName, vaultName, backupInstance		Validate whether adhoc backup will be successful or not
trigger_cross_region_restore	exec	subscriptionId, resourceGroupName, location, restoreRequestObject, crossRegionRestoreDetails		Triggers Cross Region Restore for BackupInstance.
validate_cross_region_restore	exec	subscriptionId, resourceGroupName, location, restoreRequestObject, crossRegionRestoreDetails		Validates whether Cross Region Restore can be triggered for DataSource.
trigger_rehydrate	exec	resourceGroupName, subscriptionId, vaultName, backupInstanceName, recoveryPointId, rehydrationRetentionDuration		rehydrate recovery point for restore for a BackupInstance
trigger_restore	exec	subscriptionId, resourceGroupName, vaultName, backupInstanceName, objectType, restoreTargetInfo, sourceDataStoreType	x-ms-authorization-auxiliary	Triggers restore for a BackupInstance
resume_backups	exec	subscriptionId, resourceGroupName, vaultName, backupInstanceName		This operation will resume backups for backup instance
resume_protection	exec	subscriptionId, resourceGroupName, vaultName, backupInstanceName		This operation will resume protection for a stopped backup instance
stop_protection	exec	subscriptionId, resourceGroupName, vaultName, backupInstanceName	x-ms-authorization-auxiliary	This operation will stop protection of a backup instance and data will be held forever
suspend_backups	exec	subscriptionId, resourceGroupName, vaultName, backupInstanceName	x-ms-authorization-auxiliary	This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever)
sync_backup_instance	exec	subscriptionId, resourceGroupName, vaultName, backupInstanceName		Sync backup instance again in case of failure This action will retry last failed operation and will bring backup instance to valid state
validate_for_restore	exec	subscriptionId, resourceGroupName, vaultName, backupInstanceName, restoreRequestObject		Validates if Restore can be triggered for a DataSource

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
backupInstanceName	string	The name of the backup instance.
location	string	The name of the Azure region.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
vaultName	string	The name of the backup vault.
x-ms-authorization-auxiliary	string

SELECT examples

get

Gets a backup instance with name in a backup vault

SELECT
id,
name,
properties,
systemData,
tags,
type
FROM azure.data_protection.backup_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
AND backupInstanceName = '{{ backupInstanceName }}' -- required
;

list

Gets a backup instances belonging to a backup vault

SELECT
id,
name,
properties,
systemData,
tags,
type
FROM azure.data_protection.backup_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND vaultName = '{{ vaultName }}' -- required
;

INSERT examples

create_or_update

Create or update a backup instance in a backup vault

INSERT INTO azure.data_protection.backup_instances (
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
vaultName,
backupInstanceName,
x-ms-authorization-auxiliary
)
SELECT 
'{{ tags }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ vaultName }}',
'{{ backupInstanceName }}',
'{{ x-ms-authorization-auxiliary }}'
RETURNING
id,
name,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: backup_instances
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the backup_instances resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the backup_instances resource.
    - name: vaultName
      value: string
      description: Required parameter for the backup_instances resource.
    - name: backupInstanceName
      value: string
      description: Required parameter for the backup_instances resource.
    - name: tags
      value: object
      description: |
        Proxy Resource tags.
    - name: properties
      value: object
      description: |
        BackupInstanceResource properties
    - name: x-ms-authorization-auxiliary
      value: string

DELETE examples

delete

Delete a backup instance in a backup vault

DELETE FROM azure.data_protection.backup_instances
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND vaultName = '{{ vaultName }}' --required
AND backupInstanceName = '{{ backupInstanceName }}' --required
AND x-ms-authorization-auxiliary = '{{ x-ms-authorization-auxiliary }}'
;

Lifecycle Methods

adhoc_backup

Trigger adhoc backup

EXEC azure.data_protection.backup_instances.adhoc_backup 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@vaultName='{{ vaultName }}' --required, 
@backupInstanceName='{{ backupInstanceName }}' --required 
@@json=
'{
"backupRuleOptions": "{{ backupRuleOptions }}"
}'
;

validate_for_backup

Validate whether adhoc backup will be successful or not

EXEC azure.data_protection.backup_instances.validate_for_backup 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@vaultName='{{ vaultName }}' --required 
@@json=
'{
"backupInstance": "{{ backupInstance }}"
}'
;

trigger_cross_region_restore

Triggers Cross Region Restore for BackupInstance.

EXEC azure.data_protection.backup_instances.trigger_cross_region_restore 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required 
@@json=
'{
"restoreRequestObject": "{{ restoreRequestObject }}", 
"crossRegionRestoreDetails": "{{ crossRegionRestoreDetails }}"
}'
;

validate_cross_region_restore

Validates whether Cross Region Restore can be triggered for DataSource.

EXEC azure.data_protection.backup_instances.validate_cross_region_restore 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@location='{{ location }}' --required 
@@json=
'{
"restoreRequestObject": "{{ restoreRequestObject }}", 
"crossRegionRestoreDetails": "{{ crossRegionRestoreDetails }}"
}'
;

trigger_rehydrate

rehydrate recovery point for restore for a BackupInstance

EXEC azure.data_protection.backup_instances.trigger_rehydrate 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required, 
@vaultName='{{ vaultName }}' --required, 
@backupInstanceName='{{ backupInstanceName }}' --required 
@@json=
'{
"recoveryPointId": "{{ recoveryPointId }}", 
"rehydrationPriority": "{{ rehydrationPriority }}", 
"rehydrationRetentionDuration": "{{ rehydrationRetentionDuration }}"
}'
;

trigger_restore

Triggers restore for a BackupInstance

EXEC azure.data_protection.backup_instances.trigger_restore 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@vaultName='{{ vaultName }}' --required, 
@backupInstanceName='{{ backupInstanceName }}' --required, 
@x-ms-authorization-auxiliary='{{ x-ms-authorization-auxiliary }}' 
@@json=
'{
"objectType": "{{ objectType }}", 
"restoreTargetInfo": "{{ restoreTargetInfo }}", 
"sourceDataStoreType": "{{ sourceDataStoreType }}", 
"sourceResourceId": "{{ sourceResourceId }}", 
"resourceGuardOperationRequests": "{{ resourceGuardOperationRequests }}", 
"identityDetails": "{{ identityDetails }}"
}'
;

resume_backups

This operation will resume backups for backup instance

EXEC azure.data_protection.backup_instances.resume_backups 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@vaultName='{{ vaultName }}' --required, 
@backupInstanceName='{{ backupInstanceName }}' --required
;

resume_protection

This operation will resume protection for a stopped backup instance

EXEC azure.data_protection.backup_instances.resume_protection 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@vaultName='{{ vaultName }}' --required, 
@backupInstanceName='{{ backupInstanceName }}' --required
;

stop_protection

This operation will stop protection of a backup instance and data will be held forever

EXEC azure.data_protection.backup_instances.stop_protection 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@vaultName='{{ vaultName }}' --required, 
@backupInstanceName='{{ backupInstanceName }}' --required, 
@x-ms-authorization-auxiliary='{{ x-ms-authorization-auxiliary }}' 
@@json=
'{
"resourceGuardOperationRequests": "{{ resourceGuardOperationRequests }}"
}'
;

suspend_backups

This operation will stop backup for a backup instance and retains the backup data as per the policy (except latest Recovery point, which will be retained forever)

EXEC azure.data_protection.backup_instances.suspend_backups 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@vaultName='{{ vaultName }}' --required, 
@backupInstanceName='{{ backupInstanceName }}' --required, 
@x-ms-authorization-auxiliary='{{ x-ms-authorization-auxiliary }}' 
@@json=
'{
"resourceGuardOperationRequests": "{{ resourceGuardOperationRequests }}"
}'
;

sync_backup_instance

Sync backup instance again in case of failure
This action will retry last failed operation and will bring backup instance to valid state

EXEC azure.data_protection.backup_instances.sync_backup_instance 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@vaultName='{{ vaultName }}' --required, 
@backupInstanceName='{{ backupInstanceName }}' --required 
@@json=
'{
"syncType": "{{ syncType }}"
}'
;

validate_for_restore

Validates if Restore can be triggered for a DataSource

EXEC azure.data_protection.backup_instances.validate_for_restore 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@vaultName='{{ vaultName }}' --required, 
@backupInstanceName='{{ backupInstanceName }}' --required 
@@json=
'{
"restoreRequestObject": "{{ restoreRequestObject }}"
}'
;