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

vw_backup_instances

Name	Datatype	Description
id	text	Proxy Resource Id represents the complete path to the resource.
name	text	Proxy Resource name associated with the resource.
backupInstanceName	text	field from the properties object
current_protection_state	text	field from the properties object
data_source_info	text	field from the properties object
data_source_set_info	text	field from the properties object
datasource_auth_credentials	text	field from the properties object
friendly_name	text	field from the properties object
identity_details	text	field from the properties object
object_type	text	field from the properties object
policy_info	text	field from the properties object
protection_error_details	text	field from the properties object
protection_status	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_guard_operation_requests	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Proxy Resource tags.
type	text	Proxy Resource type represents the complete path of the form Namespace/ResourceType/ResourceType/...
validation_type	text	field from the properties object
vaultName	text	field from the properties object

backup_instances

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	Backup Instance
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

Name	Accessible by	Required Params	Description
get	SELECT	backupInstanceName, resourceGroupName, subscriptionId, vaultName	Gets a backup instance with name in a backup vault
list	SELECT	resourceGroupName, subscriptionId, vaultName	Gets a backup instances belonging to a backup vault
create_or_update	INSERT	backupInstanceName, resourceGroupName, subscriptionId, vaultName	Create or update a backup instance in a backup vault
delete	DELETE	backupInstanceName, resourceGroupName, subscriptionId, vaultName	Delete a backup instance in a backup vault
adhoc_backup	EXEC	backupInstanceName, resourceGroupName, subscriptionId, vaultName, data__backupRuleOptions	Trigger adhoc backup
resume_backups	EXEC	backupInstanceName, resourceGroupName, subscriptionId, vaultName	This operation will resume backups for backup instance
resume_protection	EXEC	backupInstanceName, resourceGroupName, subscriptionId, vaultName	This operation will resume protection for a stopped backup instance
stop_protection	EXEC	backupInstanceName, resourceGroupName, subscriptionId, vaultName	This operation will stop protection of a backup instance and data will be held forever
suspend_backups	EXEC	backupInstanceName, resourceGroupName, subscriptionId, vaultName	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	backupInstanceName, resourceGroupName, subscriptionId, vaultName	Sync backup instance again in case of failure
This action will retry last failed operation and will bring backup instance to valid state
trigger_cross_region_restore	EXEC	location, resourceGroupName, subscriptionId, data__crossRegionRestoreDetails, data__restoreRequestObject	Triggers Cross Region Restore for BackupInstance.
trigger_rehydrate	EXEC	backupInstanceName, resourceGroupName, subscriptionId, vaultName, data__recoveryPointId, data__rehydrationRetentionDuration	rehydrate recovery point for restore for a BackupInstance
trigger_restore	EXEC	backupInstanceName, resourceGroupName, subscriptionId, vaultName, data__objectType, data__restoreTargetInfo, data__sourceDataStoreType	Triggers restore for a BackupInstance
validate_cross_region_restore	EXEC	location, resourceGroupName, subscriptionId, data__crossRegionRestoreDetails, data__restoreRequestObject	Validates whether Cross Region Restore can be triggered for DataSource.
validate_for_backup	EXEC	resourceGroupName, subscriptionId, vaultName, data__backupInstance	Validate whether adhoc backup will be successful or not
validate_for_restore	EXEC	backupInstanceName, resourceGroupName, subscriptionId, vaultName, data__restoreRequestObject	Validates if Restore can be triggered for a DataSource

SELECT examples

Gets a backup instances belonging to a backup vault

vw_backup_instances

SELECT
id,
name,
backupInstanceName,
current_protection_state,
data_source_info,
data_source_set_info,
datasource_auth_credentials,
friendly_name,
identity_details,
object_type,
policy_info,
protection_error_details,
protection_status,
provisioning_state,
resourceGroupName,
resource_guard_operation_requests,
subscriptionId,
system_data,
tags,
type,
validation_type,
vaultName
FROM azure.data_protection.vw_backup_instances
WHERE resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vaultName = '{{ vaultName }}';

backup_instances

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

INSERT example

Use the following StackQL query and manifest file to create a new backup_instances resource.

All Properties

