backup_protected_items

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

Overview

Name	backup_protected_items
Type	Resource
Id	azure.recovery_services_backup.backup_protected_items

Fields

The following fields are returned by SELECT queries:

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.
backupManagementType	string	Type of backup management for the backed up item. Known values are: "Invalid", "AzureIaasVM", "MAB", "DPM", "AzureBackupServer", "AzureSql", "AzureStorage", "AzureWorkload", and "DefaultBackup". (Invalid, AzureIaasVM, MAB, DPM, AzureBackupServer, AzureSql, AzureStorage, AzureWorkload, DefaultBackup)
backupSetName	string	Name of the backup set the backup item belongs to.
containerName	string	Unique name of container.
createMode	string	Create mode to indicate recovery of existing soft deleted data source or creation of new data source. Known values are: "Invalid", "Default", and "Recover". (Invalid, Default, Recover)
deferredDeleteTimeInUTC	string (date-time)	Time for deferred deletion in UTC.
deferredDeleteTimeRemaining	string	Time remaining before the DS marked for deferred delete is permanently deleted.
eTag	string	Optional ETag.
isArchiveEnabled	boolean	Flag to identify whether datasource is protected in archive.
isDeferredDeleteScheduleUpcoming	boolean	Flag to identify whether the deferred deleted DS is to be purged soon.
isRehydrate	boolean	Flag to identify that deferred deleted DS is to be moved into Pause state.
isScheduledForDeferredDelete	boolean	Flag to identify whether the DS is scheduled for deferred delete.
lastRecoveryPoint	string (date-time)	Timestamp when the last (latest) backup copy was created for this backup item.
location	string	The geo-location where the resource lives.
policyId	string	ID of the backup policy with which this item is backed up.
policyName	string	Name of the policy used for protection.
protectedItemType	string	backup item type. Required. Default value is None.
resourceGuardOperationRequests	array	ResourceGuardOperationRequests on which LAC check will be performed.
softDeleteRetentionPeriodInDays	integer	Soft delete retention period in days.
sourceResourceId	string	ARM ID of the resource to be backed up.
sourceSideScanInfo	object	Source side threat information.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
vaultId	string	ID of the vault which protects this item.
workloadType	string	Type of workload this item represents. Known values are: "Invalid", "VM", "FileFolder", "AzureSqlDb", "SQLDB", "Exchange", "Sharepoint", "VMwareVM", "SystemState", "Client", "GenericDataSource", "SQLDataBase", "AzureFileShare", "SAPHanaDatabase", "SAPAseDatabase", and "SAPHanaDBInstance". (Invalid, VM, FileFolder, AzureSqlDb, SQLDB, Exchange, Sharepoint, VMwareVM, SystemState, Client, GenericDataSource, SQLDataBase, AzureFileShare, SAPHanaDatabase, SAPAseDatabase, SAPHanaDBInstance)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	vault_name, resource_group_name, subscription_id	$filter, $skipToken	Provides a pageable list of all items that are backed up within a vault.

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
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 recovery services vault. Required.
$filter	string	OData filter options. Default value is None.
$skipToken	string	skipToken Filter. Default value is None.

SELECT examples

list

Provides a pageable list of all items that are backed up within a vault.

SELECT
id,
name,
backupManagementType,
backupSetName,
containerName,
createMode,
deferredDeleteTimeInUTC,
deferredDeleteTimeRemaining,
eTag,
isArchiveEnabled,
isDeferredDeleteScheduleUpcoming,
isRehydrate,
isScheduledForDeferredDelete,
lastRecoveryPoint,
location,
policyId,
policyName,
protectedItemType,
resourceGuardOperationRequests,
softDeleteRetentionPeriodInDays,
sourceResourceId,
sourceSideScanInfo,
systemData,
tags,
type,
vaultId,
workloadType
FROM azure.recovery_services_backup.backup_protected_items
WHERE vault_name = '{{ vault_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $skipToken = '{{ $skipToken }}'
;