protected_items

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

Overview

Name	protected_items
Type	Resource
Id	azure.recovery_services_backup.protected_items

Fields

vw_protected_items

Name	Datatype	Description
id	text	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	text	The name of the resource
backup_management_type	text	field from the properties object
backup_set_name	text	field from the properties object
containerName	text	field from the properties object
container_name	text	field from the properties object
create_mode	text	field from the properties object
deferred_delete_time_in_utc	text	field from the properties object
deferred_delete_time_remaining	text	field from the properties object
fabricName	text	field from the properties object
is_archive_enabled	text	field from the properties object
is_deferred_delete_schedule_upcoming	text	field from the properties object
is_rehydrate	text	field from the properties object
is_scheduled_for_deferred_delete	text	field from the properties object
last_recovery_point	text	field from the properties object
policy_id	text	field from the properties object
policy_name	text	field from the properties object
protectedItemName	text	field from the properties object
protected_item_type	text	field from the properties object
resourceGroupName	text	field from the properties object
resource_guard_operation_requests	text	field from the properties object
soft_delete_retention_period_in_days	text	field from the properties object
source_resource_id	text	field from the properties object
subscriptionId	text	field from the properties object
type	text	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
vaultName	text	field from the properties object
vault_id	text	field from the properties object
workload_type	text	field from the properties object

protected_items

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
properties	object	Base class for backup items.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Methods

Name	Accessible by	Required Params	Description
get	SELECT	containerName, fabricName, protectedItemName, resourceGroupName, subscriptionId, vaultName	Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation,
call the GetItemOperationResult API.
create_or_update	INSERT	containerName, fabricName, protectedItemName, resourceGroupName, subscriptionId, vaultName	Enables backup of an item or to modifies the backup policy information of an already backed up item. This is an
asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.
delete	DELETE	containerName, fabricName, protectedItemName, resourceGroupName, subscriptionId, vaultName	Used to disable backup of an item within a container. This is an asynchronous operation. To know the status of the
request, call the GetItemOperationResult API.

SELECT examples

Provides the details of the backed up item. This is an asynchronous operation. To know the status of the operation, call the GetItemOperationResult API.

vw_protected_items

SELECT
id,
name,
backup_management_type,
backup_set_name,
containerName,
container_name,
create_mode,
deferred_delete_time_in_utc,
deferred_delete_time_remaining,
fabricName,
is_archive_enabled,
is_deferred_delete_schedule_upcoming,
is_rehydrate,
is_scheduled_for_deferred_delete,
last_recovery_point,
policy_id,
policy_name,
protectedItemName,
protected_item_type,
resourceGroupName,
resource_guard_operation_requests,
soft_delete_retention_period_in_days,
source_resource_id,
subscriptionId,
type,
vaultName,
vault_id,
workload_type
FROM azure.recovery_services_backup.vw_protected_items
WHERE containerName = '{{ containerName }}'
AND fabricName = '{{ fabricName }}'
AND protectedItemName = '{{ protectedItemName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vaultName = '{{ vaultName }}';

protected_items

SELECT
id,
name,
properties,
type
FROM azure.recovery_services_backup.protected_items
WHERE containerName = '{{ containerName }}'
AND fabricName = '{{ fabricName }}'
AND protectedItemName = '{{ protectedItemName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vaultName = '{{ vaultName }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO azure.recovery_services_backup.protected_items (
containerName,
fabricName,
protectedItemName,
resourceGroupName,
subscriptionId,
vaultName,
properties
)
SELECT 
'{{ containerName }}',
'{{ fabricName }}',
'{{ protectedItemName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ vaultName }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: properties
      value:
        - name: protectedItemType
          value: string
        - name: backupManagementType
          value: string
        - name: workloadType
          value: string
        - name: containerName
          value: string
        - name: sourceResourceId
          value: string
        - name: policyId
          value: string
        - name: lastRecoveryPoint
          value: string
        - name: backupSetName
          value: string
        - name: createMode
          value: string
        - name: deferredDeleteTimeInUTC
          value: string
        - name: isScheduledForDeferredDelete
          value: boolean
        - name: deferredDeleteTimeRemaining
          value: string
        - name: isDeferredDeleteScheduleUpcoming
          value: boolean
        - name: isRehydrate
          value: boolean
        - name: resourceGuardOperationRequests
          value:
            - string
        - name: isArchiveEnabled
          value: boolean
        - name: policyName
          value: string
        - name: softDeleteRetentionPeriodInDays
          value: integer
        - name: vaultId
          value: string

DELETE example

Deletes the specified protected_items resource.

/*+ delete */
DELETE FROM azure.recovery_services_backup.protected_items
WHERE containerName = '{{ containerName }}'
AND fabricName = '{{ fabricName }}'
AND protectedItemName = '{{ protectedItemName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}'
AND vaultName = '{{ vaultName }}';