Axual Documentation

Axual

    • Overview
      • What is Axual?
      • Platform overview
        • Axual Architecture & Components
    • Getting Started
      • Select Data Formats
      • Creating Topics
      • Creating Applications
      • Producing Data
      • Consuming Data
    • Self-Service Guide
      • Dashboard & Overview
      • Managing Topics
        • Topic Authorizations
        • Topic Insights
        • Download a Topic’s AsyncAPI Specification
        • Kafka Topic Properties
      • Managing Applications
        • Application Types
        • Configuring Authentication
        • Requesting Topic Access
        • Updating an Application
        • Deleting an Application
        • Viewing Application Insights
        • Viewing Application Logs
        • Self-Managed Applications
          • Registering a Self-Managed Application
          • Resetting Consumer Offset
          • Resetting a Kafka Streams Application
          • Kafka Streams Prefixed ACLs
        • Connector Applications
          • Managing Connector Applications
          • Updating Connector Configuration
          • Connector Application States
        • KSML Applications
          • Managing KSML Applications
          • KSML Application States
          • Choosing a Deployment Size
        • Flink Applications
          • Managing Flink Applications
          • Flink Application States
      • Managing Environments
      • Schemas
      • Managing your Tenant
        • Audit History
        • Tenant Insights
        • Security
      • Managing Users and Roles
      • Managing Groups
      • Service Accounts
        • Managing Service Accounts
        • Federated Service Accounts
        • Setting Up Microsoft Entra
        • Authenticating as a Service Account
        • Service Account and Federation Reference
      • Managing Instances
        • Enable KSML Support
        • Enabling Kafka Connect
        • Enabling Flink
        • Apicurio Keycloak Realm
      • Managing Clusters
        • Topic/Group/TransactionalId Patterns
      • Monitoring
        • Topic Metrics
          • Message Rate
          • Incoming Byte Rate
          • Outgoing Byte Rate
          • Size in Records
          • Size in Bytes
        • Application Metrics
          • Consumer Lag in Records
          • Consumer Time to Catch Up
        • Partition Metrics
          • Size in Records
          • Size in Bytes
      • Topic Browse
      • Data Masking
      • Notifications
      • Synchronize
    • Application Guide
      • Integrate with Kafka
        • Client Libraries
          • Producers
            • Java Clients
              • Java Kafka Client
            • .Net Clients
              • .Net Kafka Client
            • Python Clients
              • Python Kafka Client
            • REST Client
          • Consumers
            • Java Clients
              • Java Kafka Client
            • .Net Clients
              • .Net Kafka Client
            • Python Clients
              • Python Kafka Client
            • REST Client
        • Monitoring Java Applications
        • Apicurio Registry Authentication for SerDes
        • KSML
        • Connect Plugins Catalogue
          • Sink Connectors
            • Cloud Storage
              • Amazon S3
              • Azure Data Lake Storage Gen2
              • Google Cloud Storage
            • Database
              • Cassandra
              • CosmosDB
              • Couchbase
              • JDBC
                • JDBC - MySQL
                • JDBC - Oracle
                • JDBC - PostgreSQL
                • JDBC - SQL Server
              • Neo4j
              • Redis
              • Snowflake
            • Messaging & Streaming
              • Google Pub/Sub
              • Google Pub/Sub Lite
              • JMS
              • Kafka
                • 1.1.0 (Latest)
                • 1.0.7
            • Search & Analytics
              • Elasticsearch
              • Google BigQuery
              • OpenSearch
              • Splunk
            • Other
              • HTTP
              • Salesforce SObject
              • SAP HANA
          • Source Connectors
            • Cloud Storage
              • Amazon S3
            • Database
              • Cassandra
              • Debezium Change Data Capture Connectors
                • CDC - Cassandra
                • CDC - DB2
                • CDC - MongoDB
                • CDC - MySQL
                • CDC - Oracle
                • CDC - PostgreSQL
                • CDC - SQL Server
              • CosmosDB
              • Couchbase
              • JDBC
                • JDBC - MySQL
                • JDBC - Oracle
                • JDBC - PostgreSQL
                • JDBC - Snowflake
                • JDBC - SQL Server
              • MongoDB
              • Neo4j
            • Messaging & Streaming
              • AMQP 1.0
              • Google Pub/Sub
              • Google Pub/Sub Lite
              • IBM MQ
              • JMS
              • Kafka
                • 1.1.0 (Latest)
                • 1.0.7
              • MQTT
            • Other
              • Salesforce Pub/Sub API
                • 1.1.0 (Latest)
                • 1.0.0
              • SAP HANA
        • Rest Proxy API
          • Producing data via REST Proxy
          • Definitions
            • AxualRestException
            • ConsumeResponse
            • ProduceRequest
            • ProduceResponse
            • ReceivedMessage
            • SchemaRequest
            • SchemaResponse
          • Message Types
            • StringMessage
            • AvroMessage
            • AvroJsonMessage
            • NullMessage
      • Integrate with Axual
        • Platform Manager API
        • Axual MCP
        • Axual Terraform Provider
        • CI/CD
          • Create CI/CD User
    • Operations Guide
      • Installation & Configuration
        • Deployment Strategy
        • Prerequisites
          • Infrastructure Requirements
          • Dependencies
          • Install an Ingress Controller
          • How to Set Up a Local Loopback Alias
          • Certificates, TLS and DNS
            • DNS and Certificate Inventory Reference
            • Mutual TLS in Axual Platform
            • How to Prepare Certificates and DNS Before Installing
            • TLS Secret Formats Reference
            • How to Configure Certificates on an Axual Component
          • Preparations
        • Quick Setup
          • Full stack: Kafka & Governance (k8s)
          • Governance Only (k8s)
          • Governance Only (OpenShift)
        • Streaming Installation
          • How to Deploy Axual Kafka
          • Install Axual Streaming
          • Apicurio Registry Installation
            • How to Enable Apicurio Registry
            • Apicurio Registry Read Access Models
            • How to Configure Apicurio Authentication
            • How to Enable the Apicurio Auth Proxy
          • How to Improve Rest Proxy Availability
        • Governance Installation
          • Install Axual Governance
          • How to Enable Insights and Metrics
        • Runtime Installation
          • Kafka Connect: Concepts and Architecture
            • How to Prepare the Kafka Broker for Kafka Connect
            • How to Set Up the Connector Vault for Kafka Connect
            • How to Deploy a Kafka Connect Cluster
            • How to Enable Kafka Connect Log Reading
            • How to Decommission a Kafka Connect Cluster
          • Axual Connect Installation (deprecated)
            • How to Deploy Axual Connect
            • How to Install Connect Plugins
            • How to Publish Connect Plugins to Self-Service
            • How to Host a Plugin Download Location
            • Enabling Connector Logging into Kafka
            • Axual Connect Configuration Reference
          • Distribution Between Kafka Clusters
            • How to Deploy the Axual Distributor
            • How to Load Remote Cluster TLS Material from Kubernetes Secrets
            • How to Enable JSON Logging in the Axual Distributor
            • How to Verify Distribution
            • How to Check Distribution Health
            • Offset Distribution
            • Schema Distribution
          • How to Deploy the Runtime Provisioner
          • How to Customise KSML Application Deployments
          • How to Enable Flink in Axual Governance
          • How to Deploy the Axual MCP Server
          • How to Configure Keycloak for the MCP Server
        • Post-Installation Setup
          • Creating Self-Service Resources
          • Local Realm
          • SSO Realm
          • IAM Group Configuration
          • Federated Service Account Realm Setup
          • How to Set Up Vault for Governance
          • How to Set Up Vault for Axual Connect
        • Monitoring
          • Installing the Monitoring Stack
          • How to Configure Logging
          • How to Ship Logs to a Central Stack
          • How to Search Logs in Kibana
          • How to Alert on a Log Pattern in Kibana
          • Metrics
          • How to Import the Axual Grafana Dashboards
          • Tracing
        • Troubleshooting
          • How to Inspect Kubernetes Workloads
          • How to Restart a Service
          • How to Debug Authorisation Errors in Platform Manager
          • Deployment Troubleshooting
          • Acting on Alerts
          • Troubleshoot an Axual Connect Deployment (deprecated)
          • Troubleshoot a Kafka Connect Deployment
        • Secrets and Certificates
          • How to Store Component Credentials in a Kubernetes Secret
          • Certificate Management
            • How to Inspect a Certificate
            • How to Rotate a Certificate
            • How to Replace the Root Certificate Authority
      • Component Details
        • Streaming Components
          • Apache Kafka
            • Strimzi Operator
          • Axual Kafka
            • Readme
            • Helm Readme
            • Chart Values Reference
            • Changelog
          • Apicurio
            • Helm Readme
            • Apicurio Chart Values Reference
            • Changelog
          • Rest Proxy
            • Readme
            • Helm Readme
            • Chart Values Reference
            • Changelog
        • Governance Components
          • SQL
            • MySQL Chart Values Reference
          • Vault
            • Chart Values Reference
          • Keycloak
            • Chart Values Reference
          • API Gateway
            • Readme
            • Helm Readme
            • Chart Values Reference
            • Changelog
          • Topic Browse
            • Readme
            • Helm Readme
            • Chart Values Reference
            • Changelog
          • Metrics Exposer
            • Readme
            • Helm Readme
            • Metrics Exposer Chart Values Reference
            • Changelog
          • Platform Manager
            • Readme
            • Helm Readme
            • Chart Values Reference
            • Changelog
          • Platform UI
            • Readme
            • Helm Readme
            • Chart Values Reference
            • Changelog
        • Runtime Components
          • Axual Connect (deprecated)
            • Helm Readme
            • Changelog
          • Kafka Connect
            • What is "Connect"? What are "Connectors"?
            • Connector Configuration Reference
            • How to Produce Sample Data for a Sink Connector
            • Helm Readme
            • Chart Values Reference
            • Changelog
          • Axual Distributor
            • Helm Readme
            • Distributor Chart Values Reference
            • Metrics Reference
            • Changelog
          • Runtime Provisioner
            • Readme
            • Helm Readme
            • Runtime Provisioner Reference
            • Changelog
          • KSML
          • Flink
        • Init Containers
          • Keystore-provider
      • Infrastructure
        • Resilience & High Availability
        • Storage & State
        • Network and Port Reference
      • Upgrading & Migration
        • Kafka 4 Upgrade
          • Identifying old Kafka clients
          • Cleaning up removed Kafka configs
          • Kafka 4 upgrade
        • Create a Tenant with SSO Realm
        • Import existing Kafka
        • Enabling SASL
        • Migrate Schema Registry to Apicurio
        • Migrate from Axual Connect to Kafka Connect
        • Upgrade to Runtime Provisioner 0.8.0
        • Advanced Features
        • Working with Helm Charts
        • Handling Distribution Headers
    • Axual Platform Releases
      • What’s New
      • Release Notes
      • Upgrade Steps
      • Compatibility Matrix
    • Support
Axual 2026.3
  • Axual
    • 2026.3
    • 2026.2
    • 2026.1
    • 2025.4
    • 2025.3
    • 2025.2
    • 2025.1
    • 2024.4
    • 2024.3
  • Axual
  • Application Guide
  • Integrate with Kafka
  • Client Libraries
  • Consumers
  • .Net Clients
2026.3 2026.2 2026.1 2025.4 2025.3 2025.2 2025.1 2024.4 2024.3
Edit this Page

Consuming Using .Net Clients

DotNet client library that enables interaction with the Axual Platform.

Choose .Net Client

  • Kafka Client

For all executable .Net examples, please refer .Net Client Examples repository.

Prerequisites

A computer equipped with:

  • .NET Standard >= v1.3 - https://dotnet.microsoft.com/platform/dotnet-standard

  • Your favorite IDE

.NET Standard >= v2.0 is required to use Apache.Avro
Java Kafka Client .Net Kafka Client