Microsoft.RecoveryServices vaults/backupstorageconfig 2018-12-20

  • Article

Bicep resource definition

The vaults/backupstorageconfig resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RecoveryServices/vaults/backupstorageconfig resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.RecoveryServices/vaults/backupstorageconfig@2018-12-20' = {
  name: 'vaultstorageconfig'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  parent: resourceSymbolicName
  eTag: 'string'
  properties: {
    crossRegionRestoreFlag: bool
    storageModelType: 'string'
    storageType: 'string'
    storageTypeState: 'string'
  }
}

Property values

vaults/backupstorageconfig

Name Description Value
name The resource name

See how to set names and types for child resources in Bicep.		 'vaultstorageconfig'
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: vaults
eTag Optional ETag. string
properties BackupResourceConfigResource properties BackupResourceConfig

BackupResourceConfig

Name Description Value
crossRegionRestoreFlag Opt in details of Cross Region Restore feature. bool
storageModelType Storage type 'GeoRedundant'
'Invalid'
'LocallyRedundant'
'ReadAccessGeoZoneRedundant'
'ZoneRedundant'
storageType Storage type. 'GeoRedundant'
'Invalid'
'LocallyRedundant'
'ReadAccessGeoZoneRedundant'
'ZoneRedundant'
storageTypeState Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. 'Invalid'
'Locked'
'Unlocked'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Recovery Services Vault with backup policies

Deploy to Azure		 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 a Recovery Services vault with advanced options

Deploy to Azure		 This template creates a Recovery Services vault that will be used further for Backup and Site Recovery.

ARM template resource definition

The vaults/backupstorageconfig resource type can be deployed to:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.RecoveryServices/vaults/backupstorageconfig resource, add the following JSON to your template.

{
  "type": "Microsoft.RecoveryServices/vaults/backupstorageconfig",
  "apiVersion": "2018-12-20",
  "name": "vaultstorageconfig",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "eTag": "string",
  "properties": {
    "crossRegionRestoreFlag": "bool",
    "storageModelType": "string",
    "storageType": "string",
    "storageTypeState": "string"
  }
}

Property values

vaults/backupstorageconfig

Name Description Value
type The resource type 'Microsoft.RecoveryServices/vaults/backupstorageconfig'
apiVersion The resource api version '2018-12-20'
name The resource name

See how to set names and types for child resources in JSON ARM templates.		 'vaultstorageconfig'
location Resource location. string
tags Resource tags. Dictionary of tag names and values. See Tags in templates
eTag Optional ETag. string
properties BackupResourceConfigResource properties BackupResourceConfig

BackupResourceConfig

Name Description Value
crossRegionRestoreFlag Opt in details of Cross Region Restore feature. bool
storageModelType Storage type 'GeoRedundant'
'Invalid'
'LocallyRedundant'
'ReadAccessGeoZoneRedundant'
'ZoneRedundant'
storageType Storage type. 'GeoRedundant'
'Invalid'
'LocallyRedundant'
'ReadAccessGeoZoneRedundant'
'ZoneRedundant'
storageTypeState Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. 'Invalid'
'Locked'
'Unlocked'

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
Create Recovery Services Vault with backup policies

Deploy to Azure		 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 a Recovery Services vault with advanced options

Deploy to Azure		 This template creates a Recovery Services vault that will be used further for Backup and Site Recovery.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/backupstorageconfig@2018-12-20"
  name = "vaultstorageconfig"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      crossRegionRestoreFlag = bool
      storageModelType = "string"
      storageType = "string"
      storageTypeState = "string"
    }
    eTag = "string"
  })
}

Property values

vaults/backupstorageconfig

Name Description Value
type The resource type "Microsoft.RecoveryServices/vaults/backupstorageconfig@2018-12-20"
name The resource name "vaultstorageconfig"
location Resource location. string
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: vaults
tags Resource tags. Dictionary of tag names and values.
eTag Optional ETag. string
properties BackupResourceConfigResource properties BackupResourceConfig

BackupResourceConfig

Name Description Value
crossRegionRestoreFlag Opt in details of Cross Region Restore feature. bool
storageModelType Storage type "GeoRedundant"
"Invalid"
"LocallyRedundant"
"ReadAccessGeoZoneRedundant"
"ZoneRedundant"
storageType Storage type. "GeoRedundant"
"Invalid"
"LocallyRedundant"
"ReadAccessGeoZoneRedundant"
"ZoneRedundant"
storageTypeState Locked or Unlocked. Once a machine is registered against a resource, the storageTypeState is always Locked. "Invalid"
"Locked"
"Unlocked"