Microsoft.RecoveryServices vaults/backupFabrics/backupProtectionIntent 2021-04-01

• Latest
• 2024-10-01
• 2024-07-30-preview
• 2024-04-30-preview
• 2024-04-01
• 2024-02-01
• 2024-01-01
• 2023-08-01
• 2023-06-01
• 2023-04-01
• 2023-02-01
• 2023-01-01
• 2022-10-01
• 2022-09-30-preview
• 2022-09-01-preview
• 2022-06-01-preview
• 2022-04-01
• 2022-03-01
• 2022-02-01
• 2022-01-01
• 2021-12-01
• 2021-10-01
• 2021-08-01
• 2021-07-01
• 2021-06-01
• 2021-04-01
• 2021-03-01
• 2021-02-10
• 2021-02-01
• 2021-02-01-preview
• 2017-07-01

Bicep resource definition

The vaults/backupFabrics/backupProtectionIntent resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-04-01' = {
  parent: resourceSymbolicName
  eTag: 'string'
  location: 'string'
  name: 'string'
  properties: {
    backupManagementType: 'string'
    itemId: 'string'
    policyId: 'string'
    protectionState: 'string'
    sourceResourceId: 'string'
    protectionIntentItemType: 'string'
    // For remaining properties, see ProtectionIntent objects
  }
  tags: {
    {customized property}: 'string'
  }
}

ProtectionIntent objects

Set the protectionIntentItemType property to specify the type of object.

For AzureResourceItem, use:

{
  friendlyName: 'string'
  protectionIntentItemType: 'AzureResourceItem'
}

For AzureWorkloadSQLAutoProtectionIntent, use:

{
  protectionIntentItemType: 'AzureWorkloadSQLAutoProtectionIntent'
  workloadItemType: 'string'
}

Property values

AzureResourceProtectionIntent

Name	Description	Value
friendlyName	Friendly name of the VM represented by this backup item.	string
protectionIntentItemType	backup protectionIntent type.	'AzureResourceItem' (required)

AzureWorkloadSQLAutoProtectionIntent

Name	Description	Value
protectionIntentItemType	backup protectionIntent type.	'AzureWorkloadSQLAutoProtectionIntent' (required)
workloadItemType	Workload item type of the item for which intent is to be set	'Invalid' 'SAPAseDatabase' 'SAPAseSystem' 'SAPHanaDatabase' 'SAPHanaSystem' 'SQLDataBase' 'SQLInstance'

Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent

Name	Description	Value
eTag	Optional ETag.	string
location	Resource location.	string
name	The resource name	string (required)
parent	In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource.	Symbolic name for resource of type: vaults/backupFabrics
properties	ProtectionIntentResource properties	ProtectionIntent
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

ProtectionIntent

Name	Description	Value
backupManagementType	Type of backup management for the backed up item.	'AzureBackupServer' 'AzureIaasVM' 'AzureSql' 'AzureStorage' 'AzureWorkload' 'DefaultBackup' 'DPM' 'Invalid' 'MAB'
itemId	ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId	string
policyId	ID of the backup policy with which this item is backed up.	string
protectionIntentItemType	Set to 'AzureResourceItem' for type AzureResourceProtectionIntent. Set to 'AzureWorkloadSQLAutoProtectionIntent' for type AzureWorkloadSQLAutoProtectionIntent.	'AzureResourceItem' 'AzureWorkloadSQLAutoProtectionIntent' (required)
protectionState	Backup state of this backup item.	'Invalid' 'NotProtected' 'Protected' 'Protecting' 'ProtectionFailed'
sourceResourceId	ARM ID of the resource to be backed up.	string

ResourceTags

Name	Description	Value

ARM template resource definition

The vaults/backupFabrics/backupProtectionIntent resource type can be deployed with operations that target:

• Resource groups - See resource group deployment commands

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent resource, add the following JSON to your template.

{
  "type": "Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent",
  "apiVersion": "2021-04-01",
  "name": "string",
  "eTag": "string",
  "location": "string",
  "properties": {
    "backupManagementType": "string",
    "itemId": "string",
    "policyId": "string",
    "protectionState": "string",
    "sourceResourceId": "string",
    "protectionIntentItemType": "string"
    // For remaining properties, see ProtectionIntent objects
  },
  "tags": {
    "{customized property}": "string"
  }
}

ProtectionIntent objects

Set the protectionIntentItemType property to specify the type of object.

For AzureResourceItem, use:

{
  "friendlyName": "string",
  "protectionIntentItemType": "AzureResourceItem"
}

For AzureWorkloadSQLAutoProtectionIntent, use:

{
  "protectionIntentItemType": "AzureWorkloadSQLAutoProtectionIntent",
  "workloadItemType": "string"
}