/*+ create */
INSERT INTO azure.data_protection.backup_instances (
backupInstanceName,
resourceGroupName,
subscriptionId,
vaultName,
tags,
systemData,
properties
)
SELECT 
'{{ backupInstanceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ vaultName }}',
'{{ tags }}',
'{{ systemData }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: tags
      value: object
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: properties
      value:
        - name: friendlyName
          value: string
        - name: dataSourceInfo
          value:
            - name: datasourceType
              value: string
            - name: objectType
              value: string
            - name: resourceID
              value: string
            - name: resourceLocation
              value: string
            - name: resourceName
              value: string
            - name: resourceType
              value: string
            - name: resourceUri
              value: string
            - name: resourceProperties
              value:
                - name: objectType
                  value: string
        - name: dataSourceSetInfo
          value:
            - name: datasourceType
              value: string
            - name: objectType
              value: string
            - name: resourceID
              value: string
            - name: resourceLocation
              value: string
            - name: resourceName
              value: string
            - name: resourceType
              value: string
            - name: resourceUri
              value: string
        - name: policyInfo
          value:
            - name: policyId
              value: string
            - name: policyVersion
              value: string
            - name: policyParameters
              value:
                - name: dataStoreParametersList
                  value:
                    - - name: objectType
                        value: string
                      - name: dataStoreType
                        value: string
                - name: backupDatasourceParametersList
                  value:
                    - - name: objectType
                        value: string
        - name: resourceGuardOperationRequests
          value:
            - string
        - name: protectionStatus
          value:
            - name: errorDetails
              value:
                - name: code
                  value: string
                - name: details
                  value:
                    - - name: code
                        value: string
                      - name: details
                        value:
                          - - name: code
                              value: string
                            - name: details
                              value:
                                - - name: code
                                    value: string
                                  - name: details
                                    value:
                                      - - name: code
                                          value: string
                                        - name: details
                                          value:
                                            - - name: code
                                                value: string
                                              - name: details
                                                value:
                                                  - - name: code
                                                      value: string
                                                    - name: details
                                                      value:
                                                        - - name: code
                                                            value: string
                                                          - name: details
                                                            value:
                                                              - []
                                                          - name: innerError
                                                            value: []
                                                          - name: isRetryable
                                                            value: boolean
                                                          - name: isUserError
                                                            value: boolean
                                                          - name: properties
                                                            value: object
                                                          - name: message
                                                            value: string
                                                          - name: recommendedAction
                                                            value:
                                                              - string
                                                          - name: target
                                                            value: string
                                                    - name: isRetryable
                                                      value: boolean
                                                    - name: isUserError
                                                      value: boolean
                                                    - name: properties
                                                      value: object
                                                    - name: message
                                                      value: string
                                                    - name: recommendedAction
                                                      value:
                                                        - string
                                                    - name: target
                                                      value: string
                                              - name: isRetryable
                                                value: boolean
                                              - name: isUserError
                                                value: boolean
                                              - name: properties
                                                value: object
                                              - name: message
                                                value: string
                                              - name: recommendedAction
                                                value:
                                                  - string
                                              - name: target
                                                value: string
                                        - name: isRetryable
                                          value: boolean
                                        - name: isUserError
                                          value: boolean
                                        - name: properties
                                          value: object
                                        - name: message
                                          value: string
                                        - name: recommendedAction
                                          value:
                                            - string
                                        - name: target
                                          value: string
                                  - name: isRetryable
                                    value: boolean
                                  - name: isUserError
                                    value: boolean
                                  - name: properties
                                    value: object
                                  - name: message
                                    value: string
                                  - name: recommendedAction
                                    value:
                                      - string
                                  - name: target
                                    value: string
                            - name: isRetryable
                              value: boolean
                            - name: isUserError
                              value: boolean
                            - name: properties
                              value: object
                            - name: message
                              value: string
                            - name: recommendedAction
                              value:
                                - string
                            - name: target
                              value: string
                      - name: isRetryable
                        value: boolean
                      - name: isUserError
                        value: boolean
                      - name: properties
                        value: object
                      - name: message
                        value: string
                      - name: recommendedAction
                        value:
                          - string
                      - name: target
                        value: string
                - name: isRetryable
                  value: boolean
                - name: isUserError
                  value: boolean
                - name: properties
                  value: object
                - name: message
                  value: string
                - name: recommendedAction
                  value:
                    - string
                - name: target
                  value: string
            - name: status
              value: string
        - name: currentProtectionState
          value: string
        - name: provisioningState
          value: string
        - name: datasourceAuthCredentials
          value:
            - name: objectType
              value: string
        - name: validationType
          value: string
        - name: identityDetails
          value:
            - name: useSystemAssignedIdentity
              value: boolean
            - name: userAssignedIdentityArmUrl
              value: string
        - name: objectType
          value: string

DELETE example

Deletes the specified backup_instances resource.

/*+ delete */
DELETE FROM azure.data_protection.backup_instances
WHERE backupInstanceName = '{{ backupInstanceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vaultName = '{{ vaultName }}';