Microsoft.RecoveryServices vaults 2016-06-01

• Latest
• 2024-10-01
• 2024-09-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-10
• 2022-08-01
• 2022-05-01
• 2022-04-01
• 2022-03-01
• 2022-02-01
• 2022-01-31-preview
• 2022-01-01
• 2021-12-01
• 2021-11-01-preview
• 2021-08-01
• 2021-07-01
• 2021-06-01
• 2021-04-01
• 2021-03-01
• 2021-02-10
• 2021-01-01
• 2020-10-01
• 2020-02-02
• 2016-06-01

Bicep resource definition

The vaults 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 resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.RecoveryServices/vaults@2016-06-01' = {
  eTag: 'string'
  identity: {
    type: 'string'
  }
  location: 'string'
  name: 'string'
  properties: {
    upgradeDetails: {}
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

IdentityData

Name	Description	Value
type	The identity type.	'None' 'SystemAssigned' (required)

Microsoft.RecoveryServices/vaults

Name	Description	Value
eTag	Optional ETag.	string
identity	Identity for the resource.	IdentityData
location	Resource location.	string (required)
name	The resource name	string (required)
properties	Properties of the vault.	VaultProperties
sku	Identifies the unique system identifier for each Azure resource.	Sku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates

Sku

Name	Description	Value
name	The Sku name.	'RS0' 'Standard' (required)

TrackedResourceTags

Name	Description	Value

UpgradeDetails

Name	Description	Value

VaultProperties

Name	Description	Value
upgradeDetails	Details for upgrading vault.	UpgradeDetails

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module	Description
Recovery Services Vault	AVM Resource Module for Recovery Services Vault

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File	Description
Azure Backup for Workload in Azure Virtual Machines	This template creates a Recovery Services Vault and a Workload specific Backup Policy. Registers VM with Backup service and Configures Protection
Backup existing File Share using Recovery Services (Daily)	This template configures protection for an existing File Share present in an existing Storage Account. It creates a new or uses an existing Recovery Services Vault and Backup Policy based on the set parameter values.
Backup existing File Share using Recovery Services (hourly)	This template configures protection with hourly frequency for an existing File Share present in an existing Storage Account. It creates a new or uses an existing Recovery Services Vault and Backup Policy based on the set parameter values.
Backup Resource Manager VMs using Recovery Services vault	This template will use existing recovery services vault and existing backup policy, and configures backup of multiple Resource Manager VMs that belong to same resource group
Create a Recovery Services vault with advanced options	This template creates a Recovery Services vault that will be used further for Backup and Site Recovery.
Create AVD with FSLogix and AD DS Join	This template allows you to create Azure Virtual Desktop resources such as host pool, application group, workspace, FSLogix storage account, file share, recovery service vault for file share backup a test session host, its extensions with Microsoft Entra ID join pr Active directory domain join.
Create Azure VM Replication and Disaster Recovery	This template allows you to create Azure Virtual machine site replication disaster recovery.
Create Daily Backup Policy for RS Vault to protect IaaSVMs	This template creates Recovery service vault and a Daily Backup Policy that can be used to protect classic and ARM based IaaS VMs.
Create Recovery Services Vault and Enable Diagnostics	This template creates a Recovery Services Vault and enables diagnostics for Azure Backup. This also deploys storage account and oms workspace.
Create Recovery Services Vault with backup policies	This template creates a Recovery Services Vault with backup policies and configure optional features such system identity, backup storage type, cross region restore and diagnostics logs and a delete lock.
Create Recovery Services Vault with default options	Simple template that creates a Recovery Services Vault.
Create Weekly Backup Policy for RS Vault to protect IaaSVMs	This template creates Recovery service vault and a Daily Backup Policy that can be used to protect classic and ARM based IaaS VMs.
Deploy a Windows VM and enable backup using Azure Backup	This template allows you to deploy a Windows VM and Recovery Services Vault configured with the DefaultPolicy for Protection.

ARM template resource definition

The vaults 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 resource, add the following JSON to your template.

{
  "type": "Microsoft.RecoveryServices/vaults",
  "apiVersion": "2016-06-01",
  "name": "string",
  "eTag": "string",
  "identity": {
    "type": "string"
  },
  "location": "string",
  "properties": {
    "upgradeDetails": {
    }
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

IdentityData

Name	Description	Value
type	The identity type.	'None' 'SystemAssigned' (required)

Microsoft.RecoveryServices/vaults

Name	Description	Value
apiVersion	The api version	'2016-06-01'
eTag	Optional ETag.	string
identity	Identity for the resource.	IdentityData
location	Resource location.	string (required)
name	The resource name	string (required)
properties	Properties of the vault.	VaultProperties
sku	Identifies the unique system identifier for each Azure resource.	Sku
tags	Resource tags	Dictionary of tag names and values. See Tags in templates
type	The resource type	'Microsoft.RecoveryServices/vaults'

Sku

Name	Description	Value
name	The Sku name.	'RS0' 'Standard' (required)

TrackedResourceTags

Name	Description	Value

UpgradeDetails

Name	Description	Value

VaultProperties

Name	Description	Value
upgradeDetails	Details for upgrading vault.	UpgradeDetails

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template	Description
Azure Backup for Workload in Azure Virtual Machines	This template creates a Recovery Services Vault and a Workload specific Backup Policy. Registers VM with Backup service and Configures Protection
Backup existing File Share using Recovery Services (Daily)	This template configures protection for an existing File Share present in an existing Storage Account. It creates a new or uses an existing Recovery Services Vault and Backup Policy based on the set parameter values.
Backup existing File Share using Recovery Services (hourly)	This template configures protection with hourly frequency for an existing File Share present in an existing Storage Account. It creates a new or uses an existing Recovery Services Vault and Backup Policy based on the set parameter values.
Backup Resource Manager VMs using Recovery Services vault	This template will use existing recovery services vault and existing backup policy, and configures backup of multiple Resource Manager VMs that belong to same resource group
Create a Recovery Services vault with advanced options	This template creates a Recovery Services vault that will be used further for Backup and Site Recovery.
Create AVD with FSLogix and AD DS Join	This template allows you to create Azure Virtual Desktop resources such as host pool, application group, workspace, FSLogix storage account, file share, recovery service vault for file share backup a test session host, its extensions with Microsoft Entra ID join pr Active directory domain join.
Create Azure VM Replication and Disaster Recovery	This template allows you to create Azure Virtual machine site replication disaster recovery.
Create Daily Backup Policy for RS Vault to protect IaaSVMs	This template creates Recovery service vault and a Daily Backup Policy that can be used to protect classic and ARM based IaaS VMs.
Create Recovery Services Vault and Enable Diagnostics	This template creates a Recovery Services Vault and enables diagnostics for Azure Backup. This also deploys storage account and oms workspace.
Create Recovery Services Vault with backup policies	This template creates a Recovery Services Vault with backup policies and configure optional features such system identity, backup storage type, cross region restore and diagnostics logs and a delete lock.
Create Recovery Services Vault with default options	Simple template that creates a Recovery Services Vault.
Create Weekly Backup Policy for RS Vault to protect IaaSVMs	This template creates Recovery service vault and a Daily Backup Policy that can be used to protect classic and ARM based IaaS VMs.
Deploy a Windows VM and enable backup using Azure Backup	This template allows you to deploy a Windows VM and Recovery Services Vault configured with the DefaultPolicy for Protection.
IBM Cloud Pak for Data on Azure	This template deploys an Openshift cluster on Azure with all the required resources, infrastructure and then deploys IBM Cloud Pak for Data along with the add-ons that user chooses.
Openshift Container Platform 4.3	Openshift Container Platform 4.3

Terraform (AzAPI provider) resource definition

The vaults 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 resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults@2016-06-01"
  name = "string"
  eTag = "string"
  identity = {
    type = "string"
  }
  location = "string"
  sku = {
    name = "string"
  }
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      upgradeDetails = {
      }
    }
  })
}

Property Values

IdentityData

Name	Description	Value
type	The identity type.	'None' 'SystemAssigned' (required)

Microsoft.RecoveryServices/vaults

Name	Description	Value
eTag	Optional ETag.	string
identity	Identity for the resource.	IdentityData
location	Resource location.	string (required)
name	The resource name	string (required)
properties	Properties of the vault.	VaultProperties
sku	Identifies the unique system identifier for each Azure resource.	Sku
tags	Resource tags	Dictionary of tag names and values.
type	The resource type	"Microsoft.RecoveryServices/vaults@2016-06-01"

Sku

Name	Description	Value
name	The Sku name.	'RS0' 'Standard' (required)

TrackedResourceTags

Name	Description	Value

UpgradeDetails

Name	Description	Value

VaultProperties

Name	Description	Value
upgradeDetails	Details for upgrading vault.	UpgradeDetails

Usage Examples

Azure Verified Modules

The following Azure Verified Modules can be used to deploy this resource type.

Module	Description
Recovery Services Vault	AVM Resource Module for Recovery Services Vault