backup_protection_intent

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

Overview

Name	backup_protection_intent
Type	Resource
Id	azure.recovery_services_backup.backup_protection_intent

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)
eTag	string	Optional ETag.
itemId	string	ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId.
location	string	The geo-location where the resource lives.
policyId	string	ID of the backup policy with which this item is backed up.
protectionIntentItemType	string	backup protectionIntent type. Required. Known values are: "Invalid", "AzureResourceItem", "RecoveryServiceVaultItem", "AzureWorkloadContainerAutoProtectionIntent", "AzureWorkloadAutoProtectionIntent", and "AzureWorkloadSQLAutoProtectionIntent".
protectionState	string	Backup state of this backup item. Known values are: "Invalid", "NotProtected", "Protecting", "Protected", and "ProtectionFailed". (Invalid, NotProtected, Protecting, Protected, ProtectionFailed)
sourceResourceId	string	ARM ID of the resource to be backed up.
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".

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 intents that are present 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 intents that are present within a vault.

SELECT
id,
name,
backupManagementType,
eTag,
itemId,
location,
policyId,
protectionIntentItemType,
protectionState,
sourceResourceId,
systemData,
tags,
type
FROM azure.recovery_services_backup.backup_protection_intent
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 }}'
;