title	Apache Kafka output binding for Azure Functions
description	Use Azure Functions to write messages to an Apache Kafka stream.
ms.topic	reference
ms.custom	devx-track-extended-java, devx-track-js, devx-track-python
ms.date	12/11/2025
zone_pivot_groups	programming-languages-set-functions

Apache Kafka output binding for Azure Functions

The output binding enables an Azure Functions app to send messages to a Kafka topic.

[!INCLUDE functions-binding-kafka-plan-support-note]

Example

::: zone pivot="programming-language-csharp"

How you use the binding depends on the C# modality in your function app. You can use one of the following modalities:

Isolated worker model

A compiled C# function that uses an isolated worker process class library that runs in a process that's separate from the runtime.

In-process model

[!INCLUDE functions-in-process-model-retirement-note]

A compiled C# function that uses an in-process class library that runs in the same process as the Functions runtime.

The attributes you use depend on the specific event provider.

Confluent

The following example shows a C# function that sends a single message to a Kafka topic, using data provided in an HTTP GET request.

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet/Confluent/KafkaOutput.cs" range="12-32" :::

To send events in a batch, use an array of KafkaEventData objects, as shown in the following example:

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet/Confluent/KafkaOutputMany.cs" range="12-30" :::

The following function adds headers to the Kafka output data:

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet/Confluent/KafkaOutputWithHeaders.cs" range="11-31" :::

For a complete set of working .NET examples, see the Kafka extension repository.

Event Hubs

The following example shows a C# function that sends a single message to a Kafka topic, using data provided in an HTTP GET request.

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet/EventHub/KafkaOutput.cs" range="11-31" :::

To send events in a batch, use an array of KafkaEventData objects, as shown in the following example:

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet/EventHub/KafkaOutputMany.cs" range="12-30" :::

The following function adds headers to the Kafka output data:

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet/EventHub/KafkaOutputWithHeaders.cs" range="11-31" :::

For a complete set of working .NET examples, see the Kafka extension repository.

Confluent

The following example uses a custom return type named MultipleOutputType, which consists of an HTTP response and a Kafka output.

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet-isolated/confluent/KafkaOutput.cs" range="11-31" :::

In the MultipleOutputType class, Kevent is the output binding variable for the Kafka binding.

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet-isolated/confluent/KafkaOutput.cs" range="34-46" :::

To send a batch of events, pass a string array to the output type, as shown in the following example:

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet-isolated/confluent/KafkaOutputMany.cs" range="11-30" :::

The string array is defined as the Kevents property on the class, and the output binding is defined on this property:

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet-isolated/confluent/KafkaOutputMany.cs" range="33-45" :::

The following function adds headers to the Kafka output data:

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet-isolated/Confluent/KafkaOutputWithHeaders.cs" range="11-31" :::

For a complete set of working .NET examples, see the Kafka extension repository.

Event Hubs

The following example uses a custom return type named MultipleOutputType, which consists of an HTTP response and a Kafka output.

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet-isolated/eventhub/KafkaOutput.cs" range="11-31" :::

In the MultipleOutputType class, Kevent is the output binding variable for the Kafka binding.

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet-isolated/eventhub/KafkaOutput.cs" range="34-46" :::

To send a batch of events, pass a string array to the output type, as shown in the following example:

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet-isolated/eventhub/KafkaOutputMany.cs" range="11-30" :::

The string array is defined as the Kevents property on the class, and the output binding is defined on this property:

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet-isolated/eventhub/KafkaOutputMany.cs" range="33-45" :::

The following function adds headers to the Kafka output data:

:::code language="csharp" source="~/azure-functions-kafka-extension/samples/dotnet-isolated/eventhub/KafkaOutputWithHeaders.cs" range="11-31" :::

For a complete set of working .NET examples, see the Kafka extension repository.

::: zone-end
::: zone pivot="programming-language-javascript,programming-language-typescript" The usage of the output binding depends on your version of the Node.js programming model.

Version 4

In the Node.js v4 model, you define your output binding directly in your function code. For more information, see the Azure Functions Node.js developer guide.

Version 3

In the Node.js v3 model, you define your output binding in a function.json file with your code. For more information, see the Azure Functions Node.js developer guide.

In these examples, the event providers are either Confluent or Azure Event Hubs. These examples show a Kafka output binding for a function that an HTTP request triggers and sends data from the request to the Kafka topic. ::: zone-end ::: zone pivot="programming-language-javascript"

Confluent

import {
  app,
  HttpRequest,
  HttpResponseInit,
  InvocationContext,
  output,
} from "@azure/functions";

const kafkaOutput = output.generic({
  type: "kafka",
  direction: "out",
  topic: "topic",
  brokerList: "%BrokerList%",
  username: "ConfluentCloudUsername",
  password: "ConfluentCloudPassword",
  protocol: "saslSsl",
  authenticationMode: "plain",
});

