Skip to content

Additional annotations for Kafka Trigger and Output #230

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
aloiva wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

Additional annotations for Kafka Trigger and Output #230

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d7d9a5
update kafka annotations
Nov 14, 2025
7dfd08b
add avro
Nov 14, 2025
48f6aab
use java additions
Nov 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
120 changes: 120 additions & 0 deletions src/main/java/com/microsoft/azure/functions/annotation/KafkaOutput.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

import com.microsoft.azure.functions.BrokerAuthenticationMode;
import com.microsoft.azure.functions.BrokerProtocol;
import com.microsoft.azure.functions.OAuthBearerMethod;
import com.microsoft.azure.functions.KafkaMessageKeyType;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
Expand Down Expand Up @@ -208,6 +210,62 @@
*/
String avroSchema() default "";

/**
* Gets or sets the Avro schema of message key.
* Should be used only if a generic record should be generated.
* default ""
*
* @return the avro schema for message key
*/
String keyAvroSchema() default "";

/**
* Specifies the data type of the message key.
* This data type will be used to serialize the key before sending it to the Kafka topic.
* If KeyAvroSchema is set, this value is ignored and the key will be serialized using Avro.
* The default type is STRING.
* Default: STRING
*
* @return the data type of the message key
*/
KafkaMessageKeyType keyDataType() default KafkaMessageKeyType.STRING;

/**
* Client certificate in PEM format.
* ssl.certificate.pem in librdkafka
* default ""
*
* @return the ssl certificate PEM
*/
String sslCertificatePEM() default "";

/**
* Client Private Key in PEM format.
* ssl.key.pem in librdkafka
* default ""
*
* @return the ssl key PEM
*/
String sslKeyPEM() default "";

/**
* CA certificate for verifying the broker's certificate in PEM format
* ssl.ca.pem in librdkafka
* default ""
*
* @return the ssl CA PEM
*/
String sslCaPEM() default "";

/**
* Client certificate and key in PEM format.
* Additional Configuration for extension as KeyVault supports uploading certificate only with private key.
* default ""
*
* @return the ssl certificate and key PEM
*/
String sslCertificateandKeyPEM() default "";

/**
* URL for the Avro Schema Registry
* default ""
Expand All @@ -232,4 +290,66 @@
*/
String schemaRegistryPassword() default "";

/**
* OAuth Bearer method.
* Either 'default' or 'oidc'
* sasl.oauthbearer in librdkafka
* default ""
*
* @return the OAuth Bearer method
*/
OAuthBearerMethod oAuthBearerMethod() default OAuthBearerMethod.Default;

/**
* OAuth Bearer Client Id
* Specify only when OAuthBearerMethod is 'oidc'
* sasl.oauthbearer.client.id in librdkafka
* default ""
*
* @return the OAuth Bearer client id
*/
String oAuthBearerClientId() default "";

/**
* OAuth Bearer Client Secret
* Specify only when OAuthBearerMethod is 'oidc'
* sasl.oauthbearer.client.secret in librdkafka
* default ""
*
* @return the OAuth Bearer client secret
*/
String oAuthBearerClientSecret() default "";

/**
* OAuth Bearer scope.
* Client use this to specify the scope of the access request to the broker.
* Specify only when OAuthBearerMethod is 'oidc'
* sasl.oauthbearer.extensions in librdkafka
* default ""
*
* @return the OAuth Bearer scope
*/
String oAuthBearerScope() default "";

/**
* OAuth Bearer token endpoint url.
* Specify only when OAuthBearerMethod is 'oidc'
* sasl.oauthbearer.token.endpoint.url in librdkafka
* default ""
*
* @return the OAuth Bearer token endpoint url
*/
String oAuthBearerTokenEndpointUrl() default "";

/**
* OAuth Bearer extensions.
* Allow additional information to be provided to the broker.
* Comma-separated list of key=value pairs. E.g., "supportFeatureX=true,organizationId=sales-emea"
* sasl.oauthbearer.extensions in librdkafka
* default ""
*
* @return the OAuth Bearer extensions
*/
String oAuthBearerExtensions() default "";

}
128 changes: 125 additions & 3 deletions src/main/java/com/microsoft/azure/functions/annotation/KafkaTrigger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@

