# Azure Service Bus Source Connector for Confluent Cloud The fully managed Azure Service Bus Source connector for Confluent Cloud reads messages from an Azure Service Bus queue or topic and writes them to Apache Kafka® topics. Azure Service Bus is a multi-tenant cloud messaging service for sending information between applications and services. Confluent Cloud is available through [Azure Marketplace](https://azuremarketplace.microsoft.com/en/marketplace/apps/confluentinc.confluent-cloud-azure-prod?tab=Overview) or [directly from Confluent](https://www.confluent.io/get-started/). #### 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](https://docs.confluent.io/kafka-connectors/azure-servicebus/current/). * 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](networking/internet-resource.md#clusters-connect-cloud). ## 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](../get-started/schema-registry.md#cloud-sr-config) must be enabled to use a Schema Registry-based format (for example, Avro, JSON Schema, or Protobuf). * **Client-side encryption (CSFLE and CSPE) support**: The connector supports CSFLE and CSPE for sensitive data. For more information about CSFLE or CSPE setup, see the [connector configuration](#cc-azure-service-bus-source-setup-connection). * **Secret manager integration**: The connector supports secret manager integration. For `SAS Key` based authentication, the connector can retrieve the following configurations from an integrated secret manager at runtime as needed. | **Secret manager managed configuration** | **Type** | |--------------------------------------------|------------| | `azure.servicebus.namespace` | `STRING` | | `azure.servicebus.sas.keyname` | `STRING` | | `azure.servicebus.sas.key` | `PASSWORD` | | `azure.servicebus.entity.name` | `STRING` | | `azure.servicebus.subscription` | `STRING` | For more information, see [Create a secret manager integration in Confluent Cloud](secret-manager-integration/overview.md#cloud-secret-manager-quickstart). For more information and examples to use with the Confluent Cloud API for Connect, see the [Confluent Cloud API for Connect Usage Examples](connect-api-section.md#ccloud-connect-api) section. ## Limitations Be sure to review the following information. * For connector limitations, see [Azure Service Bus Source Connector](limits.md#azure-service-bus-source-limits) limitations. * If you plan to use one or more Single Message Transformations (SMTs), see [SMT Limitations](single-message-transforms.md#cc-single-message-transforms-limitations). ## 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](https://www.confluent.io/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](https://docs.confluent.io/confluent-cli/current/install.html). - [Schema Registry](../get-started/schema-registry.md#cloud-sr-config) must be enabled to use a Schema Registry-based format (for example, Avro, JSON_SR (JSON Schema), or Protobuf). - You must have the Azure Service Bus connection details. For additional information, see the [Azure Service Bus docs](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-faq). ### Using the Confluent Cloud Console #### Step 1: Launch your Confluent Cloud cluster To create and launch a Kafka cluster in Confluent Cloud, see [Create a kafka cluster in Confluent Cloud](../get-started/index.md#cloud-create-kafka-cluster). #### 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. ![Azure Service Bus Source Connector Card](images/ccloud-azure-service-bus-source-icon.png) #### Step 4: Enter the connector details #### NOTE * Make sure you have all your [prerequisites](#cc-azure-service-bus-source-prereqs) completed. * An asterisk ( \* ) designates a required entry. At the **Add Azure Service Bus Source Connector** screen, complete the following: ### Topic selection Select the topic you want to send data to from the **Topics** list. To create a new topic, click **+Add new topic**. ### Kafka access 1. Select the way you want to provide **Kafka Cluster credentials**. You can choose one of the following options: - **My account**: This setting allows your connector to globally access everything that you have access to. With a user account, the connector uses an API key and secret to access the Kafka cluster. This option is not recommended for production. - **Service account**: This setting limits the access for your connector by using a [service account](service-account.md#s3-cloud-service-account). This option is recommended for production. - **Use an existing API key**: This setting allows you to specify an API key and a secret pair. You can use an existing pair or create a new one. This method is not recommended for production environments. #### NOTE Freight clusters support only service accounts for Kafka authentication. 2. Click **Continue**. ### Authentication 1. Configure the authentication properties: **Authentication method** - **Authentication method**: Select how you want to authenticate with Azure Service Bus. Currently, `SAS Key` is the only valid option. - **Use secret manager**: Enable this setting to fetch sensitive configuration values, such as the `SAS Key`, from a secret manager. **Secret manager configuration** - **Secret manager**: Select the secret manager that Confluent Cloud should use to retrieve sensitive data. - **Configurations from Secret manager**: Select the configurations whose values Confluent Cloud should fetch from the secret manager. - **Provider Integration**: Select an existing integration that has access to your resource such as the secret manager. **How should we connect to Azure Service Bus?** - **Azure Service Bus Namespace**: Azure Service Bus namespace that the messaging entity belongs to. Only enter the `namespace` section from `.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. 2. Click **Continue**. ### Configuration **Output messages** - **Select output record value format**: Select the output record value format (Data going to the Kafka topic). Valid entries are AVRO, JSON, JSON_SR (JSON Schema), or PROTOBUF. [Schema Registry](../get-started/schema-registry.md#cloud-sr-config) must be enabled to use a Schema Registry-based format (for example, Avro, JSON Schema, or Protobuf). **Data encryption** - Enable **Client-Side Field Level Encryption** for data encryption. Specify a **Service Account** to access the Schema Registry and associated encryption rules or keys with that schema. For more information on CSFLE or CSPE setup, see [Manage encryption for connectors](csfle.md#connect-csfle). ### **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?](../sr/faqs-cc.md#faq-schema-contexts). **Additional Configs** - **Value Converter Decimal Format**: Specifies the `JSON` or `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 `DECIMAL` logical type values in `JSON` or `JSON_SR` as a number representing the decimal value. - **Value Converter Replace Null With Default**: Specifies whether to replace fields that have a default value and that are null to the default value. When set to `true`, the connector uses the default value; otherwise, it uses `null`. Applies to the `JSON` converter. - **Key Converter Schema ID Serializer**: The class name of the schema ID serializer for keys. This is used to serialize schema IDs in the message headers. - **Value Converter Reference Subject Name Strategy**: Sets the subject reference name strategy for values. Valid entries are `DefaultReferenceSubjectNameStrategy` or `QualifiedReferenceSubjectNameStrategy`. You can use this strategy only with `PROTOBUF` format; the default strategy is `DefaultReferenceSubjectNameStrategy`. - **Value Converter Schemas Enable**: Includes schema within each of the serialized values. Input messages must contain `schema` and `payload` fields and must not contain additional fields. For plain `JSON` data, set this to `false`. Applies to the `JSON` converter. - **Errors Tolerance**: Use this property to configure the connector’s error handling behavior. #### WARNING Use this property with caution for sink connectors, as it can lead to data loss. If you set this property to `all`, the connector does not fail on errant records, but logs them (and sends to DLQ for sink connectors) and continues processing. If you set this property to `none`, the connector task fails on errant records. - **Value Converter Connect Meta Data**: Enables the Connect converter to add its metadata to the output schema. Applies to Avro converters. - **Value Converter Value Subject Name Strategy**: Determines how to construct the subject name under which the value schema is registered with Schema Registry. - **Key Converter Key Subject Name Strategy**: Determines how to construct the subject name for key schema registration. - **Value Converter Ignore Default For Nullables**: When set to `true`, this property ensures that the corresponding record in Kafka is `null`, instead of showing the default column value. Applies to the `AVRO`, `PROTOBUF`, and `JSON_SR` converters. - **Value Converter Schema ID Serializer**: The class name of the schema ID serializer for values. This is used to serialize schema IDs in the message headers. **Auto-restart policy** - **Enable Connector Auto-restart**: Enables 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. If disabled, you must manually restart the connector. **Transforms** - **Single Message Transformations**: To add a new SMT, see [Add transforms](single-message-transforms.md#cc-single-message-transforms-ui). For more information about unsupported SMTs, see [Unsupported transformations](single-message-transforms.md#cc-single-message-transforms-unsupported-transforms). **Processing position** - **Set offsets**: Click **Set offsets** to define a specific offset for this connector to begin procession data from. For more information on managing offsets, see [Manage offsets](offsets.md#connect-custom-offsets). - Click **Continue**. ### Sizing Based on the number of topic partitions you select, you will be provided with a recommended number of tasks. 1. To change the number of tasks, use the Range Slider to select the desired number of tasks. 2. Click **Continue**. ### Review and Launch 1. Verify the connection details by previewing the running configuration. 2. Once you’ve validated that the properties are configured to your satisfaction, click **Launch**. The status for the connector should go from **Provisioning** to **Running**. #### 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](connect-api-section.md#ccloud-connect-api) 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](#cc-azure-service-bus-source-prereqs) completed. #### Step 1: List the available connectors Enter the following command to list available connectors: ```none confluent connect plugin list ``` #### Step 2: List the connector configuration properties Enter the following command to show the connector configuration properties: ```none confluent connect plugin describe ``` 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. ```json { "connector.class": "AzureServiceBusSource", "name": "AzureServiceBusSource_0", "kafka.auth.mode": "KAFKA_API_KEY", "kafka.api.key": "****************", "kafka.api.secret": "************************************************", "kafka.topic": "", "azure.servicebus.namespace": "", "azure.servicebus.sas.keyname": "", "azure.servicebus.sas.key": "****************************************", "azure.servicebus.entity.name": "", "output.data.format": "AVRO", "tasks.max": "1", } ``` 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](service-account.md#s3-cloud-service-account), specify the **Resource ID** in the property `kafka.service.account.id=`. To list the available service account resource IDs, use the following command: ```bash confluent iam service-account list ``` For example: ```bash 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 ``` * `"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 `.servicebus.windows.net`. Do not use the fully-qualified domain name (FQDN). For additional information, see the [Azure Service Bus docs](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-faq). For details about shared access signature (SAS) authorization, see [Shared Access Authorization Policies](https://docs.microsoft.com/en-us/azure/service-bus-messaging/service-bus-sas#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](../get-started/schema-registry.md#cloud-sr-config) must be enabled to use a Schema Registry-based format (for example, Avro, JSON_SR (JSON Schema), or Protobuf). * `"tasks.max"`: Enter the maximum number of [tasks](/platform/current/connect/concepts.html#tasks) for the connector to use. #### NOTE To enable CSFLE or CSPE for data encryption, specify the following properties: * `csfle.enabled`: Flag to indicate whether the connector honors CSFLE or CSPE rules. * `sr.service.account.id`: A Service Account to access the Schema Registry and associated encryption rules or keys with that schema. For more information on CSFLE or CSPE setup, see [Manage encryption for connectors](csfle.md#connect-csfle). **SMTs**: For details about adding SMTs using the Confluent CLI, see the [Single Message Transformations](single-message-transforms.md#cc-single-message-transforms) documentation. See [Configuration Properties](#cc-azure-service-bus-source-config-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: ```none confluent connect cluster create --config-file .json ``` For example: ```none confluent connect cluster create --config-file azure-service-bus-source-config.json ``` Example output: ```none Created connector AzureServiceBusSource_0 lcc-do6vzd ``` #### Step 5: Check the connector status Enter the following command to check the connector status: ```none confluent connect cluster list ``` Example output: ```none ID | Name | Status | Type | Trace +------------+-------------------------------+---------+------+-------+ lcc-do6vzd | AzureServiceBusSource_0 | RUNNING | sink | | ``` #### 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](connect-api-section.md#ccloud-connect-api) 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](/platform/current/connect/kafka_connectors.html). ### 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, whenever possible.
* Type: string * Valid Values: SERVICE_ACCOUNT, KAFKA_API_KEY * 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 ### Authentication method `authentication.method` : Select how you want to authenticate with Azure Service Bus.
* Type: string * Default: SAS Key * Importance: high `secret.manager.enabled` : Fetch sensitive configuration values from a secret manager.
* Type: boolean * Default: false * Importance: high ### Secret manager configuration `secret.manager` : Select the secret manager to use for retrieving sensitive data.
* Type: string * Importance: high `secret.manager.managed.configs` : Select the configurations to fetch their values from the secret manager.
* Type: list * Importance: high `secret.manager.provider.integration.id` : Select an existing provider integration that has access to your secret manager.
* Type: string * 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 ### 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. Valid values are none, gzip, snappy, lz4, and zstd.
* Type: string * Importance: low `producer.override.linger.ms` : The producer groups together any records that arrive in between request transmissions into a single batched request. More details can be found in the documentation: [https://docs.confluent.io/platform/current/installation/configuration/producer-configs.html#linger-ms](https://docs.confluent.io/platform/current/installation/configuration/producer-configs.html#linger-ms).
* Type: long * Valid Values: [100,…,1000] * 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.scrub.invalid.names` : Whether to scrub invalid names by replacing invalid characters with valid characters. Applicable for Avro and 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 `errors.tolerance` : Use this property if you would like to configure the connector’s error handling behavior. WARNING: This property should be used with CAUTION for SOURCE CONNECTORS as it may lead to dataloss. If you set this property to ‘all’, the connector will not fail on errant records, but will instead log them (and send to DLQ for Sink Connectors) and continue processing. If you set this property to ‘none’, the connector task will fail on errant records.
* Type: string * Default: none * Importance: low `key.converter.key.schema.id.serializer` : The class name of the schema ID serializer for keys. This is used to serialize schema IDs in the message headers.
* Type: string * Default: io.confluent.kafka.serializers.schema.id.PrefixSchemaIdSerializer * 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.ignore.default.for.nullables` : When set to true, this property ensures that the corresponding record in Kafka is NULL, instead of showing the default column value. Applicable for AVRO,PROTOBUF 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.replace.null.with.default` : Whether to replace fields that have a default value and that are null to the default value. When set to true, the default value is used, otherwise null is used. Applicable for JSON Converter.
* Type: boolean * Default: true * Importance: low `value.converter.schemas.enable` : Include schemas within each of the serialized values. Input messages must contain schema and payload fields and may not contain additional fields. For plain JSON data, set this to false. Applicable for JSON Converter.
* Type: boolean * Default: false * Importance: low `value.converter.value.schema.id.serializer` : The class name of the schema ID serializer for values. This is used to serialize schema IDs in the message headers.
* Type: string * Default: io.confluent.kafka.serializers.schema.id.PrefixSchemaIdSerializer * 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 ### Auto-restart policy `auto.restart.on.user.error` : Enable connector to automatically restart on user-actionable errors.
* Type: boolean * Default: true * Importance: medium ## Frequently asked questions Find answers to frequently asked questions about the Azure Service Bus Source connector for Confluent Cloud. ### Why does my connector fail with the `Could not connect to Azure Service Bus with the provided configs` error? This error typically indicates a configuration issue with one of the following properties: **Namespace configuration issue**: Verify that the `azure.servicebus.namespace` property is configured correctly. Make sure you provide the namespace portion of your Service Bus instance and not the full FQDN. For example: * **Incorrect**: `"azure.servicebus.namespace": "my-namespace.servicebus.windows.net"` * **Correct**: `"azure.servicebus.namespace": "my-namespace"` **Authentication issue** Verify that your Shared Access Signature credentials are correct: * Ensure `azure.servicebus.sas.keyname` matches the SAS key name in your Azure portal. For example, `RootManageSharedAccessKey`. * Verify `azure.servicebus.sas.key` contains the correct SAS key value without extra spaces or characters. * If using secret manager integration, ensure secret references are properly configured. **Entity configuration issue** Verify that the connector is configured for the correct Service Bus entity type (queue or topic) and that the relevant properties are set. ### How do I configure the connector to use Azure Service Bus topics versus queues? The connector configuration differs when you are consuming from a queue or a topic subscription: **Queues**: When using queues, you must configure the `azure.servicebus.entity.name` value. ```json { "azure.servicebus.namespace": "my-namespace", "azure.servicebus.entity.name": "my-queue", "azure.servicebus.sas.keyname": "RootManageSharedAccessKey", "azure.servicebus.sas.key": "your-sas-key" } ``` **Topics**: When using topics, you must configure both `azure.servicebus.entity.name` and `azure.servicebus.subscription` values. ```json { "azure.servicebus.namespace": "my-namespace", "azure.servicebus.entity.name": "my-topic", "azure.servicebus.subscription": "my-subscription", "azure.servicebus.sas.keyname": "RootManageSharedAccessKey", "azure.servicebus.sas.key": "your-sas-key" } ``` ### Why does my connector fail when using AVRO output format? If you receive an error similar to `Schema Registry URL is required when using AVRO format`, this indicates that Schema Registry is not properly configured for your environment. **Solution**: * Ensure [Schema Registry](../sr/index.md#schemaregistry-intro) is enabled in your Confluent Cloud environment. * Ensure schema-based formats like AVRO, JSON_SR, and Protobuf required for Confluent Cloud Schema Registry are configured. * If Schema Registry is not enabled, use the JSON (schemaless) format. ### How do I optimize connector performance and task configuration? To optimize performance: **Task configuration** * Start with `"tasks.max": "1"` for initial testing. * Increase the number of tasks based on your workload and message volume. * Consider the number of partitions in your Service Bus entity when sizing tasks. **Performance considerations** * Monitor connector throughput and adjust task count as needed. * Consider network latency between Confluent Cloud and your Azure Service Bus instance. * If using private networking, ensure proper configuration of PrivateLink or VPN connections. The number of tasks affects parallel processing capability. More tasks can increase throughput but also consume more resources. ### Why is my connector creating duplicate events in the Kafka topic? Because the connector guarantees at-least-once delivery, duplicate events are possible. **Common causes**: * Connector restarts or failures during message processing. * Network interruptions between the connector and Azure Service Bus. * Message redelivery from Service Bus due to acknowledgment timing. To achieve exactly-once semantics, you must implement duplicate handling within your application logic. **Mitigation strategies**: * Implement idempotent message processing in your downstream consumers using unique message identifiers. * Use message properties or headers to deduplicate messages at the consumer level. * Ensure stable network connectivity between Confluent Cloud and Azure Service Bus. ### Why did my connector stop consuming messages from Azure Service Bus? If the connector stops consuming messages unexpectedly, investigate the following: **Check connector status** * Use the Confluent Cloud Console or CLI to verify the connector status is `RUNNING`. * Check for error messages in the connector logs or status. **Verify connectivity** * Ensure network connectivity between Confluent Cloud and your Azure Service Bus namespace. * If using private networking, verify the connection is active. * Check that SAS keys have not expired or been rotated without updating the connector configuration. **Review Service Bus configuration** * Verify the queue or topic subscription still exists in Azure. * Check for any Azure Service Bus throttling or quota limits that may affect message consumption. * Ensure messages are available in the queue or topic subscription. **Restart the connector** If no configuration issues are found, try pausing and resuming the connector through the Confluent Cloud Console. ## Next Steps For an example that shows fully managed Confluent Cloud connectors in action with Confluent Cloud for Apache Flink, see the [Cloud ETL Demo](/platform/current/tutorials/examples/cloud-etl/docs/index.html). This example also shows how to use Confluent CLI to manage your resources in Confluent Cloud. [![image](images/topology.png)](https://docs.confluent.io/platform/current/tutorials/examples/cloud-etl/docs/index.html)