export async function kafkaOutputWithHttp(
  request: HttpRequest,
  context: InvocationContext
): Promise<HttpResponseInit> {
  context.log(`Http function processed request for url "${request.url}"`);

  const body = await request.text();
  const queryName = request.query.get("name");
  const parsedbody = JSON.parse(body);
  const name = queryName || parsedbody.name || "world";
  context.extraOutputs.set(kafkaOutput, `Hello, ${parsedbody.name}!`);
  context.log(
    `Sending message to kafka: ${context.extraOutputs.get(kafkaOutput)}`
  );
  return {
    body: `Message sent to kafka with value: ${context.extraOutputs.get(
      kafkaOutput
    )}`,
    status: 200,
  };
}

const extraOutputs = [];
extraOutputs.push(kafkaOutput);

app.http("kafkaOutputWithHttp", {
  methods: ["GET", "POST"],
  authLevel: "anonymous",
  extraOutputs,
  handler: kafkaOutputWithHttp,
});

Event Hubs

:::code language="javascript" source="~/azure-functions-kafka-extension/samples/javascript-v4/src/functions/kafkaOutputWithHttpTrigger.js" range="1-20,33-63":::

Confluent

This function.json file defines the output binding for the Confluent provider:

:::code language="json" source="~/azure-functions-kafka-extension/samples/javascript/KafkaOutput/function.confluent.json" :::

The following code sends a message to the topic:

:::code language="javascript" source="~/azure-functions-kafka-extension/samples/javascript/KafkaOutput/index.js" :::

Event Hubs

This function.json file defines the output binding for the Event Hubs provider:

:::code language="json" source="~/azure-functions-kafka-extension/samples/javascript/KafkaOutput/function.eventhub.json" :::

The following code sends a message to the topic:

:::code language="javascript" source="~/azure-functions-kafka-extension/samples/javascript/KafkaOutput/index.js" :::

To send events in a batch, send an array of messages, as shown in these examples:

Confluent

const { app, output } = require("@azure/functions");

const kafkaOutput = output.generic({
  type: "kafka",
  direction: "out",
  topic: "topic",
  brokerList: "%BrokerList%",
  username: "ConfluentCloudUsername",
  password: "ConfluentCloudPassword",
  protocol: "saslSsl",
  authenticationMode: "plain",
});

async function kafkaOutputManyWithHttp(request, context) {
  context.log(`Http function processed request for url "${request.url}"`);

  const queryName = request.query.get("name");
  const body = await request.text();
  const parsedbody = body ? JSON.parse(body) : {};
  parsedbody.name = parsedbody.name || "world";
  const name = queryName || parsedbody.name;
  context.extraOutputs.set(kafkaOutput, `Message one. Hello, ${name}!`);
  context.extraOutputs.set(kafkaOutput, `Message two. Hello, ${name}!`);
  return {
    body: `Messages sent to kafka.`,
    status: 200,
  };
}

const extraOutputs = [];
extraOutputs.push(kafkaOutput);

app.http("kafkaOutputManyWithHttp", {
  methods: ["GET", "POST"],
  authLevel: "anonymous",
  extraOutputs,
  handler: kafkaOutputManyWithHttp,
});

Event Hubs

:::code language="javascript" source="~/azure-functions-kafka-extension/samples/javascript-v4/src/functions/kafkaOutputManyWithHttpTrigger.js" range="1-14,27-49":::

Confluent

This code sends multiple messages as an array to the same topic:

:::code language="javascript" source="~/azure-functions-kafka-extension/samples/javascript/KafkaOutputMany/index.js" :::

Event Hubs

This code sends multiple messages as an array to the same topic:

:::code language="javascript" source="~/azure-functions-kafka-extension/samples/javascript/KafkaOutputMany/index.js" :::

These examples show how to send an event message with headers to a Kafka topic:

Confluent

import {
  app,
  HttpRequest,
  HttpResponseInit,
  InvocationContext,
  output,
} from "@azure/functions";

const kafkaOutput = output.generic({
  type: "kafka",
  direction: "out",
  topic: "topic",
  brokerList: "%BrokerList%",
  username: "ConfluentCloudUsername",
  password: "ConfluentCloudPassword",
  protocol: "saslSsl",
  authenticationMode: "plain",
});

export async function kafkaOutputWithHttp(
  request: HttpRequest,
  context: InvocationContext
): Promise<HttpResponseInit> {
  context.log(`Http function processed request for url "${request.url}"`);

  const body = await request.text();
  const parsedbody = JSON.parse(body);
  // assuming body is of the format { "key": "key", "value": {JSON object} }
  context.extraOutputs.set(
    kafkaOutput,
    `{ "Offset":364,"Partition":0,"Topic":"test-topic","Timestamp":"2022-04-09T03:20:06.591Z", "Value": "${JSON.stringify(
      parsedbody.value
    ).replace(/"/g, '\\"')}", "Key":"${
      parsedbody.key
    }", "Headers": [{ "Key": "language", "Value": "javascript" }] }`
  );
  context.log(
    `Sending message to kafka: ${context.extraOutputs.get(kafkaOutput)}`
  );
  return {
    body: `Message sent to kafka with value: ${context.extraOutputs.get(
      kafkaOutput
    )}`,
    status: 200,
  };
}

