Microsoft.ServiceBus namespaces/disasterRecoveryConfigs

Bicep resource definition

The namespaces/disasterRecoveryConfigs 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.ServiceBus/namespaces/disasterRecoveryConfigs resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2026-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    alternateName: 'string'
    partnerNamespace: 'string'
  }
}

Property Values

Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 50 (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: namespaces
properties Properties required to the Create Or Update Alias(Disaster Recovery configurations) ArmDisasterRecoveryProperties

ArmDisasterRecoveryProperties

Name Description Value
alternateName Primary/Secondary eventhub namespace name, which is part of GEO DR pairing string
partnerNamespace ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing string

Usage Examples

Bicep Samples

A basic example of deploying Disaster Recovery Config for a Service Bus Namespace.

targetScope = 'subscription'

param location string = 'westus'
param secondaryLocation string = 'centralus'
param resourceName string = 'acctest0001'

resource resourcegroup1 'Microsoft.Resources/resourceGroups@2020-06-01' = {
  name: '${resourceName}rg2'
  location: secondaryLocation
}

resource resourceGroup 'Microsoft.Resources/resourceGroups@2020-06-01' = {
  name: resourceName
  location: location
}

module module1 'main-rg-module.bicep' = {
  name: 'deploy-rg-resources'
  scope: resourcegroup1
  params: {
    resourceName: resourceName
    location: location
    secondaryLocation: secondaryLocation
  }
}

A basic example of deploying Disaster Recovery Config for a Service Bus Namespace.

param resourceName string = 'acctest0001'
param location string = 'westus'
param secondaryLocation string = 'centralus'

resource namespace 'Microsoft.ServiceBus/namespaces@2022-10-01-preview' = {
  name: '${resourceName}ns1'
  location: location
  sku: {
    capacity: 1
    name: 'Premium'
    tier: 'Premium'
  }
  properties: {
    disableLocalAuth: false
    minimumTlsVersion: '1.2'
    premiumMessagingPartitions: 1
    publicNetworkAccess: 'Enabled'
  }
}

resource disasterRecoveryConfig 'Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2021-06-01-preview' = {
  name: '${resourceName}alias'
  parent: namespace
  properties: {
    partnerNamespace: namespace1.id
  }
}

resource namespace1 'Microsoft.ServiceBus/namespaces@2022-10-01-preview' = {
  name: '${resourceName}ns2'
  location: secondaryLocation
  sku: {
    capacity: 1
    name: 'Premium'
    tier: 'Premium'
  }
  properties: {
    disableLocalAuth: false
    minimumTlsVersion: '1.2'
    premiumMessagingPartitions: 1
    publicNetworkAccess: 'Enabled'
  }
}

ARM template resource definition

The namespaces/disasterRecoveryConfigs 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.ServiceBus/namespaces/disasterRecoveryConfigs resource, add the following JSON to your template.

{
  "type": "Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs",
  "apiVersion": "2026-01-01",
  "name": "string",
  "properties": {
    "alternateName": "string",
    "partnerNamespace": "string"
  }
}

Property Values

Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs

Name Description Value
apiVersion The api version '2026-01-01'
name The resource name string

Constraints:
Min length = 1
Max length = 50 (required)
properties Properties required to the Create Or Update Alias(Disaster Recovery configurations) ArmDisasterRecoveryProperties
type The resource type 'Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs'

ArmDisasterRecoveryProperties

Name Description Value
alternateName Primary/Secondary eventhub namespace name, which is part of GEO DR pairing string
partnerNamespace ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing string

Usage Examples

Terraform (AzAPI provider) resource definition

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2026-01-01"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      alternateName = "string"
      partnerNamespace = "string"
    }
  }
}

Property Values

Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 50 (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: namespaces
properties Properties required to the Create Or Update Alias(Disaster Recovery configurations) ArmDisasterRecoveryProperties
type The resource type "Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2026-01-01"

ArmDisasterRecoveryProperties

Name Description Value
alternateName Primary/Secondary eventhub namespace name, which is part of GEO DR pairing string
partnerNamespace ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing string

Usage Examples

Terraform Samples

A basic example of deploying Disaster Recovery Config for a Service Bus Namespace.

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"
}

variable "secondary_location" {
  type    = string
  default = "centralus"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "resourceGroup_1" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = "${var.resource_name}rg2"
  location = var.secondary_location
}

resource "azapi_resource" "namespace" {
  type      = "Microsoft.ServiceBus/namespaces@2022-10-01-preview"
  parent_id = azapi_resource.resourceGroup.id
  name      = "${var.resource_name}ns1"
  location  = var.location
  body = {
    properties = {
      disableLocalAuth           = false
      minimumTlsVersion          = "1.2"
      premiumMessagingPartitions = 1
      publicNetworkAccess        = "Enabled"
    }
    sku = {
      capacity = 1
      name     = "Premium"
      tier     = "Premium"
    }
  }
}

resource "azapi_resource" "namespace_1" {
  type      = "Microsoft.ServiceBus/namespaces@2022-10-01-preview"
  parent_id = azapi_resource.resourceGroup_1.id
  name      = "${var.resource_name}ns2"
  location  = var.secondary_location
  body = {
    properties = {
      disableLocalAuth           = false
      minimumTlsVersion          = "1.2"
      premiumMessagingPartitions = 1
      publicNetworkAccess        = "Enabled"
    }
    sku = {
      capacity = 1
      name     = "Premium"
      tier     = "Premium"
    }
  }
}

resource "azapi_resource" "disasterRecoveryConfig" {
  type      = "Microsoft.ServiceBus/namespaces/disasterRecoveryConfigs@2021-06-01-preview"
  parent_id = azapi_resource.namespace.id
  name      = "${var.resource_name}alias"
  body = {
    properties = {
      partnerNamespace = azapi_resource.namespace_1.id
    }
  }
}
  • Last updated on