Microsoft.RecoveryServices vaults/backupstorageconfig 2021-11-15

Bicep resource definition

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

resource symbolicname 'Microsoft.RecoveryServices/vaults/backupstorageconfig@2021-11-15' = {
  parent: resourceSymbolicName
  eTag: 'string'
  location: 'string'
  name: 'vaultstorageconfig'
  properties: {
    crossRegionRestoreFlag: bool
    storageModelType: 'string'
    storageType: 'string'
    storageTypeState: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

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'

Microsoft.RecoveryServices/vaults/backupstorageconfig

Name Description Value
eTag Optional ETag. string
location Resource location. string
name The resource name 'vaultstorageconfig' (required)
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
properties BackupResourceConfigResource properties BackupResourceConfig
tags Resource tags Dictionary of tag names and values. See Tags in templates

ResourceTags

Name Description Value

Quickstart samples

The following quickstart samples deploy this resource type.

Bicep File Description
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 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.

ARM template resource definition

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

{
  "type": "Microsoft.RecoveryServices/vaults/backupstorageconfig",
  "apiVersion": "2021-11-15",
  "name": "string",
  "eTag": "string",
  "location": "string",
  "properties": {
    "crossRegionRestoreFlag": "bool",
    "storageModelType": "string",
    "storageType": "string",
    "storageTypeState": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

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'

Microsoft.RecoveryServices/vaults/backupstorageconfig

Name Description Value
apiVersion The api version '2021-11-15'
eTag Optional ETag. string
location Resource location. string
name The resource name 'vaultstorageconfig' (required)
properties BackupResourceConfigResource properties BackupResourceConfig
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.RecoveryServices/vaults/backupstorageconfig'

ResourceTags

Name Description Value

Quickstart templates

The following quickstart templates deploy this resource type.

Template Description
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.
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.

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.RecoveryServices/vaults/backupstorageconfig@2021-11-15"
  name = "string"
  eTag = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      crossRegionRestoreFlag = bool
      storageModelType = "string"
      storageType = "string"
      storageTypeState = "string"
    }
  })
}

Property values

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'

Microsoft.RecoveryServices/vaults/backupstorageconfig

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

ResourceTags

Name Description Value