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_backup_instance_operation_result
get
list

Name	Datatype	Description
`id`	`string`	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
`name`	`string`	The name of the resource.
`currentProtectionState`	`string`	Specifies the current protection state of the resource. Known values are: "Invalid", "NotProtected", "ConfiguringProtection", "ProtectionConfigured", "BackupSchedulesSuspended", "RetentionSchedulesSuspended", "ProtectionStopped", "ProtectionError", "ConfiguringProtectionFailed", "SoftDeleting", "SoftDeleted", and "UpdatingProtection". (Invalid, NotProtected, ConfiguringProtection, ProtectionConfigured, BackupSchedulesSuspended, RetentionSchedulesSuspended, ProtectionStopped, ProtectionError, ConfiguringProtectionFailed, SoftDeleting, SoftDeleted, UpdatingProtection)
`dataSourceInfo`	`object`	Gets or sets the data source information. Required.
`dataSourceSetInfo`	`object`	Gets or sets the data source set information.
`datasourceAuthCredentials`	`object`	Credentials to use to authenticate with data source provider.
`friendlyName`	`string`	Gets or sets the Backup Instance friendly name.
`identityDetails`	`object`	Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
`objectType`	`string`	Required.
`policyInfo`	`object`	Gets or sets the policy information. Required.
`protectionErrorDetails`	`object`	Specifies the protection error of the resource.
`protectionStatus`	`object`	Specifies the protection status of the resource.
`provisioningState`	`string`	Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed.
`resourceGuardOperationRequests`	`array`	ResourceGuardOperationRequests on which LAC check will be performed.
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Proxy Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
`validationType`	`string`	Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. Known values are: "ShallowValidation" and "DeepValidation". (ShallowValidation, DeepValidation)

Name	Datatype	Description
`id`	`string`	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
`name`	`string`	The name of the resource.
`currentProtectionState`	`string`	Specifies the current protection state of the resource. Known values are: "Invalid", "NotProtected", "ConfiguringProtection", "ProtectionConfigured", "BackupSchedulesSuspended", "RetentionSchedulesSuspended", "ProtectionStopped", "ProtectionError", "ConfiguringProtectionFailed", "SoftDeleting", "SoftDeleted", and "UpdatingProtection". (Invalid, NotProtected, ConfiguringProtection, ProtectionConfigured, BackupSchedulesSuspended, RetentionSchedulesSuspended, ProtectionStopped, ProtectionError, ConfiguringProtectionFailed, SoftDeleting, SoftDeleted, UpdatingProtection)
`dataSourceInfo`	`object`	Gets or sets the data source information. Required.
`dataSourceSetInfo`	`object`	Gets or sets the data source set information.
`datasourceAuthCredentials`	`object`	Credentials to use to authenticate with data source provider.
`friendlyName`	`string`	Gets or sets the Backup Instance friendly name.
`identityDetails`	`object`	Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
`objectType`	`string`	Required.
`policyInfo`	`object`	Gets or sets the policy information. Required.
`protectionErrorDetails`	`object`	Specifies the protection error of the resource.
`protectionStatus`	`object`	Specifies the protection status of the resource.
`provisioningState`	`string`	Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed.
`resourceGuardOperationRequests`	`array`	ResourceGuardOperationRequests on which LAC check will be performed.
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Proxy Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
`validationType`	`string`	Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. Known values are: "ShallowValidation" and "DeepValidation". (ShallowValidation, DeepValidation)