const extraOutputs = [];
extraOutputs.push(kafkaOutput);

app.http("kafkaOutputWithHttp", {
  methods: ["GET", "POST"],
  authLevel: "anonymous",
  extraOutputs,
  handler: kafkaOutputWithHttp,
});

Event Hubs

:::code language="javascript" source="~/azure-functions-kafka-extension/samples/javascript-v4/src/functions/kafkaOutputWithHttpTriggerWithHeaders.js" range="1-20,33-69":::

Confluent

:::code language="javascript" source="~/azure-functions-kafka-extension/samples/javascript/KafkaOutputWithHeader/index.js" :::

Event Hubs

:::code language="javascript" source="~/azure-functions-kafka-extension/samples/javascript/KafkaOutputWithHeader/index.js" :::

Version 4

For a complete set of working JavaScript examples, see the Kafka extension repository.

Version 3

For a complete set of working JavaScript examples, see the Kafka extension repository.

::: zone-end
::: zone pivot="programming-language-typescript"

Confluent

import {
  app,
  HttpRequest,
  HttpResponseInit,
  InvocationContext,
  output,
} from "@azure/functions";

const kafkaOutput = output.generic({
  type: "kafka",
  direction: "out",
  topic: "topic",
  brokerList: "%BrokerList%",
  username: "ConfluentCloudUsername",
  password: "ConfluentCloudPassword",
  protocol: "saslSsl",
  authenticationMode: "plain",
});

export async function kafkaOutputWithHttp(
  request: HttpRequest,
  context: InvocationContext
): Promise<HttpResponseInit> {
  context.log(`Http function processed request for url "${request.url}"`);

  const body = await request.text();
  const queryName = request.query.get("name");
  const parsedbody = JSON.parse(body);
  const name = queryName || parsedbody.name || "world";
  context.extraOutputs.set(kafkaOutput, `Hello, ${parsedbody.name}!`);
  context.log(
    `Sending message to kafka: ${context.extraOutputs.get(kafkaOutput)}`
  );
  return {
    body: `Message sent to kafka with value: ${context.extraOutputs.get(
      kafkaOutput
    )}`,
    status: 200,
  };
}

const extraOutputs = [];
extraOutputs.push(kafkaOutput);

app.http("kafkaOutputWithHttp", {
  methods: ["GET", "POST"],
  authLevel: "anonymous",
  extraOutputs,
  handler: kafkaOutputWithHttp,
});

Event Hubs

:::code language="typescript" source="~/azure-functions-kafka-extension/samples/typescript-v4/src/functions/kafkaOutputWithHttpTrigger.ts" range="1-20,33-63":::

Confluent

This function.json file defines the output binding for the Confluent provider:

:::code language="json" source="~/azure-functions-kafka-extension/samples/typescript/KafkaOutput/function.confluent.json" :::

The following code sends a message to the topic:

:::code language="typescript" source="~/azure-functions-kafka-extension/samples/typescript/KafkaOutput/index.ts" :::

Event Hubs

This function.json file defines the output binding for the Event Hubs provider:

:::code language="json" source="~/azure-functions-kafka-extension/samples/typescript/KafkaOutput/function.eventhub.json" :::

The following code sends a message to the topic:

:::code language="typescript" source="~/azure-functions-kafka-extension/samples/typescript/KafkaOutput/index.ts" :::

To send events in a batch, send an array of messages, as shown in these examples:

Confluent

import {
  app,
  HttpRequest,
  HttpResponseInit,
  InvocationContext,
  output,
} from "@azure/functions";

const kafkaOutput = output.generic({
  type: "kafka",
  direction: "out",
  topic: "topic",
  brokerList: "%BrokerList%",
  username: "ConfluentCloudUsername",
  password: "ConfluentCloudPassword",
  protocol: "saslSsl",
  authenticationMode: "plain",
});

export async function kafkaOutputManyWithHttp(
  request: HttpRequest,
  context: InvocationContext
): Promise<HttpResponseInit> {
  context.log(`Http function processed request for url "${request.url}"`);

  const queryName = request.query.get("name");
  const body = await request.text();
  const parsedbody = body ? JSON.parse(body) : {};
  parsedbody.name = parsedbody.name || "world";
  const name = queryName || parsedbody.name;
  context.extraOutputs.set(kafkaOutput, `Message one. Hello, ${name}!`);
  context.extraOutputs.set(kafkaOutput, `Message two. Hello, ${name}!`);
  return {
    body: `Messages sent to kafka.`,
    status: 200,
  };
}

const extraOutputs = [];
extraOutputs.push(kafkaOutput);

