Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2025-07-01
- 2025-02-01
- 2025-01-01
- 2024-04-01
- 2024-03-01
- 2024-02-01-preview
- 2023-12-01
- 2023-11-01
- 2023-08-01-preview
- 2023-06-01-preview
- 2023-05-01
- 2023-04-01-preview
- 2023-01-01
- 2022-12-01
- 2022-11-01-preview
- 2022-10-01-preview
- 2022-09-01-preview
- 2022-05-01
- 2022-04-01
- 2022-03-31-preview
- 2022-03-01
- 2022-02-01-preview
- 2022-01-01
- 2021-12-01-preview
- 2021-10-01-preview
- 2021-07-01
- 2021-06-01-preview
- 2021-02-01-preview
- 2021-01-01
Bicep resource definition
The backupVaults 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.DataProtection/backupVaults resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.DataProtection/backupVaults@2023-05-01' = {
eTag: 'string'
identity: {
type: 'string'
userAssignedIdentities: {
{customized property}: {}
}
}
location: 'string'
name: 'string'
properties: {
featureSettings: {
crossRegionRestoreSettings: {
state: 'string'
}
crossSubscriptionRestoreSettings: {
state: 'string'
}
}
monitoringSettings: {
azureMonitorAlertSettings: {
alertsForAllJobFailures: 'string'
}
}
securitySettings: {
immutabilitySettings: {
state: 'string'
}
softDeleteSettings: {
retentionDurationInDays: int
state: 'string'
}
}
storageSettings: [
{
datastoreType: 'string'
type: 'string'
}
]
}
tags: {
{customized property}: 'string'
}
}
Property Values
Microsoft.DataProtection/backupVaults
| Name | Description | Value |
|---|---|---|
| eTag | Optional ETag. | string |
| identity | Input Managed Identity Details | DppIdentityDetails |
| location | Resource location. | string |
| name | The resource name | string (required) |
| properties | BackupVaultResource properties | BackupVault (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
AzureMonitorAlertSettings
| Name | Description | Value |
|---|---|---|
| alertsForAllJobFailures | 'Disabled' 'Enabled' |
BackupVault
| Name | Description | Value |
|---|---|---|
| featureSettings | Feature Settings | FeatureSettings |
| monitoringSettings | Monitoring Settings | MonitoringSettings |
| securitySettings | Security Settings | SecuritySettings |
| storageSettings | Storage Settings | StorageSetting[] (required) |
CrossRegionRestoreSettings
| Name | Description | Value |
|---|---|---|
| state | CrossRegionRestore state | 'Disabled' 'Enabled' |
CrossSubscriptionRestoreSettings
| Name | Description | Value |
|---|---|---|
| state | CrossSubscriptionRestore state | 'Disabled' 'Enabled' 'PermanentlyDisabled' |
DppBaseTrackedResourceTags
| Name | Description | Value |
|---|
DppIdentityDetails
| Name | Description | Value |
|---|---|---|
| type | The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None | string |
| userAssignedIdentities | Gets or sets the user assigned identities. | DppIdentityDetailsUserAssignedIdentities |
DppIdentityDetailsUserAssignedIdentities
| Name | Description | Value |
|---|
FeatureSettings
| Name | Description | Value |
|---|---|---|
| crossRegionRestoreSettings | CrossRegionRestoreSettings | |
| crossSubscriptionRestoreSettings | CrossSubscriptionRestore Settings | CrossSubscriptionRestoreSettings |
ImmutabilitySettings
| Name | Description | Value |
|---|---|---|
| state | Immutability state | 'Disabled' 'Locked' 'Unlocked' |
MonitoringSettings
| Name | Description | Value |
|---|---|---|
| azureMonitorAlertSettings | Settings for Azure Monitor based alerts | AzureMonitorAlertSettings |
SecuritySettings
| Name | Description | Value |
|---|---|---|
| immutabilitySettings | Immutability Settings at vault level | ImmutabilitySettings |
| softDeleteSettings | Soft delete related settings | SoftDeleteSettings |
SoftDeleteSettings
| Name | Description | Value |
|---|---|---|
| retentionDurationInDays | Soft delete retention duration | int |
| state | State of soft delete | 'AlwaysOn' 'Off' 'On' |
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' |
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Data Protection Backup Vault | AVM Resource Module for Data Protection Backup Vault |
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Create Backup Vault | Simple template that creates a Backup Vault |
| Create Disk & enable protection via Backup Vault | Template that creates a disk and enables protection via Backup Vault |
| Create MySQL Flexible Server & enable protection via Backup Vault | Template that creates a MySQL Flexible Server and enables protection via Backup Vault |
| Create PgFlex server & enable protection via Backup Vault | Template that creates a PostgreSQL Flexible Server and enables protection via Backup Vault |
| Create Storage Account & enable protection via Backup Vault | Template that creates storage account and enable operational and vaulted backup via Backup Vault |
ARM template resource definition
The backupVaults 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.DataProtection/backupVaults resource, add the following JSON to your template.
{
"type": "Microsoft.DataProtection/backupVaults",
"apiVersion": "2023-05-01",
"name": "string",
"eTag": "string",
"identity": {
"type": "string",
"userAssignedIdentities": {
"{customized property}": {
}
}
},
"location": "string",
"properties": {
"featureSettings": {
"crossRegionRestoreSettings": {
"state": "string"
},
"crossSubscriptionRestoreSettings": {
"state": "string"
}
},
"monitoringSettings": {
"azureMonitorAlertSettings": {
"alertsForAllJobFailures": "string"
}
},
"securitySettings": {
"immutabilitySettings": {
"state": "string"
},
"softDeleteSettings": {
"retentionDurationInDays": "int",
"state": "string"
}
},
"storageSettings": [
{
"datastoreType": "string",
"type": "string"
}
]
},
"tags": {
"{customized property}": "string"
}
}
Property Values
Microsoft.DataProtection/backupVaults
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2023-05-01' |
| eTag | Optional ETag. | string |
| identity | Input Managed Identity Details | DppIdentityDetails |
| location | Resource location. | string |
| name | The resource name | string (required) |
| properties | BackupVaultResource properties | BackupVault (required) |
| tags | Resource tags | Dictionary of tag names and values. See Tags in templates |
| type | The resource type | 'Microsoft.DataProtection/backupVaults' |
AzureMonitorAlertSettings
| Name | Description | Value |
|---|---|---|
| alertsForAllJobFailures | 'Disabled' 'Enabled' |
BackupVault
| Name | Description | Value |
|---|---|---|
| featureSettings | Feature Settings | FeatureSettings |
| monitoringSettings | Monitoring Settings | MonitoringSettings |
| securitySettings | Security Settings | SecuritySettings |
| storageSettings | Storage Settings | StorageSetting[] (required) |
CrossRegionRestoreSettings
| Name | Description | Value |
|---|---|---|
| state | CrossRegionRestore state | 'Disabled' 'Enabled' |
CrossSubscriptionRestoreSettings
| Name | Description | Value |
|---|---|---|
| state | CrossSubscriptionRestore state | 'Disabled' 'Enabled' 'PermanentlyDisabled' |
DppBaseTrackedResourceTags
| Name | Description | Value |
|---|
DppIdentityDetails
| Name | Description | Value |
|---|---|---|
| type | The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None | string |
| userAssignedIdentities | Gets or sets the user assigned identities. | DppIdentityDetailsUserAssignedIdentities |
DppIdentityDetailsUserAssignedIdentities
| Name | Description | Value |
|---|
FeatureSettings
| Name | Description | Value |
|---|---|---|
| crossRegionRestoreSettings | CrossRegionRestoreSettings | |
| crossSubscriptionRestoreSettings | CrossSubscriptionRestore Settings | CrossSubscriptionRestoreSettings |
ImmutabilitySettings
| Name | Description | Value |
|---|---|---|
| state | Immutability state | 'Disabled' 'Locked' 'Unlocked' |
MonitoringSettings
| Name | Description | Value |
|---|---|---|
| azureMonitorAlertSettings | Settings for Azure Monitor based alerts | AzureMonitorAlertSettings |
SecuritySettings
| Name | Description | Value |
|---|---|---|
| immutabilitySettings | Immutability Settings at vault level | ImmutabilitySettings |
| softDeleteSettings | Soft delete related settings | SoftDeleteSettings |
SoftDeleteSettings
| Name | Description | Value |
|---|---|---|
| retentionDurationInDays | Soft delete retention duration | int |
| state | State of soft delete | 'AlwaysOn' 'Off' 'On' |
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' |
UserAssignedIdentity
| Name | Description | Value |
|---|
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
Create Backup Vault |
Simple template that creates a Backup Vault |
| Create Disk & enable protection via Backup Vault |
Template that creates a disk and enables protection via Backup Vault |
| Create MySQL Flexible Server & enable protection via Backup Vault |
Template that creates a MySQL Flexible Server and enables protection via Backup Vault |
| Create PgFlex server & enable protection via Backup Vault |
Template that creates a PostgreSQL Flexible Server and enables protection via Backup Vault |
| Create Storage Account & enable protection via Backup Vault |
Template that creates storage account and enable operational and vaulted backup via Backup Vault |
Terraform (AzAPI provider) resource definition
The backupVaults 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.DataProtection/backupVaults resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.DataProtection/backupVaults@2023-05-01"
name = "string"
parent_id = "string"
identity {
type = "string"
identity_ids = [
"string"
]
}
location = "string"
tags = {
{customized property} = "string"
}
body = {
eTag = "string"
properties = {
featureSettings = {
crossRegionRestoreSettings = {
state = "string"
}
crossSubscriptionRestoreSettings = {
state = "string"
}
}
monitoringSettings = {
azureMonitorAlertSettings = {
alertsForAllJobFailures = "string"
}
}
securitySettings = {
immutabilitySettings = {
state = "string"
}
softDeleteSettings = {
retentionDurationInDays = int
state = "string"
}
}
storageSettings = [
{
datastoreType = "string"
type = "string"
}
]
}
}
}
Property Values
Microsoft.DataProtection/backupVaults
| Name | Description | Value |
|---|---|---|
| eTag | Optional ETag. | string |
| identity | Input Managed Identity Details | DppIdentityDetails |
| location | Resource location. | string |
| name | The resource name | string (required) |
| properties | BackupVaultResource properties | BackupVault (required) |
| tags | Resource tags | Dictionary of tag names and values. |
| type | The resource type | "Microsoft.DataProtection/backupVaults@2023-05-01" |
AzureMonitorAlertSettings
| Name | Description | Value |
|---|---|---|
| alertsForAllJobFailures | 'Disabled' 'Enabled' |
BackupVault
| Name | Description | Value |
|---|---|---|
| featureSettings | Feature Settings | FeatureSettings |
| monitoringSettings | Monitoring Settings | MonitoringSettings |
| securitySettings | Security Settings | SecuritySettings |
| storageSettings | Storage Settings | StorageSetting[] (required) |
CrossRegionRestoreSettings
| Name | Description | Value |
|---|---|---|
| state | CrossRegionRestore state | 'Disabled' 'Enabled' |
CrossSubscriptionRestoreSettings
| Name | Description | Value |
|---|---|---|
| state | CrossSubscriptionRestore state | 'Disabled' 'Enabled' 'PermanentlyDisabled' |
DppBaseTrackedResourceTags
| Name | Description | Value |
|---|
DppIdentityDetails
| Name | Description | Value |
|---|---|---|
| type | The identityType which can be either SystemAssigned, UserAssigned, 'SystemAssigned,UserAssigned' or None | string |
| userAssignedIdentities | Gets or sets the user assigned identities. | DppIdentityDetailsUserAssignedIdentities |
DppIdentityDetailsUserAssignedIdentities
| Name | Description | Value |
|---|
FeatureSettings
| Name | Description | Value |
|---|---|---|
| crossRegionRestoreSettings | CrossRegionRestoreSettings | |
| crossSubscriptionRestoreSettings | CrossSubscriptionRestore Settings | CrossSubscriptionRestoreSettings |
ImmutabilitySettings
| Name | Description | Value |
|---|---|---|
| state | Immutability state | 'Disabled' 'Locked' 'Unlocked' |
MonitoringSettings
| Name | Description | Value |
|---|---|---|
| azureMonitorAlertSettings | Settings for Azure Monitor based alerts | AzureMonitorAlertSettings |
SecuritySettings
| Name | Description | Value |
|---|---|---|
| immutabilitySettings | Immutability Settings at vault level | ImmutabilitySettings |
| softDeleteSettings | Soft delete related settings | SoftDeleteSettings |
SoftDeleteSettings
| Name | Description | Value |
|---|---|---|
| retentionDurationInDays | Soft delete retention duration | int |
| state | State of soft delete | 'AlwaysOn' 'Off' 'On' |
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' |
UserAssignedIdentity
| Name | Description | Value |
|---|