Share via

Microsoft.DataProtection backupVaults 2022-03-01

Bicep resource definition

The backupVaults resource type can be deployed with operations that target:

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-03-01' = {
  eTag: 'string'
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    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

BackupVault

Name Description Value
storageSettings Storage Settings StorageSetting[] (required)

DppIdentityDetails

Name Description Value
type The identityType which can be either SystemAssigned or None string

DppTrackedResourceTags

Name Description Value

StorageSetting

Name Description Value
datastoreType Gets or sets the type of the datastore. 'ArchiveStore'
'SnapshotStore'
'VaultStore'
type Gets or sets the type. 'GeoRedundant'
'LocallyRedundant'

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:

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-03-01",
  "name": "string",
  "eTag": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "storageSettings": [
      {
        "datastoreType": "string",
        "type": "string"
      }
    ]
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.DataProtection/backupVaults

Name Description Value
apiVersion The api version '2022-03-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'

BackupVault

Name Description Value
storageSettings Storage Settings StorageSetting[] (required)

DppIdentityDetails

Name Description Value
type The identityType which can be either SystemAssigned or None string

DppTrackedResourceTags

Name Description Value

StorageSetting

Name Description Value
datastoreType Gets or sets the type of the datastore. 'ArchiveStore'
'SnapshotStore'
'VaultStore'
type Gets or sets the type. 'GeoRedundant'
'LocallyRedundant'

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Create Backup Vault

Deploy to Azure		 Simple template that creates a Backup Vault
Create Disk & enable protection via Backup Vault

Deploy to Azure		 Template that creates a disk and enables protection via Backup Vault
Create MySQL Flexible Server & enable protection via Backup Vault

Deploy to Azure		 Template that creates a MySQL Flexible Server and enables protection via Backup Vault
Create PgFlex server & enable protection via Backup Vault

Deploy to Azure		 Template that creates a PostgreSQL Flexible Server and enables protection via Backup Vault
Create Storage Account & enable protection via Backup Vault

Deploy to Azure		 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@2022-03-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    eTag = "string"
    properties = {
      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@2022-03-01"

BackupVault

Name Description Value
storageSettings Storage Settings StorageSetting[] (required)

DppIdentityDetails

Name Description Value
type The identityType which can be either SystemAssigned or None string

DppTrackedResourceTags

Name Description Value

StorageSetting

Name Description Value
datastoreType Gets or sets the type of the datastore. 'ArchiveStore'
'SnapshotStore'
'VaultStore'
type Gets or sets the type. 'GeoRedundant'
'LocallyRedundant'