Name	Datatype	Description
`id`	`string`	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
`name`	`string`	The name of the resource.
`currentProtectionState`	`string`	Specifies the current protection state of the resource. Known values are: "Invalid", "NotProtected", "ConfiguringProtection", "ProtectionConfigured", "BackupSchedulesSuspended", "RetentionSchedulesSuspended", "ProtectionStopped", "ProtectionError", "ConfiguringProtectionFailed", "SoftDeleting", "SoftDeleted", and "UpdatingProtection". (Invalid, NotProtected, ConfiguringProtection, ProtectionConfigured, BackupSchedulesSuspended, RetentionSchedulesSuspended, ProtectionStopped, ProtectionError, ConfiguringProtectionFailed, SoftDeleting, SoftDeleted, UpdatingProtection)
`dataSourceInfo`	`object`	Gets or sets the data source information. Required.
`dataSourceSetInfo`	`object`	Gets or sets the data source set information.
`datasourceAuthCredentials`	`object`	Credentials to use to authenticate with data source provider.
`friendlyName`	`string`	Gets or sets the Backup Instance friendly name.
`identityDetails`	`object`	Contains information of the Identity Details for the BI. If it is null, default will be considered as System Assigned.
`objectType`	`string`	Required.
`policyInfo`	`object`	Gets or sets the policy information. Required.
`protectionErrorDetails`	`object`	Specifies the protection error of the resource.
`protectionStatus`	`object`	Specifies the protection status of the resource.
`provisioningState`	`string`	Specifies the provisioning state of the resource i.e. provisioning/updating/Succeeded/Failed.
`resourceGuardOperationRequests`	`array`	ResourceGuardOperationRequests on which LAC check will be performed.
`systemData`	`object`	Azure Resource Manager metadata containing createdBy and modifiedBy information.
`tags`	`object`	Proxy Resource tags.
`type`	`string`	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
`validationType`	`string`	Specifies the type of validation. In case of DeepValidation, all validations from /validateForBackup API will run again. Known values are: "ShallowValidation" and "DeepValidation". (ShallowValidation, DeepValidation)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get_backup_instance_operation_result`	`select`	`resource_group_name`, `vault_name`, `backup_instance_name`, `operation_id`, `subscription_id`		Get result of backup instance creation operation.
`get`	`select`	`resource_group_name`, `vault_name`, `backup_instance_name`, `subscription_id`		Gets a backup instance with name in a backup vault.
`list`	`select`	`resource_group_name`, `vault_name`, `subscription_id`		Gets a backup instances belonging to a backup vault.
`create_or_update`	`insert`	`resource_group_name`, `vault_name`, `backup_instance_name`, `subscription_id`	`x-ms-authorization-auxiliary`	Create or update a backup instance in a backup vault.
`create_or_update`	`replace`	`resource_group_name`, `vault_name`, `backup_instance_name`, `subscription_id`	`x-ms-authorization-auxiliary`	Create or update a backup instance in a backup vault.
`delete`	`delete`	`resource_group_name`, `vault_name`, `backup_instance_name`, `subscription_id`	`x-ms-authorization-auxiliary`	Delete a backup instance in a backup vault.
`validate_for_backup`	`exec`	`resource_group_name`, `vault_name`, `subscription_id`, `backupInstance`		Validate whether adhoc backup will be successful or not.
`adhoc_backup`	`exec`	`resource_group_name`, `vault_name`, `backup_instance_name`, `subscription_id`, `backupRuleOptions`		Trigger adhoc backup.
`validate_for_modify_backup`	`exec`	`resource_group_name`, `vault_name`, `backup_instance_name`, `subscription_id`, `backupInstance`		Validate whether update for backup instance will be successful or not.
`trigger_rehydrate`	`exec`	`resource_group_name`, `vault_name`, `backup_instance_name`, `subscription_id`, `recoveryPointId`, `rehydrationRetentionDuration`		rehydrate recovery point for restore for a BackupInstance.
`trigger_restore`	`exec`	`resource_group_name`, `vault_name`, `backup_instance_name`, `subscription_id`, `objectType`, `restoreTargetInfo`, `sourceDataStoreType`	`x-ms-authorization-auxiliary`	Triggers restore for a BackupInstance.
`resume_backups`	`exec`	`resource_group_name`, `vault_name`, `backup_instance_name`, `subscription_id`		This operation will resume backups for backup instance.
`resume_protection`	`exec`	`resource_group_name`, `vault_name`, `backup_instance_name`, `subscription_id`		This operation will resume protection for a stopped backup instance.
`stop_protection`	`exec`	`resource_group_name`, `vault_name`, `backup_instance_name`, `subscription_id`	`x-ms-authorization-auxiliary`	This operation will stop protection of a backup instance and data will be held forever.
`suspend_backups`	`exec`	`resource_group_name`, `vault_name`, `backup_instance_name`, `subscription_id`	`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`	`resource_group_name`, `vault_name`, `backup_instance_name`, `subscription_id`		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`	`resource_group_name`, `vault_name`, `backup_instance_name`, `subscription_id`, `restoreRequestObject`		Validates if Restore can be triggered for a DataSource.
`trigger_cross_region_restore`	`exec`	`resource_group_name`, `location`, `subscription_id`, `restoreRequestObject`, `crossRegionRestoreDetails`		Triggers Cross Region Restore for BackupInstance.
`validate_cross_region_restore`	`exec`	`resource_group_name`, `location`, `subscription_id`, `restoreRequestObject`, `crossRegionRestoreDetails`		Validates whether Cross Region Restore can be triggered for 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
`backup_instance_name`	`string`	The name of the BackupInstanceResource. Required.
`location`	`string`	The name of the Azure region. Required.
`operation_id`	`string`	The name of the BackupInstanceResource. 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 backup vault. Required.
`x-ms-authorization-auxiliary`	`string`	Default value is None.

