Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
- Latest
- 2025-08-01
- 2025-02-01
- 2025-01-01
- 2024-10-01
- 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-10
- 2022-08-01
- 2022-05-01
- 2022-04-01
- 2022-03-01
- 2022-02-01
- 2022-01-01
- 2021-12-01
- 2021-11-01
- 2021-10-01
- 2021-08-01
- 2021-07-01
- 2021-06-01
- 2021-04-01
- 2021-03-01
- 2021-02-10
- 2018-07-10
- 2018-01-10
- 2016-08-10
Bicep resource definition
The vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings 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/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2024-01-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
policyId: 'string'
providerSpecificInput: {
instanceType: 'string'
// For remaining properties, see ReplicationProviderSpecificContainerMappingInput objects
}
targetProtectionContainerId: 'string'
}
}
ReplicationProviderSpecificContainerMappingInput objects
Set the instanceType property to specify the type of object.
For A2A, use:
{
agentAutoUpdateStatus: 'string'
automationAccountArmId: 'string'
automationAccountAuthenticationType: 'string'
instanceType: 'A2A'
}
For VMwareCbt, use:
{
instanceType: 'VMwareCbt'
keyVaultId: 'string'
keyVaultUri: 'string'
serviceBusConnectionStringSecretName: 'string'
storageAccountId: 'string'
storageAccountSasSecretName: 'string'
targetLocation: 'string'
}
Property Values
Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (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/replicationFabrics/replicationProtectionContainers |
| properties | Configure protection input properties. | CreateProtectionContainerMappingInputPropertiesOrProtectionContainerMappingProperties |
A2AContainerMappingInput
| Name | Description | Value |
|---|---|---|
| agentAutoUpdateStatus | A value indicating whether the auto update is enabled. | 'Disabled' 'Enabled' |
| automationAccountArmId | The automation account arm id. | string |
| automationAccountAuthenticationType | A value indicating the type authentication to use for automation Account. | 'RunAsAccount' 'SystemAssignedIdentity' |
| instanceType | The class type. | 'A2A' (required) |
CreateProtectionContainerMappingInputPropertiesOrProtectionContainerMappingProperties
| Name | Description | Value |
|---|---|---|
| policyId | Applicable policy. | string |
| providerSpecificInput | Provider specific input for pairing. | ReplicationProviderSpecificContainerMappingInput |
| targetProtectionContainerId | The target unique protection container name. | string |
ReplicationProviderSpecificContainerMappingInput
| Name | Description | Value |
|---|---|---|
| instanceType | Set to 'A2A' for type A2AContainerMappingInput. Set to 'VMwareCbt' for type VMwareCbtContainerMappingInput. | 'A2A' 'VMwareCbt' (required) |
VMwareCbtContainerMappingInput
| Name | Description | Value |
|---|---|---|
| instanceType | The class type. | 'VMwareCbt' (required) |
| keyVaultId | The target key vault ARM Id. | string |
| keyVaultUri | The target key vault URL. | string |
| serviceBusConnectionStringSecretName | The secret name of the service bus connection string. | string |
| storageAccountId | The storage account ARM Id. | string (required) |
| storageAccountSasSecretName | The secret name of the storage account. | string |
| targetLocation | The target location. | string (required) |
Usage Examples
Azure Quickstart Samples
The following Azure Quickstart templates contain Bicep samples for deploying this resource type.
| Bicep File | Description |
|---|---|
| Create Azure VM Replication and Disaster Recovery | This template allows you to create Azure Virtual machine site replication disaster recovery. |
ARM template resource definition
The vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings 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/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings resource, add the following JSON to your template.
{
"type": "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings",
"apiVersion": "2024-01-01",
"name": "string",
"properties": {
"policyId": "string",
"providerSpecificInput": {
"instanceType": "string"
// For remaining properties, see ReplicationProviderSpecificContainerMappingInput objects
},
"targetProtectionContainerId": "string"
}
}
ReplicationProviderSpecificContainerMappingInput objects
Set the instanceType property to specify the type of object.
For A2A, use:
{
"agentAutoUpdateStatus": "string",
"automationAccountArmId": "string",
"automationAccountAuthenticationType": "string",
"instanceType": "A2A"
}
For VMwareCbt, use:
{
"instanceType": "VMwareCbt",
"keyVaultId": "string",
"keyVaultUri": "string",
"serviceBusConnectionStringSecretName": "string",
"storageAccountId": "string",
"storageAccountSasSecretName": "string",
"targetLocation": "string"
}
Property Values
Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2024-01-01' |
| name | The resource name | string (required) |
| properties | Configure protection input properties. | CreateProtectionContainerMappingInputPropertiesOrProtectionContainerMappingProperties |
| type | The resource type | 'Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings' |
A2AContainerMappingInput
| Name | Description | Value |
|---|---|---|
| agentAutoUpdateStatus | A value indicating whether the auto update is enabled. | 'Disabled' 'Enabled' |
| automationAccountArmId | The automation account arm id. | string |
| automationAccountAuthenticationType | A value indicating the type authentication to use for automation Account. | 'RunAsAccount' 'SystemAssignedIdentity' |
| instanceType | The class type. | 'A2A' (required) |
CreateProtectionContainerMappingInputPropertiesOrProtectionContainerMappingProperties
| Name | Description | Value |
|---|---|---|
| policyId | Applicable policy. | string |
| providerSpecificInput | Provider specific input for pairing. | ReplicationProviderSpecificContainerMappingInput |
| targetProtectionContainerId | The target unique protection container name. | string |
ReplicationProviderSpecificContainerMappingInput
| Name | Description | Value |
|---|---|---|
| instanceType | Set to 'A2A' for type A2AContainerMappingInput. Set to 'VMwareCbt' for type VMwareCbtContainerMappingInput. | 'A2A' 'VMwareCbt' (required) |
VMwareCbtContainerMappingInput
| Name | Description | Value |
|---|---|---|
| instanceType | The class type. | 'VMwareCbt' (required) |
| keyVaultId | The target key vault ARM Id. | string |
| keyVaultUri | The target key vault URL. | string |
| serviceBusConnectionStringSecretName | The secret name of the service bus connection string. | string |
| storageAccountId | The storage account ARM Id. | string (required) |
| storageAccountSasSecretName | The secret name of the storage account. | string |
| targetLocation | The target location. | string (required) |
Usage Examples
Azure Quickstart Templates
The following Azure Quickstart templates deploy this resource type.
| Template | Description |
|---|---|
| Create Azure VM Replication and Disaster Recovery |
This template allows you to create Azure Virtual machine site replication disaster recovery. |
Terraform (AzAPI provider) resource definition
The vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings 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/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2024-01-01"
name = "string"
parent_id = "string"
body = {
properties = {
policyId = "string"
providerSpecificInput = {
instanceType = "string"
// For remaining properties, see ReplicationProviderSpecificContainerMappingInput objects
}
targetProtectionContainerId = "string"
}
}
}
ReplicationProviderSpecificContainerMappingInput objects
Set the instanceType property to specify the type of object.
For A2A, use:
{
agentAutoUpdateStatus = "string"
automationAccountArmId = "string"
automationAccountAuthenticationType = "string"
instanceType = "A2A"
}
For VMwareCbt, use:
{
instanceType = "VMwareCbt"
keyVaultId = "string"
keyVaultUri = "string"
serviceBusConnectionStringSecretName = "string"
storageAccountId = "string"
storageAccountSasSecretName = "string"
targetLocation = "string"
}
Property Values
Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: vaults/replicationFabrics/replicationProtectionContainers |
| properties | Configure protection input properties. | CreateProtectionContainerMappingInputPropertiesOrProtectionContainerMappingProperties |
| type | The resource type | "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2024-01-01" |
A2AContainerMappingInput
| Name | Description | Value |
|---|---|---|
| agentAutoUpdateStatus | A value indicating whether the auto update is enabled. | 'Disabled' 'Enabled' |
| automationAccountArmId | The automation account arm id. | string |
| automationAccountAuthenticationType | A value indicating the type authentication to use for automation Account. | 'RunAsAccount' 'SystemAssignedIdentity' |
| instanceType | The class type. | 'A2A' (required) |
CreateProtectionContainerMappingInputPropertiesOrProtectionContainerMappingProperties
| Name | Description | Value |
|---|---|---|
| policyId | Applicable policy. | string |
| providerSpecificInput | Provider specific input for pairing. | ReplicationProviderSpecificContainerMappingInput |
| targetProtectionContainerId | The target unique protection container name. | string |
ReplicationProviderSpecificContainerMappingInput
| Name | Description | Value |
|---|---|---|
| instanceType | Set to 'A2A' for type A2AContainerMappingInput. Set to 'VMwareCbt' for type VMwareCbtContainerMappingInput. | 'A2A' 'VMwareCbt' (required) |
VMwareCbtContainerMappingInput
| Name | Description | Value |
|---|---|---|
| instanceType | The class type. | 'VMwareCbt' (required) |
| keyVaultId | The target key vault ARM Id. | string |
| keyVaultUri | The target key vault URL. | string |
| serviceBusConnectionStringSecretName | The secret name of the service bus connection string. | string |
| storageAccountId | The storage account ARM Id. | string (required) |
| storageAccountSasSecretName | The secret name of the storage account. | string |
| targetLocation | The target location. | string (required) |
Usage Examples
Terraform Samples
A basic example of deploying Site Recovery protection container mapping on Azure.
terraform {
required_providers {
azapi = {
source = "Azure/azapi"
}
}
}
provider "azapi" {
skip_provider_registration = false
}
variable "resource_name" {
type = string
default = "acctest0001"
}
variable "location" {
type = string
default = "westus"
}
resource "azapi_resource" "resourceGroup" {
type = "Microsoft.Resources/resourceGroups@2020-06-01"
name = "${var.resource_name}-rg"
location = var.location
}
resource "azapi_resource" "vault" {
type = "Microsoft.RecoveryServices/vaults@2024-01-01"
parent_id = azapi_resource.resourceGroup.id
name = "acctest-vault-250703130022502990"
location = var.location
body = {
properties = {
publicNetworkAccess = "Enabled"
redundancySettings = {
crossRegionRestore = "Disabled"
standardTierStorageRedundancy = "GeoRedundant"
}
}
sku = {
name = "Standard"
}
}
}
resource "azapi_resource" "replicationFabric" {
type = "Microsoft.RecoveryServices/vaults/replicationFabrics@2024-04-01"
parent_id = azapi_resource.vault.id
name = "acctest-fabric1-250703130022502990"
body = {
properties = {
customDetails = {
instanceType = "Azure"
location = "westeurope"
}
}
}
}
resource "azapi_resource" "replicationFabric_1" {
type = "Microsoft.RecoveryServices/vaults/replicationFabrics@2024-04-01"
parent_id = azapi_resource.vault.id
name = "acctest-fabric2b-250703130022502990"
body = {
properties = {
customDetails = {
instanceType = "Azure"
location = "westus2"
}
}
}
}
resource "azapi_resource" "replicationPolicy" {
type = "Microsoft.RecoveryServices/vaults/replicationPolicies@2024-04-01"
parent_id = azapi_resource.vault.id
name = "acctest-policy-250703130022502990"
body = {
properties = {
providerSpecificInput = {
appConsistentFrequencyInMinutes = 240
instanceType = "A2A"
multiVmSyncStatus = "Enable"
recoveryPointHistory = 1440
}
}
}
}
resource "azapi_resource" "replicationProtectionContainer" {
type = "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2024-04-01"
parent_id = azapi_resource.replicationFabric.id
name = "acctest-protection-cont1-250703130022502990"
body = {
properties = {}
}
}
resource "azapi_resource" "replicationProtectionContainer_1" {
type = "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers@2024-04-01"
parent_id = azapi_resource.replicationFabric_1.id
name = "acctest-protection-cont2-250703130022502990"
body = {
properties = {}
}
}
resource "azapi_resource" "replicationProtectionContainerMapping" {
type = "Microsoft.RecoveryServices/vaults/replicationFabrics/replicationProtectionContainers/replicationProtectionContainerMappings@2024-04-01"
parent_id = azapi_resource.replicationProtectionContainer.id
name = "mapping-250703130022502990"
body = {
properties = {
policyId = azapi_resource.replicationPolicy.id
providerSpecificInput = {
instanceType = "A2A"
}
targetProtectionContainerId = azapi_resource.replicationProtectionContainer_1.id
}
}
}