Microsoft.EventHub namespaces

مقالة
02/23/2022
قراءة خلال 5 دقائق

The namespaces resource type can be deployed to: Resource groups.

To learn about resource group deployments, see Bicep or ARM template.

Template format

To create a Microsoft.EventHub/namespaces resource, add the following Bicep or JSON to your template.

Bicep
JSON

resource symbolicname 'Microsoft.EventHub/namespaces@2021-11-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  sku: {
    capacity: int
    name: 'string'
    tier: 'string'
  }
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    alternateName: 'string'
    clusterArmId: 'string'
    disableLocalAuth: bool
    encryption: {
      keySource: 'Microsoft.KeyVault'
      keyVaultProperties: [
        {
          identity: {
            userAssignedIdentity: 'string'
          }
          keyName: 'string'
          keyVaultUri: 'string'
          keyVersion: 'string'
        }
      ]
      requireInfrastructureEncryption: bool
    }
    isAutoInflateEnabled: bool
    kafkaEnabled: bool
    maximumThroughputUnits: int
    privateEndpointConnections: [
      {
        properties: {
          privateEndpoint: {
            id: 'string'
          }
          privateLinkServiceConnectionState: {
            description: 'string'
            status: 'string'
          }
          provisioningState: 'string'
        }
      }
    ]
    zoneRedundant: bool
  }
}

{
  "type": "Microsoft.EventHub/namespaces",
  "apiVersion": "2021-11-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "sku": {
    "capacity": "int",
    "name": "string",
    "tier": "string"
  },
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "alternateName": "string",
    "clusterArmId": "string",
    "disableLocalAuth": "bool",
    "encryption": {
      "keySource": "Microsoft.KeyVault",
      "keyVaultProperties": [
        {
          "identity": {
            "userAssignedIdentity": "string"
          },
          "keyName": "string",
          "keyVaultUri": "string",
          "keyVersion": "string"
        }
      ],
      "requireInfrastructureEncryption": "bool"
    },
    "isAutoInflateEnabled": "bool",
    "kafkaEnabled": "bool",
    "maximumThroughputUnits": "int",
    "privateEndpointConnections": [
      {
        "properties": {
          "privateEndpoint": {
            "id": "string"
          },
          "privateLinkServiceConnectionState": {
            "description": "string",
            "status": "string"
          },
          "provisioningState": "string"
        }
      }
    ],
    "zoneRedundant": "bool"
  }
}

Property values

namespaces

Name	Description	Value
type	The resource type For Bicep, set this value in the resource declaration.	'Microsoft.EventHub/namespaces'
apiVersion	The resource api version For Bicep, set this value in the resource declaration.	'2021-11-01'
name	The resource name	string (required) Character limit: 6-50 Valid characters: Alphanumerics and hyphens. Start with letter. End with letter or number. Resource name must be unique across Azure.
location	Resource location.	string
tags	Resource tags.	Dictionary of tag names and values. See Tags in templates
sku	SKU parameters supplied to the create namespace operation	Sku
identity	Properties to configure Identity for Bring your Own Keys	Identity
properties	Namespace properties supplied for create namespace operation.	EHNamespaceProperties

Identity

Name	Description	Value
type	Type of managed service identity.	'None' 'SystemAssigned' 'SystemAssigned, UserAssigned' 'UserAssigned'
userAssignedIdentities	Properties for User Assigned Identities	object

EHNamespaceProperties

Name	Description	Value
alternateName	Alternate name specified when alias and namespace names are same.	string
clusterArmId	Cluster ARM ID of the Namespace.	string
disableLocalAuth	This property disables SAS authentication for the Event Hubs namespace.	bool
encryption	Properties to configure Encryption	Encryption
isAutoInflateEnabled	Value that indicates whether AutoInflate is enabled for eventhub namespace.	bool
kafkaEnabled	Value that indicates whether Kafka is enabled for eventhub namespace.	bool
maximumThroughputUnits	Upper limit of throughput units when AutoInflate is enabled, value should be within 0 to 20 throughput units. ( '0' if AutoInflateEnabled = true)	int
privateEndpointConnections	List of private endpoint connections.	PrivateEndpointConnection[]
zoneRedundant	Enabling this property creates a Standard Event Hubs Namespace in regions supported availability zones.	bool

Encryption

