Share via

Microsoft.EventHub namespaces/disasterRecoveryConfigs

  • Article

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

resource symbolicname 'Microsoft.EventHub/namespaces/disasterRecoveryConfigs@2024-05-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    alternateName: 'string'
    partnerNamespace: 'string'
  }
}

Property values

ArmDisasterRecoveryProperties

Name Description Value
alternateName Alternate name specified when alias and namespace names are same. string
partnerNamespace ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing string

Microsoft.EventHub/namespaces/disasterRecoveryConfigs

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1 (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

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

{
  "type": "Microsoft.EventHub/namespaces/disasterRecoveryConfigs",
  "apiVersion": "2024-05-01-preview",
  "name": "string",
  "properties": {
    "alternateName": "string",
    "partnerNamespace": "string"
  }
}

Property values

ArmDisasterRecoveryProperties

Name Description Value
alternateName Alternate name specified when alias and namespace names are same. string
partnerNamespace ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing string

Microsoft.EventHub/namespaces/disasterRecoveryConfigs

Name Description Value
apiVersion The api version '2024-05-01-preview'
name The resource name string

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

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.EventHub/namespaces/disasterRecoveryConfigs@2024-05-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      alternateName = "string"
      partnerNamespace = "string"
    }
  })
}

Property values

ArmDisasterRecoveryProperties

Name Description Value
alternateName Alternate name specified when alias and namespace names are same. string
partnerNamespace ARM Id of the Primary/Secondary eventhub namespace name, which is part of GEO DR pairing string

Microsoft.EventHub/namespaces/disasterRecoveryConfigs

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1 (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.EventHub/namespaces/disasterRecoveryConfigs@2024-05-01-preview"