Property values

AzureResourceProtectionIntent

Name	Description	Value
friendlyName	Friendly name of the VM represented by this backup item.	string
protectionIntentItemType	backup protectionIntent type.	'AzureResourceItem' (required)

AzureWorkloadSQLAutoProtectionIntent

Name	Description	Value
protectionIntentItemType	backup protectionIntent type.	'AzureWorkloadSQLAutoProtectionIntent' (required)
workloadItemType	Workload item type of the item for which intent is to be set	'Invalid' 'SAPAseDatabase' 'SAPAseSystem' 'SAPHanaDatabase' 'SAPHanaSystem' 'SQLDataBase' 'SQLInstance'

Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent

Name	Description	Value
apiVersion	The api version	'2021-04-01'
eTag	Optional ETag.	string
location	Resource location.	string
name	The resource name	string (required)
properties	ProtectionIntentResource properties	ProtectionIntent
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent'

ProtectionIntent

Name	Description	Value
backupManagementType	Type of backup management for the backed up item.	'AzureBackupServer' 'AzureIaasVM' 'AzureSql' 'AzureStorage' 'AzureWorkload' 'DefaultBackup' 'DPM' 'Invalid' 'MAB'
itemId	ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId	string
policyId	ID of the backup policy with which this item is backed up.	string
protectionIntentItemType	Set to 'AzureResourceItem' for type AzureResourceProtectionIntent. Set to 'AzureWorkloadSQLAutoProtectionIntent' for type AzureWorkloadSQLAutoProtectionIntent.	'AzureResourceItem' 'AzureWorkloadSQLAutoProtectionIntent' (required)
protectionState	Backup state of this backup item.	'Invalid' 'NotProtected' 'Protected' 'Protecting' 'ProtectionFailed'
sourceResourceId	ARM ID of the resource to be backed up.	string

ResourceTags

Name	Description	Value

Terraform (AzAPI provider) resource definition

The vaults/backupFabrics/backupProtectionIntent resource type can be deployed with operations that target:

• Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-04-01"
  name = "string"
  eTag = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      backupManagementType = "string"
      itemId = "string"
      policyId = "string"
      protectionState = "string"
      sourceResourceId = "string"
      protectionIntentItemType = "string"
      // For remaining properties, see ProtectionIntent objects
    }
  })
}

ProtectionIntent objects

Set the protectionIntentItemType property to specify the type of object.

For AzureResourceItem, use:

{
  friendlyName = "string"
  protectionIntentItemType = "AzureResourceItem"
}

For AzureWorkloadSQLAutoProtectionIntent, use:

{
  protectionIntentItemType = "AzureWorkloadSQLAutoProtectionIntent"
  workloadItemType = "string"
}

Property values

AzureResourceProtectionIntent

Name	Description	Value
friendlyName	Friendly name of the VM represented by this backup item.	string
protectionIntentItemType	backup protectionIntent type.	'AzureResourceItem' (required)

AzureWorkloadSQLAutoProtectionIntent

Name	Description	Value
protectionIntentItemType	backup protectionIntent type.	'AzureWorkloadSQLAutoProtectionIntent' (required)
workloadItemType	Workload item type of the item for which intent is to be set	'Invalid' 'SAPAseDatabase' 'SAPAseSystem' 'SAPHanaDatabase' 'SAPHanaSystem' 'SQLDataBase' 'SQLInstance'

Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent

Name	Description	Value
eTag	Optional ETag.	string
location	Resource location.	string
name	The resource name	string (required)
parent_id	The ID of the resource that is the parent for this resource.	ID for resource of type: vaults/backupFabrics
properties	ProtectionIntentResource properties	ProtectionIntent
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2021-04-01"

ProtectionIntent

Name	Description	Value
backupManagementType	Type of backup management for the backed up item.	'AzureBackupServer' 'AzureIaasVM' 'AzureSql' 'AzureStorage' 'AzureWorkload' 'DefaultBackup' 'DPM' 'Invalid' 'MAB'
itemId	ID of the item which is getting protected, In case of Azure Vm , it is ProtectedItemId	string
policyId	ID of the backup policy with which this item is backed up.	string
protectionIntentItemType	Set to 'AzureResourceItem' for type AzureResourceProtectionIntent. Set to 'AzureWorkloadSQLAutoProtectionIntent' for type AzureWorkloadSQLAutoProtectionIntent.	'AzureResourceItem' 'AzureWorkloadSQLAutoProtectionIntent' (required)
protectionState	Backup state of this backup item.	'Invalid' 'NotProtected' 'Protected' 'Protecting' 'ProtectionFailed'
sourceResourceId	ARM ID of the resource to be backed up.	string

ResourceTags

Name	Description	Value