Microsoft.DataProtection backupVaults 2022-05-01
Bicep resource definition
The backupVaults resource type can be deployed to:
- 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.DataProtection/backupVaults resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DataProtection/backupVaults@2022-05-01' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
eTag: 'string'
identity: {
type: 'string'
}
properties: {
monitoringSettings: {
azureMonitorAlertSettings: {
alertsForAllJobFailures: 'string'
}
}
storageSettings: [
{
datastoreType: 'string'
type: 'string'
}
]
}
}
Property values
backupVaults
Name | Description | Value |
---|---|---|
name | The resource name | string (required) |
location | Resource location. | string |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
eTag | Optional ETag. | string |
identity | Input Managed Identity Details | DppIdentityDetails |
properties | BackupVaultResource properties | BackupVault (required) |
DppIdentityDetails
Name | Description | Value |
---|---|---|
type | The identityType which can be either SystemAssigned or None | string |
BackupVault
Name | Description | Value |
---|---|---|
monitoringSettings | Monitoring Settings | MonitoringSettings |
storageSettings | Storage Settings | StorageSetting[] (required) |
MonitoringSettings
Name | Description | Value |
---|---|---|
azureMonitorAlertSettings | Settings for Azure Monitor based alerts | AzureMonitorAlertSettings |
AzureMonitorAlertSettings
Name | Description | Value |
---|---|---|
alertsForAllJobFailures | 'Disabled' 'Enabled' |
StorageSetting
Name | Description | Value |
---|---|---|
datastoreType | Gets or sets the type of the datastore. | 'ArchiveStore' 'OperationalStore' 'VaultStore' |
type | Gets or sets the type. | 'GeoRedundant' 'LocallyRedundant' 'ZoneRedundant' |
Quickstart templates
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
Create Disk & enable protection via Backup Vault |
Template that creates a disk and enables protection via Backup Vault |
Create Storage Account & enable protection via Backup Vault |
Template that creates storage account and enable protection via Backup Vault |
Create Backup Vault |
Simple template that creates a Backup Vault |
ARM template resource definition
The backupVaults resource type can be deployed to:
- 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.DataProtection/backupVaults resource, add the following JSON to your template.
{
"type": "Microsoft.DataProtection/backupVaults",
"apiVersion": "2022-05-01",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"eTag": "string",
"identity": {
"type": "string"
},
"properties": {
"monitoringSettings": {
"azureMonitorAlertSettings": {
"alertsForAllJobFailures": "string"
}
},
"storageSettings": [
{
"datastoreType": "string",
"type": "string"
}
]
}
}
Property values
backupVaults
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.DataProtection/backupVaults' |
apiVersion | The resource api version | '2022-05-01' |
name | The resource name | string (required) |
location | Resource location. | string |
tags | Resource tags. | Dictionary of tag names and values. See Tags in templates |
eTag | Optional ETag. | string |
identity | Input Managed Identity Details | DppIdentityDetails |
properties | BackupVaultResource properties | BackupVault (required) |
DppIdentityDetails
Name | Description | Value |
---|---|---|
type | The identityType which can be either SystemAssigned or None | string |
BackupVault
Name | Description | Value |
---|---|---|
monitoringSettings | Monitoring Settings | MonitoringSettings |
storageSettings | Storage Settings | StorageSetting[] (required) |
MonitoringSettings
Name | Description | Value |
---|---|---|
azureMonitorAlertSettings | Settings for Azure Monitor based alerts | AzureMonitorAlertSettings |
AzureMonitorAlertSettings
Name | Description | Value |
---|---|---|
alertsForAllJobFailures | 'Disabled' 'Enabled' |
StorageSetting
Name | Description | Value |
---|---|---|
datastoreType | Gets or sets the type of the datastore. | 'ArchiveStore' 'OperationalStore' 'VaultStore' |
type | Gets or sets the type. | 'GeoRedundant' 'LocallyRedundant' 'ZoneRedundant' |
Quickstart templates
The following quickstart templates deploy this resource type.
Template | Description |
---|---|
Create Disk & enable protection via Backup Vault |
Template that creates a disk and enables protection via Backup Vault |
Create Storage Account & enable protection via Backup Vault |
Template that creates storage account and enable protection via Backup Vault |
Create Backup Vault |
Simple template that creates a Backup Vault |
Terraform (AzAPI provider) resource definition
The backupVaults resource type can be deployed to:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.DataProtection/backupVaults resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DataProtection/backupVaults@2022-05-01"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
identity {
type = "string"
}
body = jsonencode({
properties = {
monitoringSettings = {
azureMonitorAlertSettings = {
alertsForAllJobFailures = "string"
}
}
storageSettings = [
{
datastoreType = "string"
type = "string"
}
]
}
eTag = "string"
})
}
Property values
backupVaults
Name | Description | Value |
---|---|---|
type | The resource type | "Microsoft.DataProtection/backupVaults@2022-05-01" |
name | The resource name | string (required) |
location | Resource location. | string |
parent_id | To deploy to a resource group, use the ID of that resource group. | string (required) |
tags | Resource tags. | Dictionary of tag names and values. |
eTag | Optional ETag. | string |
identity | Input Managed Identity Details | DppIdentityDetails |
properties | BackupVaultResource properties | BackupVault (required) |
DppIdentityDetails
Name | Description | Value |
---|---|---|
type | The identityType which can be either SystemAssigned or None | string |
BackupVault
Name | Description | Value |
---|---|---|
monitoringSettings | Monitoring Settings | MonitoringSettings |
storageSettings | Storage Settings | StorageSetting[] (required) |
MonitoringSettings
Name | Description | Value |
---|---|---|
azureMonitorAlertSettings | Settings for Azure Monitor based alerts | AzureMonitorAlertSettings |
AzureMonitorAlertSettings
Name | Description | Value |
---|---|---|
alertsForAllJobFailures | "Disabled" "Enabled" |
StorageSetting
Name | Description | Value |
---|---|---|
datastoreType | Gets or sets the type of the datastore. | "ArchiveStore" "OperationalStore" "VaultStore" |
type | Gets or sets the type. | "GeoRedundant" "LocallyRedundant" "ZoneRedundant" |
Feedback
https://aka.ms/ContentUserFeedback.
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see:Submit and view feedback for