app.http("kafkaOutputManyWithHttp", {
  methods: ["GET", "POST"],
  authLevel: "anonymous",
  extraOutputs,
  handler: kafkaOutputManyWithHttp,
});

Event Hubs

:::code language="typescript" source="~/azure-functions-kafka-extension/samples/typescript-v4/src/functions/kafkaOutputManyWithHttpTrigger.ts" range="1-20,33-60":::

Confluent

This code sends multiple messages as an array to the same topic:

:::code language="typescript" source="~/azure-functions-kafka-extension/samples/typescript/KafkaOutputMany/index.ts" :::

Event Hubs

This code sends multiple messages as an array to the same topic:

:::code language="typescript" source="~/azure-functions-kafka-extension/samples/typescript/KafkaOutputMany/index.ts" :::

These examples show how to send an event message with headers to a Kafka topic:

Confluent

import {
  app,
  HttpRequest,
  HttpResponseInit,
  InvocationContext,
  output,
} from "@azure/functions";

const kafkaOutput = output.generic({
  type: "kafka",
  direction: "out",
  topic: "topic",
  brokerList: "%BrokerList%",
  username: "ConfluentCloudUsername",
  password: "ConfluentCloudPassword",
  protocol: "saslSsl",
  authenticationMode: "plain",
});

export async function kafkaOutputWithHttp(
  request: HttpRequest,
  context: InvocationContext
): Promise<HttpResponseInit> {
  context.log(`Http function processed request for url "${request.url}"`);

  const body = await request.text();
  const parsedbody = JSON.parse(body);
  // assuming body is of the format { "key": "key", "value": {JSON object} }
  context.extraOutputs.set(
    kafkaOutput,
    `{ "Offset":364,"Partition":0,"Topic":"test-topic","Timestamp":"2022-04-09T03:20:06.591Z", "Value": "${JSON.stringify(
      parsedbody.value
    ).replace(/"/g, '\\"')}", "Key":"${
      parsedbody.key
    }", "Headers": [{ "Key": "language", "Value": "typescript" }] }`
  );
  context.log(
    `Sending message to kafka: ${context.extraOutputs.get(kafkaOutput)}`
  );
  return {
    body: `Message sent to kafka with value: ${context.extraOutputs.get(
      kafkaOutput
    )}`,
    status: 200,
  };
}

const extraOutputs = [];
extraOutputs.push(kafkaOutput);

app.http("kafkaOutputWithHttp", {
  methods: ["GET", "POST"],
  authLevel: "anonymous",
  extraOutputs,
  handler: kafkaOutputWithHttp,
});

Event Hubs

:::code language="typescript" source="~/azure-functions-kafka-extension/samples/typescript-v4/src/functions/kafkaOutputWithHttpTriggerWithHeaders.ts" range="1-20,33-74":::

Confluent

:::code language="typescript" source="~/azure-functions-kafka-extension/samples/typescript/KafkaOutputWithHeaders/index.ts" :::

Event Hubs

:::code language="typescript" source="~/azure-functions-kafka-extension/samples/typescript/KafkaOutputWithHeaders/index.ts" :::

Version 4

For a complete set of working TypeScript examples, see the Kafka extension repository.

Version 3

For a complete set of working TypeScript examples, see the Kafka extension repository.

::: zone-end
::: zone pivot="programming-language-powershell"

The specific properties of the function.json file depend on your event provider, which in these examples are either Confluent or Azure Event Hubs. The following examples show a Kafka output binding for a function that an HTTP request triggers and sends data from the request to the Kafka topic.

The following function.json defines the trigger for the specific provider in these examples:

Confluent

:::code language="json" source="~/azure-functions-kafka-extension/samples/powershell/KafkaOutput/function.confluent.json" :::

Event Hubs

:::code language="json" source="~/azure-functions-kafka-extension/samples/powershell/KafkaOutput/function.eventhub.json" :::

The following code sends a message to the topic:

:::code language="powershell" source="~/azure-functions-kafka-extension/samples/powershell/KafkaOutput/run.ps1" :::

The following code sends multiple messages as an array to the same topic:

:::code language="powershell" source="~/azure-functions-kafka-extension/samples/powershell/KafkaOutputMany/run.ps1" :::

The following example shows how to send an event message with headers to the same Kafka topic:

:::code language="powershell" source="~/azure-functions-kafka-extension/samples/powershell/KafkaOutputWithHeaders/run.ps1" :::

For a complete set of working PowerShell examples, see the Kafka extension repository.

::: zone-end ::: zone pivot="programming-language-python"
The usage of the output binding depends on your version of the Python programming model.

Version 2

In the Python v2 model, you define your output binding directly in your function code using decorators. For more information, see the Azure Functions Python developer guide.

Version 1

In the Python v1 model, you define your output binding in the function.json with your function code. For more information, see the Azure Functions Python developer guide.

These examples show a Kafka output binding for a function that an HTTP request triggers and sends data from the request to the Kafka topic.

Version 2

