Azure Event Hubs

Learn the required and optional properties of creating a Azure Event Hubs Connection, Credential, Read Connector, and Write Connector.

azure event hubs logo

Prerequisites

  • Event Hubs namespace in Azure with minimum Standard Pricing Tier.

Connection Properties

The following table describes the fields available when creating a new Azure Event Hubs Connection. Create a connection using the information below and these step-by-step instructions.

FieldRequiredDescription
Access TypeRequiredThis connection type is Read-Only, Write-Only, or Read-Write.
Connection NameRequiredInput your desired name.
Event Hubs Namespace HostnameRequiredThe hostname string in the format <NamespaceName>.servicebus.windows.net
Event Hubs IdentifierOptionalMust be unique and not the same as the Hostname.
Consumer Group IDOptionalConsumer group name. (Accessible through the Azure Event Hubs CLI.)
Consumer ConfigsOptionalAny additional configurations made to an event hub.
Skip Data Loss ErrorsOptionalBy default, Ascend will display an error and pause processing If Ascend encounters data loss. Selecting "Skip Data Loss Errors" lets Ascend ignore data loss and continue processing.
Requires CredentialsRequiredA Credential is required.

Credential Properties

The following table describes the fields available when creating a new Azure Event Hubs credential.

FieldRequiredDescription
Credential NameRequiredThe name to identify this credential with. This credential will be available as a selection for future use.
Credential TypeRequiredThis field will automatically populate with Azure Event Hubs.
Connection StringsRequiredThe Event Hubs connection string. Should be in the following format:
Endpoint=sb://<NamespaceName>.servicebus.windows.net/;SharedAccessKeyName=<KeyName>;SharedAccessKey=<KeyValue>

Read Connector Properties

The following table describes the fields available when creating a new Azure Even Hubs Read Connector. Create a new Read Connector using the information below and these step-by-step instructions.

FieldRequiredDescription
NameRequiredProvide a name for your connector. We recommend using lowercase with underscores in place of spaces.
DescriptionOptionalDescribes the connector. We recommend providing a description if you are ingesting information from the same source multiple times for different reasons.
SubscriptionRequiredSingle Topic: Topic to subscribe to
Multi-Topic: Provide a Topic Pattern to subscribe to all the topics matching the regex.
Key Deserializer RequiredBefore transmitting the entire message to the broker, to let the producer know how to convert the message into byte array we use serializers.

- String Deserializer: Convert byte array(containing string) to string
- Binary Deserializer (B64 Encoded): Convert byte array (containing formats other than strings like AVRO) to Binary and then base64 encode it.
Value DeserializerRequiredTo convert the byte array back to the object, indicate the deserializer by the consumer.

- String Deserializer: Convert byte array(containing string) to string
- Binary Deserializer (B64 Encoded): Convert byte array (containing formats other than strings like AVRO) to Binary and then base64 encode it.
Starting PositionOptionalSelect the starting position. Earliest represents the start of the stream and Latest represents the end of the stream.
Consumer ConfigsOptionalInclude additional consumer Event Hub options.
Data Version OptionalAssign a Data Version. A change to Data Version triggers the component to reprocess. It results in no longer using data previously ingested by this Connector, and a complete ingest of new data.

Write Connector Properties

The following table describes the fields available when creating a new Azure Event Hubs Write Connector. Create a new Write Connector using the information below and these step-by-step instructions.

FieldRequiredDescription
NameRequiredProvide a name for your connector. We recommend using lowercase with underscores in place of spaces.
DescriptionOptionalDescribes the connector. We recommend providing a description if you are ingesting information from the same source multiple times for different reasons.
UpstreamRequiredThe name of the previous connector to pull data from.
SubscriptionRequiredSingle Topic: Topic to subscribe to
Multi-Topic: Provide a Topic Pattern to subscribe to all the topics matching the regex.
Key DeserializerRequiredBefore transmitting the entire message to the broker, to let the producer know how to convert the message into byte array we use serializers.

- String Deserializer: Convert byte array(containing string) to string
- Binary Deserializer (B64 Encoded): Convert byte array (containing formats other than strings like AVRO) to Binary and then base64 encode it.
Value DeserializerRequiredTo convert the byte array back to the object, indicate the deserializer by the consumer.

- String Deserializer: Convert byte array(containing string) to string
- Binary Deserializer (B64 Encoded): Convert byte array (containing formats other than strings like AVRO) to Binary and then base64 encode it.
Starting PositionOptionalSelect the starting position. Earliest represents the start of the stream and Latest represents the end of the stream
Producer ConfigsOptionalInclude additional producer Event Hub Options.
Data Version OptionalAssign a Data Version. A change to Data Version triggers the component to reprocess. It results in no longer using data previously ingested by this Connector, and a complete ingest of new data.