Name	Description	Value
keySource	Enumerates the possible value of keySource for Encryption	'Microsoft.KeyVault'
keyVaultProperties	Properties of KeyVault	KeyVaultProperties[]
requireInfrastructureEncryption	Enable Infrastructure Encryption (Double Encryption)	bool

KeyVaultProperties

Name	Description	Value
identity		UserAssignedIdentityProperties
keyName	Name of the Key from KeyVault	string
keyVaultUri	Uri of KeyVault	string
keyVersion	Key Version	string

UserAssignedIdentityProperties

Name	Description	Value
userAssignedIdentity	ARM ID of user Identity selected for encryption	string

PrivateEndpointConnection

Name	Description	Value
properties	Properties of the private endpoint connection resource.	PrivateEndpointConnectionProperties

PrivateEndpointConnectionProperties

Name	Description	Value
privateEndpoint	PrivateEndpoint information.	PrivateEndpoint
privateLinkServiceConnectionState	ConnectionState information.	ConnectionState
provisioningState	Provisioning state of the Private Endpoint Connection.	'Canceled' 'Creating' 'Deleting' 'Failed' 'Succeeded' 'Updating'

PrivateEndpoint

Name	Description	Value
id	The ARM identifier for Private Endpoint.	string

ConnectionState

Name	Description	Value
description	Description of the connection state.	string
status	Status of the connection.	'Approved' 'Disconnected' 'Pending' 'Rejected'

Sku

Name	Description	Value
capacity	The Event Hubs throughput units for Basic or Standard tiers, where value should be 0 to 20 throughput units. The Event Hubs premium units for Premium tier, where value should be 0 to 10 premium units.	int
name	Name of this SKU.	'Basic' 'Premium' 'Standard'
tier	The billing tier of this particular SKU.	'Basic' 'Premium' 'Standard'

Quickstart templates

The following quickstart templates deploy this resource type.

Template	Description
PubNub Realtime Gateway for Azure Event Hubs	The PubNub Realtime Gateway for Azure provides a realtime data stream bridge between the PubNub Data Stream Network and Azure Event Hubs. -- consider it a bi-directional bridge between PubNub and Azure!
Create Event Grid custom topic and event hub handler.	Creates an Azure Event Grid custom topic and event hub to handle the events.
Create an EventHubs namespace, Event Hub, & consumer group	This template enables you to deploy an Event Hubs Standard namespace, an Event Hub, and a consumer group.
Create EventHubs authorizationRules	This template enables you to deploy a EventHubs Standard namespace, an Event Hub, a consumer group and authorizationRules
Create a Eventhub namespace and geo-recovery configuration	This template enables you to deploy a Service Bus namespace with a Basic/Standard SKU.
Create a Service Bus namespace IP Filter rule	This template enables you to deploy a Service Bus Premium namespace with IP Filter rule
Create a Event Hubs namespace Virtual Network rule	This template enables you to deploy a Event Hubs Standard namespace with Virtual Network rule
Creates Event Hub cluster & namesapce in cluster	This template enables you to create EventHubs Cluster and a namespace in cluster
Creates Eventhub cluster, namesapce & eventhub	This template enables you to create EventHubs Cluster, namespace and eventhub in cluster
Create EventHubs with Capture enabled	This template enables you to deploy a EventHubs namespace with an event hub and enabling Capture on it
Create EventHubs with Capture enabled	This template enables you to deploy a EventHubs namespace with an event hub and enabling Capture on it
Create an EventHubs namespace and enable auto-inflate	This template enables you to deploy an Event Hubs Standard namespace, an Event Hub, and a consumer group.This template also turns on the auto-inflate feature on your namespace.
Create an event hub	This template enables you to deploy a EventHubs namespace with an event hub.
Connect to a Event Hubs namespace via private endpoint	This sample shows how to use configure a virtual network and private DNS zone to access a Event Hubs namespace via a private endpoint.
Deploy Azure Data Explorer db with Event Hub connection.	Deploy Azure Data Explorer db with Event Hub connection.
Azure SQL Server with Auditing written to Event Hub	This template allows you to deploy an Azure SQL server with Auditing enabled to write audit logs to Event Hub
Create SQL MI with configured sending of logs and metrics.	This template allows you to deploy SQL MI and additional resources used for storing logs and metrics (diagnostic workspace, storage account, event hub).
Create an Environment with an Event Hub Event Source	This template enables you to deploy a Time Series Insights environment that is configured to consume events from an Event Hub.