← Back to plugin index

Azure Message Broker Connector
Description
Sends events to the configured Azure Event Hub.

Setup and configuration of Azure Event Hub and authentication infrastructure must be available, according to the Azure documentation.

Type name
AzureMessageBrokerConnector
Class
com.airlock.iam.servicecontainer.app.application.configuration.event.azure.AzureMessageBrokerConnectorConfig
May be used by
Message Broker Selector
Properties
Event Hub Namespace (eventHubNamespace)
Description
The fully qualified name for the Event Hub namespace. This is likely to be similar to {your-namespace}.servicebus.windows.net

This value is available in the Azure portal.

Attributes
String
Mandatory
Event Hub Name (eventHubName)
Description
The name of the Event Hub to connect to. The Event Hub must exist in the configured namespace.

This value is available in the Azure portal.

Attributes
String
Mandatory
Authentication (authentication)
Description
Configures how IAM authenticates to Azure services (Microsoft Entra ID).

Dependending on the setup and available infrastructure, different methods may suit better. Refer to the individual plugin documentation for further explanations.

If authentication with Microsoft Entra ID is not possible, consider using a "Connection String" for direct access.

For successful authentication, ensure that the necessary certificates are available when a custom truststore is used with IAM.

For integration or if necessary, additional logging regarding connections to Azure can be enabled in the Log4J configuration. IAM documentation explains custom logging configuration.

Adjust the log levels for "com.azure", "com.azure.core.amqp", "com.microsoft.azure.proton.transport.proxy" or other libraries to your needs.

Attributes
Plugin-Link
Optional
Assignable plugins
Azure Certificate Authentication Azure Client Secret Authentication Azure Default Authentication
Connection String (connectionString)
Description

Alternative service authentication method if general authentication with Microsoft Entra ID is not possible.

An Azure connection string contains all information required for an application to securely authenticate with and connect to an Azure Event Hub. It includes the service endpoint, authentication credentials (Shared Access Key), and an optional entity path (Event Hub name).

A namespace-level connection string grants the specified permissions (manage, read, or write) for all Event Hubs within the namespace.
An Event Hub–level connection string (ends with ;EntityPath=<EventHubName>) grants the specified permissions only for that specific Event Hub.

Connection strings should only be used when authentication with Microsoft Entra ID is not available or for integration.

It is recommended to rotate connection strings regularly.

For successful authentication, ensure that the necessary certificates are available when a custom truststore is used with IAM.

For integration or if necessary, additional logging regarding connections to Azure can be enabled in the Log4J configuration. IAM documentation explains custom logging configuration.

Adjust the log levels for "com.azure", "com.azure.core.amqp" or other libraries to your needs.

Attributes
String
Optional
Sensitive
Example
Endpoint=sb://<NamespaceName>.servicebus.windows.net/;SharedAccessKeyName=<KeyName>;SharedAccessKey=<KeyValue>
Example
Endpoint=sb://<NamespaceName>.servicebus.windows.net/;SharedAccessKeyName=<KeyName>;SharedAccessKey=<KeyValue>;EntityPath=<EventHubName>
Transport Type (transportType)
Description
Defines the transport type by which all the communication with Azure Event Hub occurs.

AMQP is the default transport type and is recommended for most scenarios. Outbound connections use port 5671.

AMQP over Web Sockets is useful for environments where networking is restrictive or when a proxy configuration must be used. Outbound connections use port 443.

Attributes
Enum
Optional
Default value
AMQP
Proxy Host (proxyHost)
Description
Hostname of an HTTP proxy the connector should use.

If this property is left empty, no proxy will be used.

Attributes
String
Optional
Example
proxy.company.com
Proxy Port (proxyPort)
Description
HTTP port of the proxy the connector should use.
Attributes
Integer
Optional
Proxy Authentication Type (proxyAuthenticationType)
Description
Specifies the type of authentication to use with the proxy.
  • None: The proxy requires no authentication. Configuration of a proxy login user and password is ignored.
  • Basic Authentication: Uses a username and password sent in plaintext (Base64 encoded but not encrypted).
  • Digest Authentication: Uses a username and password with challenge-response hashing for improved security.
Attributes
Enum
Optional
Default value
NONE
Proxy Login User (proxyLoginUser)
Description
Username for the proxy if proxy authentication is used.
Attributes
String
Optional
Proxy Login Password (proxyLoginPassword)
Description
Password for the proxy if proxy authentication is used.
Attributes
String
Optional
Sensitive
Partition Key (partitionKey)
Description

A partition key is used to map event data into specific partitions for data organization.

It enables keeping related events together in the same partition and in the exact order in which they arrived.

The partition key is derived from the application context and identifies the interrelationship of the events.

The partition key is used for all events sent to the event hub by this message broker connector.

Attributes
String
Optional
YAML Template (with default values) 

type: AzureMessageBrokerConnector
id: AzureMessageBrokerConnector-xxxxxx
displayName: 
comment: 
properties:
  authentication:
  connectionString:
  eventHubName:
  eventHubNamespace:
  partitionKey:
  proxyAuthenticationType: NONE
  proxyHost:
  proxyLoginPassword:
  proxyLoginUser:
  proxyPort:
  transportType: AMQP