`SELECT` examples

get_backup_instance_operation_result
get
list

Get result of backup instance creation operation.

SELECT
id,
name,
currentProtectionState,
dataSourceInfo,
dataSourceSetInfo,
datasourceAuthCredentials,
friendlyName,
identityDetails,
objectType,
policyInfo,
protectionErrorDetails,
protectionStatus,
provisioningState,
resourceGuardOperationRequests,
systemData,
tags,
type,
validationType
FROM azure.data_protection.backup_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND backup_instance_name = '{{ backup_instance_name }}' -- required
AND operation_id = '{{ operation_id }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Gets a backup instance with name in a backup vault.

SELECT
id,
name,
currentProtectionState,
dataSourceInfo,
dataSourceSetInfo,
datasourceAuthCredentials,
friendlyName,
identityDetails,
objectType,
policyInfo,
protectionErrorDetails,
protectionStatus,
provisioningState,
resourceGuardOperationRequests,
systemData,
tags,
type,
validationType
FROM azure.data_protection.backup_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND backup_instance_name = '{{ backup_instance_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

Gets a backup instances belonging to a backup vault.

SELECT
id,
name,
currentProtectionState,
dataSourceInfo,
dataSourceSetInfo,
datasourceAuthCredentials,
friendlyName,
identityDetails,
objectType,
policyInfo,
protectionErrorDetails,
protectionStatus,
provisioningState,
resourceGuardOperationRequests,
systemData,
tags,
type,
validationType
FROM azure.data_protection.backup_instances
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND vault_name = '{{ vault_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

`INSERT` examples

create_or_update
Manifest

Create or update a backup instance in a backup vault.

INSERT INTO azure.data_protection.backup_instances (
properties,
tags,
resource_group_name,
vault_name,
backup_instance_name,
subscription_id,
x-ms-authorization-auxiliary
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ resource_group_name }}',
'{{ vault_name }}',
'{{ backup_instance_name }}',
'{{ subscription_id }}',
'{{ x-ms-authorization-auxiliary }}'
RETURNING
id,
name,
properties,
systemData,
tags,
type
;