:::code language="python" source="~/azure-functions-kafka-extension/samples/python-v2/kafka_output.py" range="10-21" :::

Version 1

This function.json file defines the output binding:

:::code language="json" source="~/azure-functions-kafka-extension/samples/python/KafkaOutput/function.confluent.json" :::

This code sends a message to the topic:

:::code language="python" source="~/azure-functions-kafka-extension/samples/python/KafkaOutput/main.py" :::

To send events in a batch, send an array of messages, as shown in these examples:

Version 2

:::code language="python" source="~/azure-functions-kafka-extension/samples/python-v2/kafka_output.py" range="23-35" :::

Version 1

This code sends multiple messages as an array to the same topic:

:::code language="python" source="~/azure-functions-kafka-extension/samples/python/KafkaOutputMany/main.py" :::

These examples show how to send an event message with headers to a Kafka topic:

Version 2

:::code language="python" source="~/azure-functions-kafka-extension/samples/python-v2/kafka_output.py" range="37-51" :::

Version 1

:::code language="python" source="~/azure-functions-kafka-extension/samples/python/KafkaOutputWithHeaders/init.py" :::

Version 2

For a complete set of working Python examples, see the Kafka extension repository.

Version 1

For a complete set of working Python examples, see the Kafka extension repository.

::: zone-end ::: zone pivot="programming-language-java"

The annotations you use to configure the output binding depend on the specific event provider.

Confluent

The following function sends a message to the Kafka topic.

:::code language="java" source="~/azure-functions-kafka-extension/samples/java/confluent/src/main/java/com/contoso/kafka/SampleKafkaOutput.java" range="17-38" :::

The following example shows how to send multiple messages to a Kafka topic.

:::code language="java" source="~/azure-functions-kafka-extension/samples/java/confluent/src/main/java/com/contoso/kafka/KafkaOutputMany.java" range="10-30" :::

In this example, the output binding parameter is changed to string array.

The last example uses these KafkaEntity and KafkaHeader classes:

:::code language="java" source="~/azure-functions-kafka-extension/samples/java/confluent/src/main/java/com/contoso/kafka/entity/KafkaEntity.java" range="3-18" :::

:::code language="java" source="~/azure-functions-kafka-extension/samples/java/confluent/src/main/java/com/contoso/kafka/entity/KafkaHeaders.java" range="3-10" :::

The following example function sends a message with headers to a Kafka topic.

:::code language="java" source="~/azure-functions-kafka-extension/samples/java/confluent/src/main/java/com/contoso/kafka/KafkaOutputWithHeaders.java" range="11-35" :::

For a complete set of working Java examples for Confluent, see the Kafka extension repository.

Event Hubs

The following function sends a message to the Kafka topic.

:::code language="java" source="~/azure-functions-kafka-extension/samples/java/eventhub/src/main/java/com/contoso/kafka/SampleKafkaOutput.java" range="17-38" :::

The following example shows how to send multiple messages to a Kafka topic.

:::code language="java" source="~/azure-functions-kafka-extension/samples/java/eventhub/src/main/java/com/contoso/kafka/KafkaOutputMany.java" range="10-30" :::

In this example, the output binding parameter is changed to string array.

The last example uses these KafkaEntity and KafkaHeader classes:

:::code language="java" source="~/azure-functions-kafka-extension/samples/java/eventhub/src/main/java/com/contoso/kafka/entity/KafkaEntity.java" range="3-18" :::

:::code language="java" source="~/azure-functions-kafka-extension/samples/java/eventhub/src/main/java/com/contoso/kafka/entity/KafkaHeaders.java" range="3-10" :::

The following example function sends a message with headers to a Kafka topic.

:::code language="java" source="~/azure-functions-kafka-extension/samples/java/eventhub/src/main/java/com/contoso/kafka/KafkaOutputWithHeaders.java" range="11-35" :::

For a complete set of working Java examples for Confluent, see the Kafka extension repository.

::: zone-end ::: zone pivot="programming-language-csharp"

Attributes

Both in-process and isolated worker process C# libraries use the Kafka attribute to define the function trigger.

The following table explains the properties you can set by using this attribute:

