Azure Service Bus Source Connector for Confluent Cloud¶

The Azure Service Bus is a multitenant cloud messaging service you can use to send information between applications and services. The fully-managed Azure Service Bus Source connector for Confluent Cloud reads data from an Azure Service Bus queue or topic, and persists the data in an Apache Kafka® topic.

Note

This Quick Start is for the fully-managed Confluent Cloud connector. If you are installing the connector locally for Confluent Platform, see Azure Service Bus Source connector for Confluent Platform.
If you require private networking for fully-managed connectors, make sure to set up the proper networking beforehand. For more information, see Manage Networking for Confluent Cloud Connectors.

Features¶

The Azure Service Bus Source connector supports the following features:

Topics created automatically: The connector can automatically create Kafka topics.
At least once delivery: The connector guarantees that records are delivered at least once to the Kafka topic.
Supports multiple tasks: The connector supports running one or more tasks.
Supported data formats: The connector supports Avro, JSON Schema (JSON-SR), Protobuf, and JSON (schemaless) output formats. Schema Registry must be enabled to use a Schema Registry-based format (for example, Avro, JSON Schema, or Protobuf). See Schema Registry Enabled Environments for additional information.

For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect Usage Examples section.

Limitations¶

Be sure to review the following information.

For connector limitations, see Azure Service Bus Source Connector limitations.
If you plan to use one or more Single Message Transforms (SMTs), see SMT Limitations.
If you plan to use Confluent Cloud Schema Registry, see Schema Registry Enabled Environments.

Quick Start¶

Use this quick start to get up and running with the Confluent Cloud Azure Service Bus Source connector. The quick start provides the basics of selecting the connector and configuring it to stream events.

Prerequisites

Authorized access to a Confluent Cloud cluster on Amazon Web Services (AWS), Microsoft Azure (Azure), or Google Cloud.
The Confluent CLI installed and configured for the cluster. See Install the Confluent CLI.
Schema Registry must be enabled to use a Schema Registry-based format (for example, Avro, JSON_SR (JSON Schema), or Protobuf). See Schema Registry Enabled Environments for additional information.
You must have the Azure Service Bus connection details. For additional information, see the Azure Service Bus docs.

Using the Confluent Cloud Console¶

Step 1: Launch your Confluent Cloud cluster¶

See the Quick Start for Confluent Cloud for installation instructions.

Step 2: Add a connector¶

In the left navigation menu, click Connectors. If you already have connectors in your cluster, click + Add connector.

Step 3: Select your connector¶

Click the Azure Service Bus Source connector card.

Step 4: Enter the connector details¶

Note

Make sure you have all your prerequisites completed.
An asterisk ( * ) designates a required entry.

At the Add Azure Service Bus Source Connector screen, complete the following:

Select the topic you want to send data to from the Topics list. To create a new topic, click +Add new topic.

Enter the required Azure Service Bus connection details:
- Azure Service Bus Namespace: Azure Service Bus namespace that the messaging entity belongs to. Only enter the namespace section from <namespace>.servicebus.windows.net. Do not use the fully-qualified domain name (FQDN).
- Shared access policy name: Shared access policy name to use for access authentication.
- Shared access key: Shared access key to use for access authentication.
- Azure Service Bus Queue/Topic Name: Azure Service Bus messaging entity name. Should be either the name of the queue or topic from which messages have to be polled.
- Azure Service Bus Subscription Name: The Azure Service Bus subscription name for the configured topic from which messages have to be polled. This should only be configured when messaging entity is of type topic.
Click Continue.

Select the output record value format (Data going to the Kafka topic): AVRO, JSON, JSON_SR (JSON Schema), or PROTOBUF. Schema Registry must be enabled to use a Schema Registry-based format (for example, Avro, JSON Schema, or Protobuf). See Schema Registry Enabled Environments for additional information.
Show advanced configurations
- Schema context: Select a schema context to use for this connector, if using a schema-based data format. This property defaults to the Default context, which configures the connector to use the default schema set up for Schema Registry in your Confluent Cloud environment. A schema context allows you to use separate schemas (like schema sub-registries) tied to topics in different Kafka clusters that share the same Schema Registry environment. For example, if you select a non-default context, a Source connector uses only that schema context to register a schema and a Sink connector uses only that schema context to read from. For more information about setting up a schema context, see What are schema contexts and when should you use them?.
Auto-restart policy
- Enable Connector Auto-restart: Control the auto-restart behavior of the connector and its task in the event of user-actionable errors. Defaults to true, enabling the connector to automatically restart in case of user-actionable errors. Set this property to false to disable auto-restart for failed connectors. In such cases, you would need to manually restart the connector.
Transforms
- Single Message Transforms: To add a new SMT, see Add transforms. For more information about unsupported SMTs, see Unsupported transformations.
Click Continue.

Step 5: Check for records¶

Verify that records are being produced at the Kafka topic.

For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect Usage Examples section.

Using the Confluent CLI¶

Complete the following steps to set up and run the connector using the Confluent CLI.

Note

Make sure you have all your prerequisites completed.

Step 1: List the available connectors¶

Enter the following command to list available connectors:

