deleted_backup_instances

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

Overview

Name	deleted_backup_instances
Type	Resource
Id	azure.data_protection.deleted_backup_instances

Fields

The following fields are returned by SELECT queries:

get

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.
deletionInfo	object	Deletion info of Backup Instance.
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.
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)

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.
deletionInfo	object	Deletion info of Backup Instance.
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.
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	select	resource_group_name, vault_name, backup_instance_name, subscription_id		Gets a deleted backup instance with name in a backup vault.
list	select	resource_group_name, vault_name, subscription_id		Gets deleted backup instances belonging to a backup vault.
undelete	exec	resource_group_name, vault_name, backup_instance_name, subscription_id		A long-running resource action.

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 deleted backup instance. 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.

SELECT examples

get

Gets a deleted backup instance with name in a backup vault.

SELECT
id,
name,
currentProtectionState,
dataSourceInfo,
dataSourceSetInfo,
datasourceAuthCredentials,
deletionInfo,
friendlyName,
identityDetails,
objectType,
policyInfo,
protectionErrorDetails,
protectionStatus,
provisioningState,
resourceGuardOperationRequests,
systemData,
type,
validationType
FROM azure.data_protection.deleted_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
;

list

Gets deleted backup instances belonging to a backup vault.

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

Lifecycle Methods

undelete

A long-running resource action.

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