# Description fields are for documentation purposes
- name: backup_instances
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the backup_instances resource.
  - name: vault_name
    value: "{{ vault_name }}"
    description: Required parameter for the backup_instances resource.
  - name: backup_instance_name
    value: "{{ backup_instance_name }}"
    description: Required parameter for the backup_instances resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the backup_instances resource.
  - name: properties
    description: |
      BackupInstanceResource properties.
    value:
      friendlyName: "{{ friendlyName }}"
      dataSourceInfo:
        datasourceType: "{{ datasourceType }}"
        objectType: "{{ objectType }}"
        resourceID: "{{ resourceID }}"
        resourceLocation: "{{ resourceLocation }}"
        resourceName: "{{ resourceName }}"
        resourceType: "{{ resourceType }}"
        resourceUri: "{{ resourceUri }}"
        resourceProperties:
          objectType: "{{ objectType }}"
      dataSourceSetInfo:
        datasourceType: "{{ datasourceType }}"
        objectType: "{{ objectType }}"
        resourceID: "{{ resourceID }}"
        resourceLocation: "{{ resourceLocation }}"
        resourceName: "{{ resourceName }}"
        resourceType: "{{ resourceType }}"
        resourceUri: "{{ resourceUri }}"
        resourceProperties:
          objectType: "{{ objectType }}"
      policyInfo:
        policyId: "{{ policyId }}"
        policyVersion: "{{ policyVersion }}"
        policyParameters:
          dataStoreParametersList:
            - objectType: "{{ objectType }}"
              dataStoreType: "{{ dataStoreType }}"
          backupDatasourceParametersList:
            - objectType: "{{ objectType }}"
      resourceGuardOperationRequests:
        - "{{ resourceGuardOperationRequests }}"
      protectionStatus:
        errorDetails:
          code: "{{ code }}"
          details:
            - code: "{{ code }}"
              details: "{{ details }}"
              innerError:
                additionalInfo: "{{ additionalInfo }}"
                code: "{{ code }}"
                embeddedInnerError: "{{ embeddedInnerError }}"
              isRetryable: {{ isRetryable }}
              isUserError: {{ isUserError }}
              properties: "{{ properties }}"
              message: "{{ message }}"
              recommendedAction: "{{ recommendedAction }}"
              target: "{{ target }}"
          innerError:
            additionalInfo: "{{ additionalInfo }}"
            code: "{{ code }}"
            embeddedInnerError:
              additionalInfo: "{{ additionalInfo }}"
              code: "{{ code }}"
              embeddedInnerError: "{{ embeddedInnerError }}"
          isRetryable: {{ isRetryable }}
          isUserError: {{ isUserError }}
          properties: "{{ properties }}"
          message: "{{ message }}"
          recommendedAction:
            - "{{ recommendedAction }}"
          target: "{{ target }}"
        status: "{{ status }}"
      currentProtectionState: "{{ currentProtectionState }}"
      protectionErrorDetails:
        code: "{{ code }}"
        details:
          - code: "{{ code }}"
            details: "{{ details }}"
            innerError:
              additionalInfo: "{{ additionalInfo }}"
              code: "{{ code }}"
              embeddedInnerError:
                additionalInfo: "{{ additionalInfo }}"
                code: "{{ code }}"
                embeddedInnerError: "{{ embeddedInnerError }}"
            isRetryable: {{ isRetryable }}
            isUserError: {{ isUserError }}
            properties: "{{ properties }}"
            message: "{{ message }}"
            recommendedAction: "{{ recommendedAction }}"
            target: "{{ target }}"
        innerError:
          additionalInfo: "{{ additionalInfo }}"
          code: "{{ code }}"
          embeddedInnerError:
            additionalInfo: "{{ additionalInfo }}"
            code: "{{ code }}"
            embeddedInnerError:
              additionalInfo: "{{ additionalInfo }}"
              code: "{{ code }}"
              embeddedInnerError: "{{ embeddedInnerError }}"
        isRetryable: {{ isRetryable }}
        isUserError: {{ isUserError }}
        properties: "{{ properties }}"
        message: "{{ message }}"
        recommendedAction:
          - "{{ recommendedAction }}"
        target: "{{ target }}"
      provisioningState: "{{ provisioningState }}"
      datasourceAuthCredentials:
        objectType: "{{ objectType }}"
      validationType: "{{ validationType }}"
      identityDetails:
        useSystemAssignedIdentity: {{ useSystemAssignedIdentity }}
        userAssignedIdentityArmUrl: "{{ userAssignedIdentityArmUrl }}"
      objectType: "{{ objectType }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Proxy Resource tags.
  - name: x-ms-authorization-auxiliary
    value: "{{ x-ms-authorization-auxiliary }}"
    description: Default value is None.
    description: Default value is None.

`REPLACE` examples

create_or_update

Create or update a backup instance in a backup vault.

REPLACE azure.data_protection.backup_instances
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND backup_instance_name = '{{ backup_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND x-ms-authorization-auxiliary = '{{ x-ms-authorization-auxiliary}}'
RETURNING
id,
name,
properties,
systemData,
tags,
type;

`DELETE` examples

delete

Delete a backup instance in a backup vault.

DELETE FROM azure.data_protection.backup_instances
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND vault_name = '{{ vault_name }}' --required
AND backup_instance_name = '{{ backup_instance_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND x-ms-authorization-auxiliary = '{{ x-ms-authorization-auxiliary }}'
;

Lifecycle Methods

Validate whether adhoc backup will be successful or not.