Parameter	Description
BrokerList	(Required) The list of Kafka brokers to which the output is sent. See Connections for more information.
Topic	(Required) The topic to which the output is sent.
AvroSchema	(Optional) Schema of a generic record of message value when using the Avro protocol.
KeyAvroSchema	(Optional) Schema of a generic record of message key when using the Avro protocol.
KeyDataType	(Optional) Data type to send the message key as to Kafka Topic. If `KeyAvroSchema` is set, this value is generic record. Accepted values are `Int`, `Long`, `String`, and `Binary`.
MaxMessageBytes	(Optional) The maximum size of the output message being sent (in MB), with a default value of `1`.
BatchSize	(Optional) Maximum number of messages batched in a single message set, with a default value of `10000`.
EnableIdempotence	(Optional) When set to `true`, guarantees that messages are successfully produced exactly once and in the original produce order, with a default value of `false`
MessageTimeoutMs	(Optional) The local message timeout, in milliseconds. This value is only enforced locally and limits the time a produced message waits for successful delivery, with a default `300000`. A time of `0` is infinite. This value is the maximum time used to deliver a message (including retries). Delivery error occurs when either the retry count or the message timeout are exceeded.
RequestTimeoutMs	(Optional) The acknowledgment timeout of the output request, in milliseconds, with a default of `5000`.
MaxRetries	(Optional) The number of times to retry sending a failing Message, with a default of `2`. Retrying may cause reordering, unless `EnableIdempotence` is set to `true`.
AuthenticationMode	(Optional) The authentication mode when using Simple Authentication and Security Layer (SASL) authentication. The supported values are `NotSet` (default), `Gssapi`, `Plain`, `ScramSha256`, `ScramSha512`, and `OAuthBearer`.
Username	(Optional) The username for SASL authentication. Not supported when `AuthenticationMode` is `Gssapi`. See Connections for more information.
Password	(Optional) The password for SASL authentication. Not supported when `AuthenticationMode` is `Gssapi`. See Connections for more information.
Protocol	(Optional) The security protocol used when communicating with brokers. The supported values are `NotSet` (default), `plaintext`, `ssl`, `sasl_plaintext`, `sasl_ssl`.
SslCaLocation	(Optional) Path to CA certificate file for verifying the broker's certificate.
SslCertificateLocation	(Optional) Path to the client's certificate.
SslKeyLocation	(Optional) Path to client's private key (PEM) used for authentication.
SslKeyPassword	(Optional) Password for client's certificate.
SslCertificatePEM	(Optional) Client certificate in PEM format as a string. See Connections for more information.
SslKeyPEM	(Optional) Client private key in PEM format as a string. See Connections for more information.
SslCaPEM	(Optional) CA certificate in PEM format as a string. See Connections for more information.
SslCertificateandKeyPEM	(Optional) Client certificate and key in PEM format as a string. See Connections for more information.
SchemaRegistryUrl	(Optional) URL for the Avro Schema Registry. See Connections for more information.
SchemaRegistryUsername	(Optional) Username for the Avro Schema Registry. See Connections for more information.
SchemaRegistryPassword	(Optional) Password for the Avro Schema Registry. See Connections for more information.
OAuthBearerMethod	(Optional) OAuth Bearer method. Accepted values are `oidc` and `default`.
OAuthBearerClientId	(Optional) When `OAuthBearerMethod` is set to `oidc`, this specifies the OAuth bearer client ID. See Connections for more information.
OAuthBearerClientSecret	(Optional) When `OAuthBearerMethod` is set to `oidc`, this specifies the OAuth bearer client secret. See Connections for more information.
OAuthBearerScope	(Optional) Specifies the scope of the access request to the broker.
OAuthBearerTokenEndpointUrl	(Optional) OAuth/OIDC issuer token endpoint HTTP(S) URI used to retrieve token when `oidc` method is used. See Connections for more information.
OAuthBearerExtensions	(Optional) Comma-separated list of key=value pairs to be provided as additional information to broker when `oidc` method is used. For example: `supportFeatureX=true,organizationId=sales-emea`.

::: zone-end
::: zone pivot="programming-language-java"

Annotations

The KafkaOutput annotation enables you to create a function that writes to a specific topic. Supported options include the following elements:

Element	Description
name	The name of the variable that represents the brokered data in function code.
brokerList	(Required) The list of Kafka brokers to which the output is sent. See Connections for more information.
topic	(Required) The topic to which the output is sent.
dataType	Defines how Functions handles the parameter value. By default, the value is obtained as a string and Functions tries to deserialize the string to actual plain-old Java object (POJO). When `string`, the input is treated as just a string. When `binary`, the message is received as binary data, and Functions tries to deserialize it to an actual parameter type byte[].
avroSchema	(Optional) Schema of a generic record when using the Avro protocol. (Currently not supported for Java.)
maxMessageBytes	(Optional) The maximum size of the output message being sent (in MB), with a default value of `1`.
batchSize	(Optional) Maximum number of messages batched in a single message set, with a default value of `10000`.
enableIdempotence	(Optional) When set to `true`, guarantees that messages are successfully produced exactly once and in the original produce order, with a default value of `false`.
messageTimeoutMs	(Optional) The local message timeout, in milliseconds. This value is only enforced locally and limits the time a produced message waits for successful delivery, with a default `300000`. A time of `0` is infinite. This value is the maximum time used to deliver a message (including retries). Delivery error occurs when either the retry count or the message timeout are exceeded.
requestTimeoutMs	(Optional) The acknowledgment timeout of the output request, in milliseconds, with a default of `5000`.
maxRetries	(Optional) The number of times to retry sending a failing Message, with a default of `2`. Retrying might cause reordering, unless `EnableIdempotence` is set to `true`.
authenticationMode	(Optional) The authentication mode when using Simple Authentication and Security Layer (SASL) authentication. The supported values are `NotSet` (default), `Gssapi`, `Plain`, `ScramSha256`, `ScramSha512`.
username	(Optional) The username for SASL authentication. Not supported when `AuthenticationMode` is `Gssapi`. See Connections for more information.
password	(Optional) The password for SASL authentication. Not supported when `AuthenticationMode` is `Gssapi`. See Connections for more information.
protocol	(Optional) The security protocol used when communicating with brokers. The supported values are `NotSet` (default), `plaintext`, `ssl`, `sasl_plaintext`, `sasl_ssl`.
sslCaLocation	(Optional) Path to CA certificate file for verifying the broker's certificate.
sslCertificateLocation	(Optional) Path to the client's certificate.
sslKeyLocation	(Optional) Path to client's private key (PEM) used for authentication.
sslKeyPassword	(Optional) Password for client's certificate.
schemaRegistryUrl	(Optional) URL for the Avro Schema Registry. See Connections for more information.
schemaRegistryUsername	(Optional) Username for the Avro Schema Registry. See Connections for more information.
schemaRegistryPassword	(Optional) Password for the Avro Schema Registry. See Connections for more information.

