Microsoft.RecoveryServices vaults/backupFabrics/backupProtectionIntent 2024-04-01
- Latest
- 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@2024-04-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
parent: resourceSymbolicName
eTag: 'string'
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:
protectionIntentItemType: 'AzureResourceItem'
friendlyName: 'string'
For AzureWorkloadContainerAutoProtectionIntent, use:
protectionIntentItemType: 'AzureWorkloadContainerAutoProtectionIntent'
For AzureWorkloadSQLAutoProtectionIntent, use:
protectionIntentItemType: 'AzureWorkloadSQLAutoProtectionIntent'
workloadItemType: 'string'
Property values
vaults/backupFabrics/backupProtectionIntent
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| location | Resource location. | string |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| 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: backupFabrics |
| eTag | Optional ETag. | string |
| properties | ProtectionIntentResource properties | ProtectionIntent |
ProtectionIntent
| Name | Description | Value |
|---|---|---|
| backupManagementType | Type of backup management for the backed up item. | 'AzureBackupServer' 'AzureIaasVM' 'AzureSql' 'AzureStorage' 'AzureWorkload' 'DPM' 'DefaultBackup' '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 |
| protectionState | Backup state of this backup item. | 'Invalid' 'NotProtected' 'Protected' 'Protecting' 'ProtectionFailed' |
| sourceResourceId | ARM ID of the resource to be backed up. | string |
| protectionIntentItemType | Set the object type | AzureResourceItem AzureWorkloadContainerAutoProtectionIntent AzureWorkloadSQLAutoProtectionIntent (required) |
AzureResourceProtectionIntent
| Name | Description | Value |
|---|---|---|
| protectionIntentItemType | backup protectionIntent type. | 'AzureResourceItem' (required) |
| friendlyName | Friendly name of the VM represented by this backup item. | string |
AzureWorkloadContainerAutoProtectionIntent
| Name | Description | Value |
|---|---|---|
| protectionIntentItemType | backup protectionIntent type. | 'AzureWorkloadContainerAutoProtectionIntent' (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' 'SAPHanaDBInstance' 'SAPHanaDatabase' 'SAPHanaSystem' 'SQLDataBase' 'SQLInstance' |
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": "2024-04-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"eTag": "string",
"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:
"protectionIntentItemType": "AzureResourceItem",
"friendlyName": "string"
For AzureWorkloadContainerAutoProtectionIntent, use:
"protectionIntentItemType": "AzureWorkloadContainerAutoProtectionIntent"
For AzureWorkloadSQLAutoProtectionIntent, use:
"protectionIntentItemType": "AzureWorkloadSQLAutoProtectionIntent",
"workloadItemType": "string"
Property values
vaults/backupFabrics/backupProtectionIntent
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent' |
| apiVersion | The resource api version | '2024-04-01' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| location | Resource location. | string |
| tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
| eTag | Optional ETag. | string |
| properties | ProtectionIntentResource properties | ProtectionIntent |
ProtectionIntent
| Name | Description | Value |
|---|---|---|
| backupManagementType | Type of backup management for the backed up item. | 'AzureBackupServer' 'AzureIaasVM' 'AzureSql' 'AzureStorage' 'AzureWorkload' 'DPM' 'DefaultBackup' '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 |
| protectionState | Backup state of this backup item. | 'Invalid' 'NotProtected' 'Protected' 'Protecting' 'ProtectionFailed' |
| sourceResourceId | ARM ID of the resource to be backed up. | string |
| protectionIntentItemType | Set the object type | AzureResourceItem AzureWorkloadContainerAutoProtectionIntent AzureWorkloadSQLAutoProtectionIntent (required) |
AzureResourceProtectionIntent
| Name | Description | Value |
|---|---|---|
| protectionIntentItemType | backup protectionIntent type. | 'AzureResourceItem' (required) |
| friendlyName | Friendly name of the VM represented by this backup item. | string |
AzureWorkloadContainerAutoProtectionIntent
| Name | Description | Value |
|---|---|---|
| protectionIntentItemType | backup protectionIntent type. | 'AzureWorkloadContainerAutoProtectionIntent' (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' 'SAPHanaDBInstance' 'SAPHanaDatabase' 'SAPHanaSystem' 'SQLDataBase' 'SQLInstance' |
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@2024-04-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
backupManagementType = "string"
itemId = "string"
policyId = "string"
protectionState = "string"
sourceResourceId = "string"
protectionIntentItemType = "string"
// For remaining properties, see ProtectionIntent objects
}
eTag = "string"
})
}
ProtectionIntent objects
Set the protectionIntentItemType property to specify the type of object.
For AzureResourceItem, use:
protectionIntentItemType = "AzureResourceItem"
friendlyName = "string"
For AzureWorkloadContainerAutoProtectionIntent, use:
protectionIntentItemType = "AzureWorkloadContainerAutoProtectionIntent"
For AzureWorkloadSQLAutoProtectionIntent, use:
protectionIntentItemType = "AzureWorkloadSQLAutoProtectionIntent"
workloadItemType = "string"
Property values
vaults/backupFabrics/backupProtectionIntent
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.RecoveryServices/vaults/backupFabrics/backupProtectionIntent@2024-04-01" |
| name | The resource name | string (required) |
| location | Resource location. | string |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: backupFabrics |
| tags | Resource tags. | Dictionary of tag names and values. |
| eTag | Optional ETag. | string |
| properties | ProtectionIntentResource properties | ProtectionIntent |
ProtectionIntent
| Name | Description | Value |
|---|---|---|
| backupManagementType | Type of backup management for the backed up item. | "AzureBackupServer" "AzureIaasVM" "AzureSql" "AzureStorage" "AzureWorkload" "DPM" "DefaultBackup" "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 |
| protectionState | Backup state of this backup item. | "Invalid" "NotProtected" "Protected" "Protecting" "ProtectionFailed" |
| sourceResourceId | ARM ID of the resource to be backed up. | string |
| protectionIntentItemType | Set the object type | AzureResourceItem AzureWorkloadContainerAutoProtectionIntent AzureWorkloadSQLAutoProtectionIntent (required) |
AzureResourceProtectionIntent
| Name | Description | Value |
|---|---|---|
| protectionIntentItemType | backup protectionIntent type. | "AzureResourceItem" (required) |
| friendlyName | Friendly name of the VM represented by this backup item. | string |
AzureWorkloadContainerAutoProtectionIntent
| Name | Description | Value |
|---|---|---|
| protectionIntentItemType | backup protectionIntent type. | "AzureWorkloadContainerAutoProtectionIntent" (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" "SAPHanaDBInstance" "SAPHanaDatabase" "SAPHanaSystem" "SQLDataBase" "SQLInstance" |