import com.microsoft.azure.functions.BrokerAuthenticationMode;
import com.microsoft.azure.functions.BrokerProtocol;
import com.microsoft.azure.functions.OAuthBearerMethod;
import com.microsoft.azure.functions.KafkaMessageKeyType;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
Expand Down Expand Up @@ -182,10 +184,130 @@
*/
String avroSchema() default "";

/***
/**
* Gets or sets the Avro schema of message key.
* Should be used only if a generic record should be generated.
* default ""
*
* @return the avro schema for message key
*/
String keyAvroSchema() default "";

/**
* Specifies the data type of the message key that will be deserialized from the Kafka topic.
* If KeyAvroSchema is set, this value is ignored and the key will be generated as a generic record.
* The default type is STRING.
* Default: STRING
*
* @return the data type of the message key
*/
KafkaMessageKeyType keyDataType() default KafkaMessageKeyType.STRING;

/**
* Client certificate in PEM format.
* ssl.certificate.pem in librdkafka
* default ""
*
* @return the ssl certificate PEM
*/
String sslCertificatePEM() default "";

/**
* Client Private Key in PEM format.
* ssl.key.pem in librdkafka
* default ""
*
* @return the ssl key PEM
*/
String sslKeyPEM() default "";

/**
* CA certificate for verifying the broker's certificate in PEM format
* ssl.ca.pem in librdkafka
* default ""
*
* @return the ssl CA PEM
*/
String sslCaPEM() default "";

/**
* Client certificate and key in PEM format.
* Additional Configuration for extension as KeyVault supports uploading certificate only with private key.
* default ""
*
* @return the ssl certificate and key PEM
*/
String sslCertificateandKeyPEM() default "";

/**
* OAuth Bearer method.
* Either 'default' or 'oidc'
* sasl.oauthbearer in librdkafka
* default ""
*
* @return the OAuth Bearer method
*/
OAuthBearerMethod oAuthBearerMethod() default OAuthBearerMethod.Default;

/**
* OAuth Bearer Client Id
* Specify only when OAuthBearerMethod is 'oidc'
* sasl.oauthbearer.client.id in librdkafka
* default ""
*
* @return the OAuth Bearer client id
*/
String oAuthBearerClientId() default "";

/**
* OAuth Bearer Client Secret
* Specify only when OAuthBearerMethod is 'oidc'
* sasl.oauthbearer.client.secret in librdkafka
* default ""
*
* @return the OAuth Bearer client secret
*/
String oAuthBearerClientSecret() default "";

/**
* OAuth Bearer scope.
* Client use this to specify the scope of the access request to the broker.
* Specify only when OAuthBearerMethod is 'oidc'
* sasl.oauthbearer.extensions in librdkafka
* default ""
*
* @return the OAuth Bearer scope
*/
String oAuthBearerScope() default "";

/**
* OAuth Bearer token endpoint url.
* Specify only when OAuthBearerMethod is 'oidc'
* sasl.oauthbearer.token.endpoint.url in librdkafka
* default ""
*
* @return the OAuth Bearer token endpoint url
*/
String oAuthBearerTokenEndpointUrl() default "";

/**
* OAuth Bearer extensions.
* Allow additional information to be provided to the broker.
* Comma-separated list of key=value pairs. E.g., "supportFeatureX=true,organizationId=sales-emea"
* sasl.oauthbearer.extensions in librdkafka
* default ""
*
* @return the OAuth Bearer extensions
*/
String oAuthBearerExtensions() default "";

/**
* Maximum number of unprocessed messages a worker is expected to have at an instance.
* When target-based scaling is not disabled, this is used to divide total unprocessed event count to determine the number of worker instances, which will then be rounded up to a worker instance count that creates a balanced partition distribution.
* Default: 1000
*
* @return
*/
* @return the lag threshold
*/
int lagThreshold() default 1000;

/**
Expand Down
Loading