::: zone-end
::: zone pivot="programming-language-javascript,programming-language-powershell"

Configuration

The following table explains the binding configuration properties that you set in the function.json file.

function.json property	Description
type	Set to `kafka`.
direction	Set to `out`.
name	The name of the variable that represents the brokered data in function code.
brokerList	(Required) The list of Kafka brokers to which the output is sent. See Connections for more information.
topic	(Required) The topic to which the output is sent.
avroSchema	(Optional) Schema of a generic record when using the Avro protocol.
keyAvroSchema	(Optional) Schema of a generic record of message key when using the Avro protocol.
keyDataType	(Optional) Data type to send the message key as to Kafka Topic. If `keyAvroSchema` is set, this value is generic record. Accepted values are `Int`, `Long`, `String`, and `Binary`.
maxMessageBytes	(Optional) The maximum size of the output message being sent (in MB), with a default value of `1`.
batchSize	(Optional) Maximum number of messages batched in a single message set, with a default value of `10000`.
enableIdempotence	(Optional) When set to `true`, guarantees that messages are successfully produced exactly once and in the original produce order, with a default value of `false`.
messageTimeoutMs	(Optional) The local message timeout, in milliseconds. This value is only enforced locally and limits the time a produced message waits for successful delivery, with a default `300000`. A time of `0` is infinite. This value is the maximum time used to deliver a message (including retries). Delivery error occurs when either the retry count or the message timeout are exceeded.
requestTimeoutMs	(Optional) The acknowledgment timeout of the output request, in milliseconds, with a default of `5000`.
maxRetries	(Optional) The number of times to retry sending a failing Message, with a default of `2`. Retrying might cause reordering, unless `EnableIdempotence` is set to `true`.
authenticationMode	(Optional) The authentication mode when using Simple Authentication and Security Layer (SASL) authentication. The supported values are `NotSet` (default), `Gssapi`, `Plain`, `ScramSha256`, `ScramSha512`.
username	(Optional) The username for SASL authentication. Not supported when `AuthenticationMode` is `Gssapi`. See Connections for more information.
password	(Optional) The password for SASL authentication. Not supported when `AuthenticationMode` is `Gssapi`. See Connections for more information.
protocol	(Optional) The security protocol used when communicating with brokers. The supported values are `NotSet` (default), `plaintext`, `ssl`, `sasl_plaintext`, `sasl_ssl`.
sslCaLocation	(Optional) Path to CA certificate file for verifying the broker's certificate.
sslCertificateLocation	(Optional) Path to the client's certificate.
sslKeyLocation	(Optional) Path to client's private key (PEM) used for authentication.
sslKeyPassword	(Optional) Password for client's certificate.
sslCertificatePEM	(Optional) Client certificate in PEM format as a string. See Connections for more information.
sslKeyPEM	(Optional) Client private key in PEM format as a string. See Connections for more information.
sslCaPEM	(Optional) CA certificate in PEM format as a string. See Connections for more information.
sslCertificateandKeyPEM	(Optional) Client certificate and key in PEM format as a string. See Connections for more information.
schemaRegistryUrl	(Optional) URL for the Avro Schema Registry. See Connections for more information.
schemaRegistryUsername	(Optional) Username for the Avro Schema Registry. See Connections for more information.
schemaRegistryPassword	(Optional) Password for the Avro Schema Registry. See Connections for more information.
oAuthBearerMethod	(Optional) OAuth Bearer method. Accepted values are `oidc` and `default`.
oAuthBearerClientId	(Optional) When `oAuthBearerMethod` is set to `oidc`, this specifies the OAuth bearer client ID. See Connections for more information.
oAuthBearerClientSecret	(Optional) When `oAuthBearerMethod` is set to `oidc`, this specifies the OAuth bearer client secret. See Connections for more information.
oAuthBearerScope	(Optional) Specifies the scope of the access request to the broker.
oAuthBearerTokenEndpointUrl	(Optional) OAuth/OIDC issuer token endpoint HTTP(S) URI used to retrieve token when `oidc` method is used. See Connections for more information.

