Microsoft.RecoveryServices vaults 2022-01-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@2022-01-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: 'string'
    family: 'string'
    name: 'string'
    size: 'string'
    tier: 'string'
  }
  etag: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  properties: {
    encryption: {
      infrastructureEncryption: 'string'
      kekIdentity: {
        userAssignedIdentity: 'string'
        useSystemAssignedIdentity: bool
      }
      keyVaultProperties: {
        keyUri: 'string'
      }
    }
    moveDetails: {}
    upgradeDetails: {}
  }
}

Property values

vaults

IdentityData

IdentityDataUserAssignedIdentities

UserIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

VaultProperties

VaultPropertiesEncryption

CmkKekIdentity

CmkKeyVaultProperties

VaultPropertiesMoveDetails

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

UpgradeDetails

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Sku

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
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
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 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.
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.
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 with default options	Simple template that creates a Recovery Services Vault.
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.
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
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.

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": "2022-01-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "string",
    "family": "string",
    "name": "string",
    "size": "string",
    "tier": "string"
  },
  "etag": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {}
    }
  },
  "properties": {
    "encryption": {
      "infrastructureEncryption": "string",
      "kekIdentity": {
        "userAssignedIdentity": "string",
        "useSystemAssignedIdentity": "bool"
      },
      "keyVaultProperties": {
        "keyUri": "string"
      }
    },
    "moveDetails": {},
    "upgradeDetails": {}
  }
}

Property values

vaults

IdentityData

IdentityDataUserAssignedIdentities

UserIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

VaultProperties

VaultPropertiesEncryption

CmkKekIdentity

CmkKeyVaultProperties

VaultPropertiesMoveDetails

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

UpgradeDetails

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Sku

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
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
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 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.
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.
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 with default options	Simple template that creates a Recovery Services Vault.
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.
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
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.

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@2022-01-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      encryption = {
        infrastructureEncryption = "string"
        kekIdentity = {
          userAssignedIdentity = "string"
          useSystemAssignedIdentity = bool
        }
        keyVaultProperties = {
          keyUri = "string"
        }
      }
      moveDetails = {}
      upgradeDetails = {}
    }
    sku = {
      capacity = "string"
      family = "string"
      name = "string"
      size = "string"
      tier = "string"
    }
    etag = "string"
  })
}

Property values

vaults

IdentityData

IdentityDataUserAssignedIdentities

UserIdentity

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

VaultProperties

VaultPropertiesEncryption

CmkKekIdentity

CmkKeyVaultProperties

VaultPropertiesMoveDetails

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

UpgradeDetails

This object doesn't contain any properties to set during deployment. All properties are ReadOnly.

Sku