confluent connect plugin list
Copy

Step 2: List the connector configuration properties¶

Enter the following command to show the connector configuration properties:

confluent connect plugin describe <connector-plugin-name>
Copy

The command output shows the required and optional configuration properties.

Step 3: Create the connector configuration file¶

Create a JSON file that contains the connector configuration properties. The following example shows the required connector properties.

{
  "connector.class": "AzureServiceBusSource",
  "name": "AzureServiceBusSource_0",
  "kafka.auth.mode": "KAFKA_API_KEY",
  "kafka.api.key": "****************",
  "kafka.api.secret": "************************************************",
  "kafka.topic": "<topic-name>",
  "azure.servicebus.namespace": "<namespace>",
  "azure.servicebus.sas.keyname": "<keyname>",
  "azure.servicebus.sas.key": "****************************************",
  "azure.servicebus.entity.name": "<entity>",
  "output.data.format": "AVRO",
  "tasks.max": "1",
}
Copy

Note the following property definitions:

"connector.class": Identifies the connector plugin name.
"name": Sets a name for your new connector.

"kafka.auth.mode": Identifies the connector authentication mode you want to use. There are two options: SERVICE_ACCOUNT or KAFKA_API_KEY (the default). To use an API key and secret, specify the configuration properties kafka.api.key and kafka.api.secret, as shown in the example configuration (above). To use a service account, specify the Resource ID in the property kafka.service.account.id=<service-account-resource-ID>. To list the available service account resource IDs, use the following command:
```
confluent iam service-account list
```
Copy
For example:
```
confluent iam service-account list

   Id     | Resource ID |       Name        |    Description
+---------+-------------+-------------------+-------------------
   123456 | sa-l1r23m   | sa-1              | Service account 1
   789101 | sa-l4d56p   | sa-2              | Service account 2
```
Copy
"kafka.topic": Enter the topic name where data is sent.
"azure.servicebus.<>": Enter the Azure Service Bus details. For azure.servicebus.namespace, only use the namespace section from <namespace>.servicebus.windows.net. Do not use the fully-qualified domain name (FQDN). For additional information, see the Azure Service Bus docs. For details about shared access signature (SAS) authorization, see Shared Access Authorization Policies.
“output.data.format": Enter an output Kafka record value format (data going into the Kafka topic): AVRO, JSON_SR (JSON Schema), PROTOBUF, or JSON (schemaless). Schema Registry must be enabled to use a Schema Registry-based format (for example, Avro, JSON_SR (JSON Schema), or Protobuf). See Schema Registry Enabled Environments for additional information.
"tasks.max": Enter the maximum number of tasks for the connector to use.

Single Message Transforms: See the Single Message Transforms (SMT) documentation for details about adding SMTs using the CLI.

See Configuration Properties for all property values and descriptions.

Step 4: Load the properties file and create the connector¶

Enter the following command to load the configuration and start the connector:

confluent connect cluster create --config-file <file-name>.json
Copy

For example:

confluent connect cluster create --config-file azure-service-bus-source-config.json
Copy

Example output:

Created connector AzureServiceBusSource_0 lcc-do6vzd
Copy

Step 5: Check the connector status¶

Enter the following command to check the connector status:

confluent connect cluster list
Copy

Example output:

ID           |             Name              | Status  | Type | Trace
+------------+-------------------------------+---------+------+-------+
lcc-do6vzd   | AzureServiceBusSource_0       | RUNNING | sink |       |
Copy

Step 6: Check for records.¶

Verify that records are being produced at the Kafka topic.

For more information and examples to use with the Confluent Cloud API for Connect, see the Confluent Cloud API for Connect Usage Examples section.

Configuration Properties¶

Use the following configuration properties with the fully-managed connector. For self-managed connector property definitions and other details, see the connector docs in Self-managed connectors for Confluent Platform.

How should we connect to your data?¶

name

Sets a name for your connector.

Type: string
Valid Values: A string at most 64 characters long
Importance: high

Schema Config¶

schema.context.name

Add a schema context name. A schema context represents an independent scope in Schema Registry. It is a separate sub-schema tied to topics in different Kafka clusters that share the same Schema Registry instance. If not used, the connector uses the default schema configured for Schema Registry in your Confluent Cloud environment.

Type: string
Default: default
Importance: medium

Kafka Cluster credentials¶

kafka.auth.mode

Kafka Authentication mode. It can be one of KAFKA_API_KEY or SERVICE_ACCOUNT. It defaults to KAFKA_API_KEY mode.

Type: string
Default: KAFKA_API_KEY
Valid Values: KAFKA_API_KEY, SERVICE_ACCOUNT
Importance: high

kafka.api.key

Kafka API Key. Required when kafka.auth.mode==KAFKA_API_KEY.

Type: password
Importance: high

kafka.service.account.id

The Service Account that will be used to generate the API keys to communicate with Kafka Cluster.

Type: string
Importance: high

kafka.api.secret

Secret associated with Kafka API key. Required when kafka.auth.mode==KAFKA_API_KEY.

Type: password
Importance: high

Which topic do you want to send data to?¶

kafka.topic