::: zone-end ::: zone pivot="programming-language-python"

Configuration

The following table explains the binding configuration properties that you set in the function.json file. Python uses snake_case naming conventions for configuration properties.

function.json property	Description
type	Set to `kafka`.
direction	Set to `out`.
name	The name of the variable that represents the brokered data in function code.
broker_list	(Required) The list of Kafka brokers to which the output is sent. See Connections for more information.
topic	(Required) The topic to which the output is sent.
avroSchema	(Optional) Schema of a generic record when using the Avro protocol.
maxMessageBytes	(Optional) The maximum size of the output message being sent (in MB), with a default value of `1`.
batchSize	(Optional) Maximum number of messages batched in a single message set, with a default value of `10000`.
enableIdempotence	(Optional) When set to `true`, guarantees that messages are successfully produced exactly once and in the original produce order, with a default value of `false`.
messageTimeoutMs	(Optional) The local message timeout, in milliseconds. This value is only enforced locally and limits the time a produced message waits for successful delivery, with a default `300000`. A time of `0` is infinite. This value is the maximum time used to deliver a message (including retries). Delivery error occurs when either the retry count or the message timeout are exceeded.
requestTimeoutMs	(Optional) The acknowledgment timeout of the output request, in milliseconds, with a default of `5000`.
maxRetries	(Optional) The number of times to retry sending a failing Message, with a default of `2`. Retrying might cause reordering, unless `EnableIdempotence` is set to `true`.
authentication_mode	(Optional) The authentication mode when using Simple Authentication and Security Layer (SASL) authentication. The supported values are `NOTSET` (default), `Gssapi`, `Plain`, `ScramSha256`, `ScramSha512`.
username	(Optional) The username for SASL authentication. Not supported when `authentication_mode` is `Gssapi`. See Connections for more information.
password	(Optional) The password for SASL authentication. Not supported when `authentication_mode` is `Gssapi`. See Connections for more information.
protocol	(Optional) The security protocol used when communicating with brokers. The supported values are `NOTSET` (default), `plaintext`, `ssl`, `sasl_plaintext`, `sasl_ssl`.
sslCaLocation	(Optional) Path to CA certificate file for verifying the broker's certificate.
sslCertificateLocation	(Optional) Path to the client's certificate.
sslKeyLocation	(Optional) Path to client's private key (PEM) used for authentication.
sslKeyPassword	(Optional) Password for client's certificate.
schema_registry_url	(Optional) URL for the Avro Schema Registry. See Connections for more information.
schema_registry_username	(Optional) Username for the Avro Schema Registry. See Connections for more information.
schema_registry_password	(Optional) Password for the Avro Schema Registry. See Connections for more information.
o_auth_bearer_method	(Optional) OAuth Bearer method. Accepted values are `oidc` and `default`.
o_auth_bearer_client_id	(Optional) When `o_auth_bearer_method` is set to `oidc`, this specifies the OAuth bearer client ID. See Connections for more information.
o_auth_bearer_client_secret	(Optional) When `o_auth_bearer_method` is set to `oidc`, this specifies the OAuth bearer client secret. See Connections for more information.
o_auth_bearer_scope	(Optional) Specifies the scope of the access request to the broker.
o_auth_bearer_token_endpoint_url	(Optional) OAuth/OIDC issuer token endpoint HTTP(S) URI used to retrieve token when `oidc` method is used. See Connections for more information.

Note

Certificate PEM-related properties and Avro key-related properties aren't yet available in the Python library.

::: zone-end

Usage

::: zone pivot="programming-language-csharp" Both key and value types work with built-in Avro and Protobuf serialization.

::: zone-end ::: zone pivot="programming-language-javascript,programming-language-python,programming-language-powershell" The offset, partition, and timestamp for the event are generated at runtime. You can set only the value and headers inside the function. You set the topic in the function.json file. ::: zone-end

Make sure you have access to the Kafka topic where you want to write. You configure the binding with access and connection credentials to the Kafka topic.

In a Premium plan, you must enable runtime scale monitoring for the Kafka output to scale out to multiple instances. To learn more, see Enable runtime scaling.

For a complete set of supported host.json settings for the Kafka trigger, see host.json settings.

[!INCLUDE functions-bindings-kafka-connections]

Next steps

Run a function from an Apache Kafka event stream

FilesExpand file tree

functions-bindings-kafka-output.md

Latest commit

History

functions-bindings-kafka-output.md

File metadata and controls

Apache Kafka output binding for Azure Functions

Example

Attributes

Annotations

Configuration

Configuration

Usage

Next steps