EXEC azure.data_protection.backup_instances.validate_for_backup 
@resource_group_name='{{ resource_group_name }}' --required, 
@vault_name='{{ vault_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"backupInstance": "{{ backupInstance }}"
}'
;

Trigger adhoc backup.

EXEC azure.data_protection.backup_instances.adhoc_backup 
@resource_group_name='{{ resource_group_name }}' --required, 
@vault_name='{{ vault_name }}' --required, 
@backup_instance_name='{{ backup_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"backupRuleOptions": "{{ backupRuleOptions }}"
}'
;

Validate whether update for backup instance will be successful or not.

EXEC azure.data_protection.backup_instances.validate_for_modify_backup 
@resource_group_name='{{ resource_group_name }}' --required, 
@vault_name='{{ vault_name }}' --required, 
@backup_instance_name='{{ backup_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"backupInstance": "{{ backupInstance }}"
}'
;

rehydrate recovery point for restore for a BackupInstance.

EXEC azure.data_protection.backup_instances.trigger_rehydrate 
@resource_group_name='{{ resource_group_name }}' --required, 
@vault_name='{{ vault_name }}' --required, 
@backup_instance_name='{{ backup_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"recoveryPointId": "{{ recoveryPointId }}", 
"rehydrationPriority": "{{ rehydrationPriority }}", 
"rehydrationRetentionDuration": "{{ rehydrationRetentionDuration }}"
}'
;

Triggers restore for a BackupInstance.

EXEC azure.data_protection.backup_instances.trigger_restore 
@resource_group_name='{{ resource_group_name }}' --required, 
@vault_name='{{ vault_name }}' --required, 
@backup_instance_name='{{ backup_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@x-ms-authorization-auxiliary='{{ x-ms-authorization-auxiliary }}' 
@@json=
'{
"objectType": "{{ objectType }}", 
"restoreTargetInfo": "{{ restoreTargetInfo }}", 
"sourceDataStoreType": "{{ sourceDataStoreType }}", 
"sourceResourceId": "{{ sourceResourceId }}", 
"resourceGuardOperationRequests": "{{ resourceGuardOperationRequests }}", 
"identityDetails": "{{ identityDetails }}"
}'
;

This operation will resume backups for backup instance.

EXEC azure.data_protection.backup_instances.resume_backups 
@resource_group_name='{{ resource_group_name }}' --required, 
@vault_name='{{ vault_name }}' --required, 
@backup_instance_name='{{ backup_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

This operation will resume protection for a stopped backup instance.

EXEC azure.data_protection.backup_instances.resume_protection 
@resource_group_name='{{ resource_group_name }}' --required, 
@vault_name='{{ vault_name }}' --required, 
@backup_instance_name='{{ backup_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

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

EXEC azure.data_protection.backup_instances.stop_protection 
@resource_group_name='{{ resource_group_name }}' --required, 
@vault_name='{{ vault_name }}' --required, 
@backup_instance_name='{{ backup_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@x-ms-authorization-auxiliary='{{ x-ms-authorization-auxiliary }}' 
@@json=
'{
"resourceGuardOperationRequests": "{{ resourceGuardOperationRequests }}"
}'
;

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 
@resource_group_name='{{ resource_group_name }}' --required, 
@vault_name='{{ vault_name }}' --required, 
@backup_instance_name='{{ backup_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required, 
@x-ms-authorization-auxiliary='{{ x-ms-authorization-auxiliary }}' 
@@json=
'{
"resourceGuardOperationRequests": "{{ resourceGuardOperationRequests }}"
}'
;

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 
@resource_group_name='{{ resource_group_name }}' --required, 
@vault_name='{{ vault_name }}' --required, 
@backup_instance_name='{{ backup_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"syncType": "{{ syncType }}"
}'
;

Validates if Restore can be triggered for a DataSource.

EXEC azure.data_protection.backup_instances.validate_for_restore 
@resource_group_name='{{ resource_group_name }}' --required, 
@vault_name='{{ vault_name }}' --required, 
@backup_instance_name='{{ backup_instance_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"restoreRequestObject": "{{ restoreRequestObject }}"
}'
;

Triggers Cross Region Restore for BackupInstance.

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

Validates whether Cross Region Restore can be triggered for DataSource.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

REPLACE examples​

DELETE examples​

Lifecycle Methods​