Identifies the topic name to write the data to.

Type: string
Importance: high

How should we connect to Azure Service Bus?¶

azure.servicebus.namespace

Azure Service Bus Namespace that the messaging entity belongs to.

Type: string
Importance: high

azure.servicebus.sas.keyname

Shared access policy name to use for access authentication.

Type: string
Importance: high

azure.servicebus.sas.key

Shared access key to use for access authentication.

Type: password
Importance: high

azure.servicebus.entity.name

Azure Service Bus messaging entity name. Should be either the name of the queue or topic from which messages have to be polled.

Type: string
Importance: high

azure.servicebus.subscription

The Azure Service Bus Subscription Name for the configured topic from which messages have to be polled. This should only be configured when messaging entity is of type topic.

Type: string
Importance: high

Output messages¶

output.data.format

Sets the output Kafka record value format. Valid entries are AVRO, JSON_SR, PROTOBUF, or JSON. Note that you need to have Confluent Cloud Schema Registry configured if using a schema-based message format like AVRO, JSON_SR, and PROTOBUF

Type: string
Default: JSON
Importance: high

Number of tasks for this connector¶

tasks.max

Maximum number of tasks for the connector.

Type: int
Valid Values: [1,…]
Importance: high

Auto-restart policy¶

auto.restart.on.user.error

Enable connector to automatically restart on user-actionable errors.

Type: boolean
Default: true
Importance: medium

Additional Configs¶

header.converter

The converter class for the headers. This is used to serialize and deserialize the headers of the messages.

Type: string
Importance: low

producer.override.compression.type

The compression type for all data generated by the producer.

Type: string
Importance: low

value.converter.allow.optional.map.keys

Allow optional string map key when converting from Connect Schema to Avro Schema. Applicable for Avro Converters.

Type: boolean
Importance: low

value.converter.auto.register.schemas

Specify if the Serializer should attempt to register the Schema.

Type: boolean
Importance: low

value.converter.connect.meta.data

Allow the Connect converter to add its metadata to the output schema. Applicable for Avro Converters.

Type: boolean
Importance: low

value.converter.enhanced.avro.schema.support

Enable enhanced schema support to preserve package information and Enums. Applicable for Avro Converters.

Type: boolean
Importance: low

value.converter.enhanced.protobuf.schema.support

Enable enhanced schema support to preserve package information. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.flatten.unions

Whether to flatten unions (oneofs). Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.generate.index.for.unions

Whether to generate an index suffix for unions. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.generate.struct.for.nulls

Whether to generate a struct variable for null values. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.int.for.enums

Whether to represent enums as integers. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.latest.compatibility.strict

Verify latest subject version is backward compatible when use.latest.version is true.

Type: boolean
Importance: low

value.converter.object.additional.properties

Whether to allow additional properties for object schemas. Applicable for JSON_SR Converters.

Type: boolean
Importance: low

value.converter.optional.for.nullables

Whether nullable fields should be specified with an optional label. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.optional.for.proto2

Whether proto2 optionals are supported. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.use.latest.version

Use latest version of schema in subject for serialization when auto.register.schemas is false.

Type: boolean
Importance: low

value.converter.use.optional.for.nonrequired

Whether to set non-required properties to be optional. Applicable for JSON_SR Converters.

Type: boolean
Importance: low

value.converter.wrapper.for.nullables

Whether nullable fields should use primitive wrapper messages. Applicable for Protobuf Converters.

Type: boolean
Importance: low

value.converter.wrapper.for.raw.primitives

Whether a wrapper message should be interpreted as a raw primitive at root level. Applicable for Protobuf Converters.

Type: boolean
Importance: low

key.converter.key.subject.name.strategy

How to construct the subject name for key schema registration.

Type: string
Default: TopicNameStrategy
Importance: low

value.converter.decimal.format

Specify the JSON/JSON_SR serialization format for Connect DECIMAL logical type values with two allowed literals:

BASE64 to serialize DECIMAL logical types as base64 encoded binary data and

NUMERIC to serialize Connect DECIMAL logical type values in JSON/JSON_SR as a number representing the decimal value.

Type: string
Default: BASE64
Importance: low

value.converter.flatten.singleton.unions

Whether to flatten singleton unions. Applicable for Avro and JSON_SR Converters.

Type: boolean
Default: false
Importance: low

value.converter.reference.subject.name.strategy

Set the subject reference name strategy for value. Valid entries are DefaultReferenceSubjectNameStrategy or QualifiedReferenceSubjectNameStrategy. Note that the subject reference name strategy can be selected only for PROTOBUF format with the default strategy being DefaultReferenceSubjectNameStrategy.

Type: string
Default: DefaultReferenceSubjectNameStrategy
Importance: low

value.converter.value.subject.name.strategy

Determines how to construct the subject name under which the value schema is registered with Schema Registry.

Type: string
Default: TopicNameStrategy
Importance: low

Next Steps¶

For an example that shows fully-managed Confluent Cloud connectors in action with Confluent Cloud ksqlDB, see the Cloud ETL Demo. This example also shows how to use Confluent CLI to manage your resources in Confluent Cloud.