# Azure Cosmos DB Source V2 Connector for Confluent Cloud The fully managed Azure Cosmos Source V2 connector for Confluent Cloud reads records from an Azure Cosmos database and writes data to Apache Kafka® topics in Confluent Cloud. 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 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). ## V2 improvements The V2 connector includes the following improvements: - Supports multiple containers per task, making read performance more efficient. - Utilizes the [change feed pull model](https://learn.microsoft.com/en-us/azure/cosmos-db/nosql/change-feed-pull-model?tabs=dotnet), which is simpler and improves efficiency in the Kafka environment. - Supports enhanced throughput control for managing data ingestion rates. - Integrated metrics collection to enable better monitoring and debugging, utilizing the capabilities of the Azure SDK. - Offers improved metadata handling for accurate offset tracking and seamless scalability. - Supports service principal authentication using client secrets. ## Features The Azure Cosmos DB Source V2 connector supports the following features: * **Topic to Container mapping**: The connector can map a container (table) to an individual Kafka topic (that is, `topic1#con1,topic2#con2`). * **At least once delivery**: This connector guarantees that records from the Kafka topic are delivered at least once. * **Supports multiple tasks**: The connector supports running one or more tasks. More tasks may improve performance. Note that one container (table) can be handled by one task. * **Offset management capabilities**: Supports offset management. For more information, see [Manage custom offsets](#cc-azure-cosmos-source-v2-custom-offsets). * **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-cosmosdb-source-v2-setup-connection). * **Provider integration support**: The connector supports Microsoft’s native identity authorization using Confluent Provider Integration. For more information about provider integration setup, see the [connector authentication](#cc-cosmosdb-source-v2-setup-connection). 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 Cosmos DB Source Connector](limits.md#azure-cosmos-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). ## Manage custom offsets You can manage the offsets for this connector. Offsets provide information on the point in the system from which the connector is accessing data. For more information, see [Manage Offsets for Fully Managed Connectors in Confluent Cloud](offsets.md#connect-custom-offsets). **To manage offsets**: - Manage offsets using Confluent Cloud APIs. For more information, see [Connect offsets API reference](https://docs.confluent.io/cloud/current/ccloud/offsets-connect-v-1/). #### NOTE The Azure Cosmos DB Source V2 connector allows reading from multiple containers using a single connector. In the following examples, the connector is reading from two different containers and writing to two different topics. Therefore, the offset is an array with two elements, each of which specifies a container and database name. ### Get the current offset To get the current offset, make a `GET` request that specifies the environment, Kafka cluster, and connector name. ```bash GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets Host: https://api.confluent.cloud ``` **Response:** Successful calls return HTTP `200` with a JSON payload that describes the offset. ```bash { "id": "connector-id", "name": "connector-name", "offsets": [ { "partition": { "connectorName": "connector-id", "database": "my-cosmos-db" }, "offset": { "containerRids": "[\"container1-rid\",\"container2-rid\"]" } }, { "partition": { "connectorName": "connector-id", "containerResourceId": "container1-rid", "database": "my-cosmos-db" }, "offset": { "feedRanges": "[\"feed-range1-base64\",\"feed-range2-base64\"]" } }, { "partition": { "connectorName": "connector-id", "containerResourceId": "container2-rid", "database": "my-cosmos-db" }, "offset": { "feedRanges": "[\"feed-range3-base64\"]" } }, { "partition": { "cosmos.source.container.resourceId": "container1-rid", "cosmos.source.database.name": "my-cosmos-db", "cosmos.source.feedRange": "feed-range1-base64" }, "offset": { "cosmos.source.feedRange.item.lsn": "lsn_1", "cosmos.source.feedRange.responseContinuation": "continuation1-base64" } }, { "partition": { "cosmos.source.container.resourceId": "container1-rid", "cosmos.source.database.name": "my-cosmos-db", "cosmos.source.feedRange": "feed-range2-base64" }, "offset": { "cosmos.source.feedRange.item.lsn": "lsn_2", "cosmos.source.feedRange.responseContinuation": "continuation2-base64" } }, { "partition": { "cosmos.source.container.resourceId": "container2-rid", "cosmos.source.database.name": "my-cosmos-db", "cosmos.source.feedRange": "feed-range3-base64" }, "offset": { "cosmos.source.feedRange.item.lsn": "lsn_3", "cosmos.source.feedRange.responseContinuation": "continuation3-base64" } } ], "metadata": { "observed_at": "2025-10-24T10:38:18.152293583Z" } } ``` Responses include the following information: - The position of latest offset. - The observed time of the offset in the metadata portion of the payload. The `observed_at` time indicates a snapshot in time for when the API retrieved the offset. A running connector is always updating its offsets. Use `observed_at` to get a sense for the gap between real time and the time at which the request was made. By default, offsets are observed every minute. Calling get repeatedly will fetch more recently observed offsets. - Information about the connector. ### Update the offset To update the offset, make a `POST` request that specifies the environment, Kafka cluster, and connector name. Include a JSON payload that specifies new offset and a patch type. ```bash POST /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request Host: https://api.confluent.cloud { "type": "PATCH", "offsets": [ { "partition": { "cosmos.source.container.resourceId": "container1-rid", "cosmos.source.database.name": "my-cosmos-db", "cosmos.source.feedRange": "feed-range1-base64" }, "offset": { "cosmos.source.feedRange.item.lsn": "20000", "cosmos.source.feedRange.responseContinuation": "continuation-base64" } } ] } ``` Considerations: - You can only make one offset change at a time for a given connector. - This is an asynchronous request. To check the status of this request, you must use the check offset status API. For more information, see **Get the status of an offset request**. - For source connectors, the connector attempts to read from the position defined by the requested offsets. **Response:** Successful calls return HTTP `202 Accepted` with a JSON payload that describes the offset. ```bash { "id": "connector-id", "name": "connector-name", "offsets": [ { "partition": { "cosmos.source.container.resourceId": "container1-rid", "cosmos.source.database.name": "my-cosmos-db", "cosmos.source.feedRange": "feed-range1-base64" }, "offset": { "cosmos.source.feedRange.item.lsn": "20000", "cosmos.source.feedRange.responseContinuation": "continuation-base64" } } ], "requested_at": "2025-10-24T10:38:45.606796307Z", "type": "PATCH" } ``` Responses include the following information: - The requested position of the offsets in the source. - The time of the request to update the offset. - Information about the connector. ### Delete the offset To delete the offset, make a `POST` request that specifies the environment, Kafka cluster, and connector name. Include a JSON payload that specifies the delete type. ```bash POST /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request Host: https://api.confluent.cloud { "type": "DELETE" } ``` Considerations: - This is an asynchronous request. To check the status of this request, you must use the check offset status API. For more information, see **Get the status of an offset request**. - Do not issue delete and patch requests at the same time. - If the offset you intend to delete is not found, the connector continues from where it left off. - If you want to start reading from the beginning with Azure Cosmos DB Source V2 connector, you must update the offset to set `cosmos.source.feedRange.item.lsn` to `"0"` for the desired feed ranges. **Response**: Successful calls return HTTP `202 Accepted` with a JSON payload that describes the result. ```bash { "id": "lcc-example123", "name": "{connector_name}", "offsets": [], "requested_at": "2024-03-28T17:59:45.606796307Z", "type": "DELETE" } ``` Responses include the following information: - Empty offsets. - The time of the request to delete the offset. - Information about Kafka cluster and connector. - The type of request. ### Get the status of an offset request To get the status of a previous offset request, make a `GET` request that specifies the environment, Kafka cluster, and connector name. ```bash GET /connect/v1/environments/{environment_id}/clusters/{kafka_cluster_id}/connectors/{connector_name}/offsets/request/status Host: https://api.confluent.cloud ``` Considerations: - The status endpoint always shows the status of the most recent PATCH/DELETE operation. **Response**: Successful calls return HTTP `200` with a JSON payload that describes the result. The following is an example of an applied patch. ```bash { "request": { "id": "connector-id", "name": "connector-name", "offsets": [ { "partition": { "cosmos.source.container.resourceId": "container1-rid", "cosmos.source.database.name": "my-cosmos-db", "cosmos.source.feedRange": "feed-range1-base64" }, "offset": { "cosmos.source.feedRange.item.lsn": "20000", "cosmos.source.feedRange.responseContinuation": "continuation-base64" } } ], "requested_at": "2025-10-24T10:38:45.606796307Z", "type": "PATCH" }, "status": { "phase": "APPLIED", "message": "The Connect framework-managed offsets for this connector have been altered successfully. However, if this connector manages offsets externally, they will need to be manually altered in the system that the connector uses." }, "previous_offsets": [ { "partition": { "cosmos.source.container.resourceId": "container1-rid", "cosmos.source.database.name": "my-cosmos-db", "cosmos.source.feedRange": "feed-range1-base64" }, "offset": { "cosmos.source.feedRange.item.lsn": "lsn_1", "cosmos.source.feedRange.responseContinuation": "continuation1-base64" } } ], "applied_at": "2025-10-24T10:38:48.079141883Z" } ``` Responses include the following information: - The original request, including the time it was made. - The status of the request: applied, pending, or failed. - The time you issued the status request. - The previous offsets. These are the offsets that the connector last updated prior to updating the offsets. Use these to try to restore the state of your connector if a patch update causes your connector to fail or to return a connector to its previous state after rolling back. ### JSON payload The table below offers a description of the unique fields in the JSON payload for managing offsets of the CosmosDB Source V2 connector. | Field | Definition | Required/Optional | |------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| | `connectorName` | The connector ID. Used in the top-level partition entry that tracks all containers. | Required | | `database` | The value from `azure.cosmos.source.database.name` in the connector configuration. | Required | | `containerRids` | A JSON-encoded array of container resource IDs tracked by the connector. | Required | | `containerResourceId` | The resource ID of a container, used in the partition entry that tracks feed ranges for that container. | Required | | `feedRanges` | A JSON-encoded array of base64-encoded feed range tokens for a given container. | Required | | `cosmos.source.container.resourceId` | The resource ID of the container for a specific feed range partition entry. | Required | | `cosmos.source.database.name` | The database name for a specific feed range partition entry. | Required | | `cosmos.source.feedRange` | The base64-encoded feed range token identifying the partition range within the container. | Required | | `cosmos.source.feedRange.item.lsn` | The log sequence number (LSN) tracking the connector’s position within the feed range. Set to `"0"` to reprocess from the beginning of that feed range. | Required | | `cosmos.source.feedRange.responseContinuation` | The continuation token for the change feed response within the feed range. | Required | ## Quick Start Use this quick start to get up and running with the Confluent Cloud Azure Cosmos DB Source V2 connector. The quick start provides the basics of selecting the connector and configuring it to stream events from a database to Kafka. 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). - Authorized access to read data Azure Cosmos. For more information, see [Secure access to data in Azure Cosmos DB](https://docs.microsoft.com/en-us/azure/cosmos-db/secure-access-to-data). - The Azure Cosmos DB is configured to use the Core (SQL) API. ![Use Core SQL API](images/ccloud-azure-cosmos-source-core-sql.png) ### 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 Cosmos DB Source V2** connector card. ![Azure Cosmos DB Source V2 Connector Card](images/ccloud-azure-cosmos-source-v2-icon.png) #### Step 4: Enter the connector details #### NOTE * Make sure you have all your [prerequisites](#cc-azure-cosmos-source-v2-prereqs) completed. * An asterisk ( \* ) designates a required entry. At the **Add Azure Cosmos DB Source V2 Connector** screen, complete the following: ### 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**: Under **Azure credentials**, select how you want to authenticate with the database. Your options are: - If you select **Master Key**, enter the following details: * **Cosmos endpoint**: The Cosmos endpoint URL. For example, `https://connect-cosmosdb.documents.azure.com:443/`. * **Cosmos database name**: The name of your Cosmos database. * **Cosmos DB account key**: Enter the account key of the database. - If you select **Microsoft Entra ID application**, enter the following details: * Under the **Provider integration** dropdown, select an existing integration name that has access to your Azure resource required to run this connector. For more information, see [Manage an Microsoft Azure Provider Integration](provider-integration.md#connector-az-pi). * **Cosmos endpoint**: The Cosmos endpoint URL. For example, `https://connect-cosmosdb.documents.azure.com:443/`. * **Cosmos database name**: The name of your Cosmos database. - If you select **Service Principal**, enter the following Cosmos DB connection details: * **Cosmos endpoint**: The Cosmos endpoint URL. For example, `https://connect-cosmosdb.documents.azure.com:443/`. * **Cosmos database name**: The name of your Cosmos database. * **ClientID/ApplicationID**: Enter the clientID/applicationID of the account. * **Client secret/password**: Enter the client secret/password of the account. * **TenantID**: Enter the tenantID of the account. - **Use secret manager**: Fetch sensitive configuration values from a secret manager. **Azure credentials** - **Provider Integration**: Select an existing integration name that has access to your Azure resource required to run this connector. Required for `Microsoft Entra ID application` authentication method. **Secret manager configuration** - **Secret manager**: Select the secret manager to use for retrieving 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 name that has access to your Azure resource required to run this connector. Required for `Microsoft Entra ID application` authentication method. **Connect to your Cosmos DB database** - **Cosmos endpoint**: Specify the Cosmos endpoint URL. For example: `https://connect-cosmosdb.documents.azure.com:443/`. - **Cosmos DB database name**: Specify the Cosmos database to read records from. **Account details** - **Cosmos DB account key**: Cosmos DB account key. Required for `Master Key` authentication method. - **ClientId/applicationId of service principal**: The clientId/ApplicationId of the service principal. Required for `Service Principal` authentication method. - **Client secret/password of service principal**: The client secret/password of the service principal. Required for `Service Principal` authentication method. - **TenantId of Cosmos DB account**: The tenantId of the Cosmos DB account. Required for `Service Principal` authentication method. 2. Click **Continue**. ### Configuration **Output messages** - **Output Kafka record value format**: Select the output record value format (data going to the Kafka topic). Valid entries are AVRO, 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). **Container details** - **Cosmos container topic map**: A comma-delimited list of Kafka topics mapped to Cosmos containers. For example: `topic1#con1,topic2#con2`. The field accepts regex pattern `*[\\w.-]+ *#[^,]+(, *[\\w.-]+ *#[^,]+)*`. - **Include all containers**: Flag to indicate whether the connector reads from all containers or not. Default value is `false`. - **Containers included**: Specifies the containers from which the connector reads data. The connector ignores this field if **Include all containers** is set to `true`. **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 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. - **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 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 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. - **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 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 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. **Account details** - **Azure environment of Cosmos DB account**: The particular Azure cloud environment in which your Cosmos DB account resides. Possible values are: `Azure`, `AzureChina`, `AzureUsGovernment`, `AzureGermany`. Defaults to `azure`. - **Gateway mode**: Flag to indicate whether to use gateway mode. By default it is `false`, means SDK uses [direct mode](https://learn.microsoft.com/azure/cosmos-db/nosql/sdk-connection-modes"). - **Preferred regions list**: Preferred regions list to be used for a multi region Cosmos DB account. This is a comma separated value, like `[East US, West US]` or `East US, West US`. Confluent Community uses provided preferred regions as a hint. You should use a collocated kafka cluster with your Cosmos DB account and pass the kafka cluster region as preferred region. See [List of azure regions](https://docs.microsoft.com/dotnet/api/microsoft.azure.documents.locationnames?view=azure-dotnet&preserve-view=true). **Metadata details** - **Metadata polling delay in ms**: The frequency, in milliseconds, at which the connector checks for metadata changes, such as container splits, merges, or recreations. If changes are detected, the connector reconfigures the tasks. The default value is 5 minutes (`300000` ms). - **Storage source of metadata**: The storage type of the metadata. Supported values are `Cosmos` and `Kafka`. - **Metadata storage name Prefix**: The resource name of the metadata storage prefix. If metadata storage type is Kafka topic, then this config refers to kafka topic name, the metadata topic will be created if it does not already exist, else it will use the pre-created topic. If metadata storage type is `Cosmos`, then this config refers to container name, for `MasterKey` auth, this container will be created with `AutoScale` with 4000 RU if not already exists, for `ServicePrincipal` auth, it requires the container to be created ahead of time . - **Metadata storage name (override)**: Optional. Specify the full metadata storage name. If specified, this value overrides the default prefix-based naming convention. If metadata storage type is `Kafka`, enter the Kafka topic name. If the type is `Cosmos`, enter the container name. To use the default naming convention (prefix + connector ID), leave this field empty. **Message key details** - **Kafka record message key enabled**: Whether to set the kafka record message key. Default value is `true`. - **Kafka message key field**: TThe document field to use for the Kafka message key if the default key `id` is not used. **ChangeFeed details** - **Maximum number hint of documents returned in single request**: The maximum number of documents returned in a single change feed request. But the number of items received might be higher than the specified value if multiple items are changed by the same transaction. The default is `1000`. - **ChangeFeed mode**: Select the ChangeFeed mode: `LatestVersion` or `AllVersionsAndDeletes`. - **Change feed start from**: The ChangeFeed Start from settings. Possible values are: `Now`, `Beginning` or a certain point in time (UTC) for example `2020-02-10T14:15:03`. The default value is `Beginning`. **Throughput control details** - **Enable throughput control**: A flag to indicate whether throughput control is enabled. When set to `True`, the throughput control is enabled. The default value is set to `False`. - **Cosmos auth type**: Select an auth type from the two currently supported: * **MasterKey** (`PrimaryReadWriteKeys`, `SecondReadWriteKeys`, `PrimaryReadOnlyKeys`, `SecondReadWriteKeys`) * **ServicePrincipal** - **Cosmos DB throughput control account key**: Cosmos DB throughput control account key. Required for `MasterKey` authentication. - **ClientId/applicationId of service principal**: The clientId/applicationId of the service principal. Required for `ServicePrincipal` authentication. - **Client secret/password of service principal**: The client secret/password of the service principal. Required for `ServicePrincipal` authentication. - **TenantId of Cosmos DB account**: The tenantId of the Cosmos DB account. Required for `ServicePrincipal` authentication. - **Azure environment of Cosmos DB account**: The particular Azure cloud environment in which your Cosmos DB account resides. Possible values are: `Azure`, `AzureChina`, `AzureUsGovernment`, `AzureGermany`. Defaults to `azure`. - **Cosmos DB throughput control account endpoint uri**: Cosmos DB throughput control account endpoint uri. - **Gateway mode for throughput control**: Flag to indicate whether to use gateway mode. By default it is `false`, means SDK uses direct mode. For more information, see [SDK Connection Modes](https://learn.microsoft.com/azure/cosmos-db/nosql/sdk-connection-modes) on Microsoft’s documentation. - **Preferred regions list for throughput control database account**: Preferred regions list to be used for a multi region Cosmos DB account. This is a comma separated value, for example `[East US, West US]` or `East US, West US` provided preferred regions will be used as a hint. You should use a collocated kafka cluster with your Cosmos DB account and pass the kafka cluster region as preferred region. For more information, see [List of azure regions](https://docs.microsoft.com/dotnet/api/microsoft.azure.documents.locationnames?view=azure-dotnet&preserve-view=true). - **Throughput control group name**: Throughput control group name. Since customer is allowed to create many groups for a container, the name should be unique. - **Throughput control group target throughput**: Throughput control group target throughput. The value should be larger than 0. - **Throughput control group target throughput threshold**: Throughput control group target throughput threshold. The value should be between (0,1]. - **Throughput control group priority level**: Throughput control group priority level. The value can be None, High or Low. - **Database for throughput global control**: Database which will be used for throughput global control. - **Container for throughput global control**: Container which will be used for throughput global control. - **Throughput control client RU usage update interval**: This controls how often the client is going to update the throughput usage of itself and adjust its own throughput share based on the throughput usage of other clients. Default is 5s, the allowed min value is 5s. - **Throughput control client expire interval**: This controls how quickly we will detect the client has been offline and hence allow its throughput share to be taken by other clients. Default is 11s, the allowed min value is 2 \* `renewIntervalInMS` + 1. **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). For all property and value definitions, see [Configuration Properties](#cc-azure-cosmos-source-v2-config-properties). - 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. After 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 files. Verify that data is being produced in Kafka. 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 To set up and run the connector using the Confluent CLI, complete the following steps. #### NOTE Make sure you have all your [prerequisites](#cc-azure-cosmos-source-v2-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 { "name": "CosmosDbSourceV2Connector_0", "config": { "connector.class": "CosmosDbSourceV2", "name": "CosmosDbSourceV2Connector_0", "tasks.max": "1", "output.data.format": "JSON_SR", "kafka.auth.mode": "KAFKA_API_KEY", "kafka.api.key": "****************", "kafka.api.secret": "**********************************", "azure.cosmos.account.endpoint":"{endpoint}", "azure.cosmos.account.key":"{masterKey}", "azure.cosmos.source.database.name":"{database}", "azure.cosmos.source.containers.includedList":"{container}", "azure.cosmos.source.containers.includeAll": "false", "azure.cosmos.source.containers.topicMap":"{topic}#{container}" } } ``` Note the following property definitions: * `"connector.class"`: Identifies the connector plugin name. * `"name"`: Sets a name for your new connector. * `"connect.cosmos.containers.topicmap"`: Enter a comma-delimited list of Kafka topics mapped to Cosmos containers. For example: `topic1#con1,topic2#con2`. The field accepts regex pattern `*[\\w.-]+ *#[^,]+(, *[\\w.-]+ *#[^,]+)*`. * `"output.data.format"` (data going to the Kafka topic): Supports AVRO, 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_SR (JSON Schema), or Protobuf). * `"connect.cosmos.messagekey.enabled"`: Whether or not to set a Kafka message key. Defaults to `id`. To set a different field for the message key, add the configuration property `connect.cosmos.messagekey.field`. * `"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 ``` * `"tasks.max"`: Enter the maximum number of [tasks](/platform/current/connect/concepts.html#tasks) for the connector to use. More tasks may improve performance. #### 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-cosmos-source-v2-config-properties) for all property values and descriptions. #### Step 3: 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-cosmos-source-v2-config.json ``` Example output: ```none Created connector CosmosDbSourceV2Connector_0 lcc-do6vzd ``` #### Step 4: 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 |CosmosDbSourceV2Connector_0 | RUNNING | Source | | ``` #### Step 5: Check for files. Verify that data is being produced in Kafka. 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). ### Authentication method `authentication.method` : How Confluent Cloud authenticates with Azure.
* Type: string * Default: Master 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 ### Azure credentials `provider.integration.id` : Azure provider-integration to mint Microsoft Entra ID application tokens.
* Type: string * Importance: high ### 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 ### Connect to your Cosmos DB database `azure.cosmos.account.endpoint` : Cosmos endpoint URL. For example: [https://connect-cosmosdb.documents.azure.com:443/](https://connect-cosmosdb.documents.azure.com:443/).
* Type: string * Importance: high `azure.cosmos.source.database.name` : Name of the database to read from.
* Type: string * Importance: high ### Account details `azure.cosmos.account.environment` : The azure environment of the Cosmos DB account: Azure, AzureChina, AzureUsGovernment, AzureGermany.
* Type: string * Default: AZURE * Valid Values: AZURE, AZURE_CHINA, AZURE_CHINA, AZURE_GERMANY, AZURE_US_GOVERNMENT * Importance: medium `azure.cosmos.mode.gateway` : Flag to indicate whether to use gateway mode. By default it is false, means SDK uses direct mode. [https://learn.microsoft.com/azure/cosmos-db/nosql/sdk-connection-modes](https://learn.microsoft.com/azure/cosmos-db/nosql/sdk-connection-modes)
* Type: boolean * Default: false * Importance: low `azure.cosmos.preferredRegionList` : Preferred regions list to be used for a multi region Cosmos DB account. This is a comma separated value (e.g., [East US, West US] or East US, West US) provided preferred regions will be used as hint. You should use a collocated kafka cluster with your Cosmos DB account and pass the kafka cluster region as preferred region. See list of azure regions - [https://docs.microsoft.com/dotnet/api/microsoft.azure.documents.locationnames?view=azure-dotnet&preserve-view=true](https://docs.microsoft.com/dotnet/api/microsoft.azure.documents.locationnames?view=azure-dotnet&preserve-view=true).
* Type: string * Importance: low `azure.cosmos.account.key` : Cosmos DB account key (only required in case of auth.type as MasterKey).
* Type: password * Importance: medium `azure.cosmos.auth.aad.clientId` : The clientId/ApplicationId of the service principal. Required for ServicePrincipal authentication.
* Type: string * Importance: medium `azure.cosmos.auth.aad.clientSecret` : The client secret/password of the service principal. Required for ServicePrincipal authentication.
* Type: password * Importance: medium `azure.cosmos.account.tenantId` : The tenantId of the Cosmos DB account. Required for ServicePrincipal authentication.
* Type: string * Default: “” * Importance: medium ### Output messages `output.data.format` : Sets the output Kafka record value format. Valid entries are AVRO, JSON_SR, or PROTOBUF. Note that you need to have Confluent Cloud Schema Registry configured when using a schema-based message format like AVRO, JSON_SR, and PROTOBUF.
* Type: string * Default: JSON_SR * Valid Values: AVRO, JSON_SR, PROTOBUF * Importance: high ### Container details `azure.cosmos.source.containers.topicMap` : A comma delimited list of Kafka topics mapped to Cosmos containers. For example: topic1#con1,topic2#con2. By default, the container name is used as the name of the Kafka topic to publish data to, but you can use this property to override the default configuration.
* Type: string * Valid Values: Must match the regex `\s*[\w.-]+ *#[^,]+(, *[\w.-]+ *#[^,]+)*` * Importance: medium `azure.cosmos.source.containers.includeAll` : Flag to indicate whether reading from all containers.
* Type: boolean * Default: false * Importance: high `azure.cosmos.source.containers.includedList` : Containers included. This config will be ignored if kafka.connect.cosmos.source.containers.includeAll is true.
* Type: string * Importance: medium ### Throughput control details `azure.cosmos.throughputControl.enabled` : A flag to indicate whether throughput control is enabled.
* Type: boolean * Default: false * Importance: medium `azure.cosmos.throughputControl.auth.type` : There are two auth types are supported currently: MasterKey\`(PrimaryReadWriteKeys, SecondReadWriteKeys, PrimaryReadOnlyKeys, SecondReadWriteKeys), \`ServicePrincipal
* Type: string * Default: MasterKey * Valid Values: MasterKey, ServicePrincipal * Importance: low `azure.cosmos.throughputControl.account.key` : Cosmos DB throughput control account key (only required in case of throughputControl.auth.type as MasterKey)
* Type: password * Importance: low `azure.cosmos.throughputControl.auth.aad.clientId` : The clientId/applicationId of the service principal. Required for ServicePrincipal authentication.
* Type: string * Importance: low `azure.cosmos.throughputControl.auth.aad.clientSecret` : The client secret/password of the service principal. Required for ServicePrincipal authentication.
* Type: password * Importance: low `azure.cosmos.throughputControl.account.tenantId` : The tenantId of the Cosmos DB account. Required for ServicePrincipal authentication.
* Type: string * Importance: low `azure.cosmos.throughputControl.account.environment` : The azure environment of the Cosmos DB account: Azure, AzureChina, AzureUsGovernment, AzureGermany.
* Type: string * Default: AZURE * Valid Values: AZURE, AZURE_CHINA, AZURE_GERMANY, AZURE_US_GOVERNMENT * Importance: low `azure.cosmos.throughputControl.account.endpoint` : Cosmos DB throughput control account endpoint uri.
* Type: string * Importance: low `azure.cosmos.throughputControl.mode.gateway` : Flag to indicate whether to use gateway mode. By default it is false, means SDK uses direct mode. [https://learn.microsoft.com/azure/cosmos-db/nosql/sdk-connection-modes](https://learn.microsoft.com/azure/cosmos-db/nosql/sdk-connection-modes)
* Type: boolean * Default: false * Importance: low `azure.cosmos.throughputControl.preferredRegionList` : Preferred regions list to be used for a multi region Cosmos DB account. This is a comma separated value (e.g., [East US, West US] or East US, West US) provided preferred regions will be used as hint. You should use a collocated kafka cluster with your Cosmos DB account and pass the kafka cluster region as preferred region. See list of azure regions - [https://docs.microsoft.com/dotnet/api/microsoft.azure.documents.locationnames?view=azure-dotnet&preserve-view=true](https://docs.microsoft.com/dotnet/api/microsoft.azure.documents.locationnames?view=azure-dotnet&preserve-view=true)
* Type: string * Importance: low `azure.cosmos.throughputControl.group.name` : Throughput control group name. Since customer is allowed to create many groups for a container, the name should be unique.
* Type: string * Importance: medium `azure.cosmos.throughputControl.targetThroughput` : Throughput control group target throughput. The value should be larger than 0.
* Type: int * Valid Values: [1,…] * Importance: medium `azure.cosmos.throughputControl.targetThroughputThreshold` : Throughput control group target throughput threshold. The value should be between (0,1].
* Type: double * Importance: medium `azure.cosmos.throughputControl.priorityLevel` : Throughput control group priority level. The value can be None, High or Low.
* Type: string * Default: None * Valid Values: High, Low, None * Importance: medium `azure.cosmos.throughputControl.globalControl.database.name` : Database which will be used for throughput global control.
* Type: string * Importance: medium `azure.cosmos.throughputControl.globalControl.container.name` : Container which will be used for throughput global control.
* Type: string * Importance: medium `azure.cosmos.throughputControl.globalControl.renewIntervalInMS` : This controls how often the client is going to update the throughput usage of itself and adjust its own throughput share based on the throughput usage of other clients. Default is 5s, the allowed min value is 5s.
* Type: int * Default: 5000 * Valid Values: [5000,…] * Importance: low `azure.cosmos.throughputControl.globalControl.expireIntervalInMS` : This controls how quickly we will detect the client has been offline and hence allow its throughput share to be taken by other clients. Default is 11s, the allowed min value is 2 \* renewIntervalInMS + 1
* Type: int * Importance: low ### Number of tasks for this connector `tasks.max` : Maximum number of tasks for the connector.
* Type: int * Valid Values: [1,…] * Importance: high ### Metadata details `azure.cosmos.source.metadata.poll.delay.ms` : Indicates how often to check the metadata changes (including container split/merge, adding/removing/recreated containers). When changes are detected, it will reconfigure the tasks. Default is 5 minutes
* Type: int * Default: 300000 (5 minutes) * Valid Values: [1,…] * Importance: medium `azure.cosmos.source.metadata.storage.type` : The storage type of the metadata. Two types are supported: Cosmos, Kafka.
* Type: string * Default: Kafka * Valid Values: Cosmos, Kafka * Importance: medium `azure.cosmos.source.metadata.storage.name.prefix` : The resource name prefix of the metadata storage. By default, the full name is computed as prefix + connector ID. If metadata storage type is Kafka, this refers to the kafka topic name prefix. If metadata storage type is Cosmos, this refers to the container name prefix. Use the override field below to specify a custom full name instead.
* Type: string * Default: cosmos.metadata.topic * Importance: medium `azure.cosmos.source.metadata.storage.name.override` : Optional. Specify the full metadata storage name. If specified, this value overrides the default prefix-based naming convention. If metadata storage type is Kafka, enter the Kafka topic name. If Cosmos, enter the container name. To use the default naming convention (prefix + connector ID), leave this field empty.
* Type: string * Default: “” * Importance: medium ### Message key details `azure.cosmos.source.messageKey.enabled` : Whether to set the kafka record message key.
* Type: boolean * Default: true * Importance: medium `azure.cosmos.source.messageKey.field` : The document field to use as the message key.
* Type: string * Default: id * Importance: high ### ChangeFeed details `azure.cosmos.source.changeFeed.mode` : ChangeFeed mode (LatestVersion or AllVersionsAndDeletes)
* Type: string * Default: LatestVersion * Valid Values: AllVersionsAndDeletes, LatestVersion * Importance: high `azure.cosmos.source.changeFeed.startFrom` : ChangeFeed Start from settings (Now, Beginning or a certain point in time (UTC) for example 2020-02-10T14:15:03) - the default value is `Beginning`.
* Type: string * Default: Beginning * Importance: high `azure.cosmos.source.changeFeed.maxItemCountHint` : The maximum number of documents returned in a single change feed request. But the number of items received might be higher than the specified value if multiple items are changed by the same transaction. The default is 1000.
* Type: int * Default: 1000 * Valid Values: [1,…] * 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. 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 Cosmos DB Source V2 connector for Confluent Cloud. ### How do I connect to Azure Cosmos DB using service principal authentication? The connector supports service principal authentication using Confluent Provider Integration for enhanced security. To set up service principal authentication: 1. **Create Azure service principal**: In the Azure portal, create a service principal with appropriate permissions: Navigate to **Azure Active Directory > App registrations > New registration**. 2. **Grant Cosmos DB permissions**: Assign the service principal `Cosmos DB Account Reader Role` and `Cosmos DB Operator` roles: In your Cosmos DB account, go to **Access control (IAM)** and add role assignments. 3. **Configure provider integration**: In the Cloud Console, set up the provider integration: * Navigate to **Connections > Provider integrations** * Create a new Azure provider integration * Provide the service principal credentials: client ID, tenant ID, and client secret 4. **Configure the connector**: Use provider integration authentication: ```json { "azure.cosmos.auth.type": "SERVICE_PRINCIPAL", "azure.cosmos.account.endpoint": "https://your-account.documents.azure.com:443/", "provider.integration.id": "your-provider-integration-id" } ``` #### IMPORTANT Service principal authentication is more secure than master key authentication and supports role-based access control. It is the recommended authentication method for production environments. ### How do I configure container to topic mapping? The connector uses the `azure.cosmos.source.containers.topicMap` property to map Cosmos DB containers to Kafka topics. Configure container mapping using the following options: 1. **Map specific containers to topics**: Use the format `topic#container`: ```json { "azure.cosmos.source.containers.topicMap": "users-topic#users-container,orders-topic#orders-container", "azure.cosmos.source.containers.includeAll": "false" } ``` This maps `users-container` to `users-topic` and `orders-container` to `orders-topic`. 2. **Include all containers**: Set `includeAll` to `true` to monitor all containers: ```json { "azure.cosmos.source.containers.includeAll": "true" } ``` Topics are automatically created using container names. 3. **Filter specific containers**: Use `includedList` to specify which containers to monitor: ```json { "azure.cosmos.source.containers.includedList": "users-container,orders-container", "azure.cosmos.source.containers.includeAll": "false" } ``` #### IMPORTANT The topic mapping format must follow the pattern `topic#container`. Multiple mappings are comma-separated. Each container can only be mapped to one topic. ### Why is my connector not reading changes from Cosmos DB? The connector uses the Azure Cosmos DB change feed pull model to capture changes. Missing changes can indicate configuration or permission issues. Common causes and solutions: 1. **Change feed not enabled**: Ensure the change feed is available for your Cosmos DB account: The change feed is automatically available for Cosmos DB SQL API accounts. Verify you are using the SQL API. 2. **Insufficient permissions**: The service principal or master key must have read access: Grant `Cosmos DB Account Reader Role` to the service principal, or verify the master key is correct. 3. **Offset position issue**: The connector may be starting from an incorrect offset: Check the current offset position using the offset management API. The V2 connector uses `cosmos.source.feedRange.item.lsn` to track position within each feed range. To reprocess data for a specific feed range, set its `lsn` value to `"0"` in the offsets. A single container may have multiple feed ranges, each with its own LSN — update only the feed ranges you want to reprocess. 4. **Throughput limits**: Request unit (RU) limits may throttle reads: Monitor Cosmos DB metrics for throttling. Increase provisioned throughput or use autoscale. 5. **Container filtering**: Verify the container is included in the configuration: Check `azure.cosmos.source.containers.includedList` or `azure.cosmos.source.containers.topicMap` settings. #### NOTE By default (`LatestVersion` mode), the change feed captures insert and update operations only. To also capture delete operations, set `azure.cosmos.source.changeFeed.mode` to `AllVersionsAndDeletes`. ### How can I optimize connector performance and throughput? Performance depends on Cosmos DB throughput, connector task configuration, and network latency. To optimize performance, consider the following: 1. **Increase tasks**: The V2 connector supports multiple containers per task: ```json { "tasks.max": "4" } ``` More tasks can improve performance when reading from multiple containers. 2. **Configure throughput control**: Control the rate of data ingestion: ```json { "azure.cosmos.throughputControl.enabled": "true", "azure.cosmos.throughputControl.targetThroughputThreshold": "0.8" } ``` This limits the connector to using 80% of the available throughput, preventing RU exhaustion. 3. **Optimize Cosmos DB throughput**: Ensure adequate Request Units (RUs): * **Use autoscale**: Configure autoscale to handle variable workloads * **Monitor RU consumption**: Check Cosmos DB metrics for throttling * **Increase provisioned throughput**: Allocate more Request Units if throttling occurs 4. **Use same region**: Deploy the connector in the same Azure region as Cosmos DB: Cross-region reads have higher latency and cost more. 5. **Batch size configuration**: The connector automatically manages batch sizes: The V2 connector optimizes batch sizes based on available throughput. #### NOTE The throughput control feature helps prevent the connector from consuming all available RUs, leaving capacity for other operations. ### How do I reset or modify connector offsets? The connector supports offset management to reset or modify the starting point for data ingestion. To view, reset, or modify connector offsets, see [Manage custom offsets](#cc-azure-cosmos-source-v2-custom-offsets). #### IMPORTANT Resetting offsets causes the connector to re-read data, which may result in duplicate records in your Kafka topics. The V2 connector tracks offsets per feed range using `cosmos.source.feedRange.item.lsn`. To reprocess data, set the `lsn` value to `"0"` for the desired feed ranges. A single container may have multiple feed ranges — update only the ones you need. Always save a backup of current offsets before making changes. ### Why is my connector failing with authentication errors? Authentication errors indicate issues with master key or service principal credentials. ```text Unauthorized: The input authorization token can't serve the request ``` Common causes and solutions: 1. **Invalid master key**: The `azure.cosmos.account.key` is incorrect: Verify the master key in the Azure portal under **Keys** in your Cosmos DB account settings. 2. **Service principal permissions**: The service principal lacks required permissions: Grant the following roles: * **Cosmos DB Account Reader Role**: Read account metadata * **Cosmos DB Operator**: Access data and metadata 3. **Expired credentials**: Service principal client secret has expired: Rotate the client secret in Azure Active Directory and update the provider integration. 4. **Wrong account endpoint**: The endpoint URL is incorrect: Verify the endpoint format: ```json { "azure.cosmos.account.endpoint": "https://your-account.documents.azure.com:443/" } ``` #### IMPORTANT Master keys provide full access to the Cosmos DB account. For production environments, use service principal authentication with least-privilege permissions. ### How do I handle schema evolution in Cosmos DB documents? Cosmos DB is schemaless, but the connector generates schemas for Kafka topics based on document structure. The connector handles schema as follows: 1. **Enable |sr|**: Use schema-based formats for schema evolution support: ```json { "output.data.format": "JSON_SR" } ``` Alternatively, use `AVRO` or `PROTOBUF` formats. 2. **Schema inference**: The connector infers schemas from document structure: When documents have varying fields, the connector creates a schema that accommodates all fields encountered. 3. **Schema Registry compatibility**: Configure compatibility mode in Schema Registry: * **FORWARD**: Allows adding new fields * **BACKWARD**: Allows removing fields * **FULL**: Allows both adding and removing fields 4. **Handle missing fields**: Documents may not have all fields: The connector sets missing fields to `null` in the Kafka record. #### NOTE For JSON (schemaless) output format, schema evolution is not enforced. Consider using JSON_SR for better schema management. ### What should I do if my connector keeps failing or restarting? Frequent connector failures indicate configuration issues, network problems, or Cosmos DB capacity constraints. Common causes and solutions: 1. **Check connector logs**: In the Cloud Console, review error messages: * **Authentication failures**: Verify credentials and permissions * **Throttling errors**: Check RU consumption and increase throughput * **Network errors**: Verify network connectivity * **Configuration errors**: Check container names and mapping 2. **Verify Cosmos DB connectivity**: Test that Cosmos DB is accessible: * **Check firewall rules**: Ensure Confluent Cloud can connect to Cosmos DB * **Verify endpoint**: Confirm the account endpoint is correct * **Test credentials**: Use Azure portal to verify account access 3. **Monitor Cosmos DB metrics**: Check for resource constraints: * **RU consumption**: Monitor Request Unit usage and throttling * **Storage capacity**: Ensure adequate storage * **Network latency**: Check for network issues 4. **Verify container configuration**: Ensure containers exist and are accessible: Check that containers listed in `includedList` or `topicMap` exist in the database. 5. **Check throughput control**: If enabled, verify settings are appropriate: ```json { "azure.cosmos.throughputControl.targetThroughputThreshold": "0.8" } ``` #### IMPORTANT For persistent failures, use the connector diagnostics feature and share logs with Confluent Support. ## 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)