Skip to content
Aspire
Docs Try Aspire
Docs Try

Install Aspire CLI

macOS

curl -sSL https://aspire.dev/install.sh | bash

Linux

curl -sSL https://aspire.dev/install.sh | bash

Windows

irm https://aspire.dev/install.ps1 | iex
More installation options

AspireKafkaProducerExtensions Methods

Class Methods 12 members
Extension methods for connecting to a Kafka broker.
AddKafkaProducer(IHostApplicationBuilder, string) Section titled AddKafkaProducer(IHostApplicationBuilder, string) extension 
public static class AspireKafkaProducerExtensions
{
    public static void AddKafkaProducer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string connectionName)
    {
        // ...
    }
}
AspireKafkaProducerExtensions.cs#L27
Parameters
builder IHostApplicationBuilder
connectionName string
AddKafkaProducer(IHostApplicationBuilder, string, Action<KafkaProducerSettings>) Section titled AddKafkaProducer(IHostApplicationBuilder, string, Action<KafkaProducerSettings>) extension 
public static class AspireKafkaProducerExtensions
{
    public static void AddKafkaProducer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<KafkaProducerSettings>? configureSettings)
    {
        // ...
    }
}
AspireKafkaProducerExtensions.cs#L31
Parameters
builder IHostApplicationBuilder
connectionName string
configureSettings Action<KafkaProducerSettings>
AddKafkaProducer(IHostApplicationBuilder, string, Action<ProducerBuilder<TKey, TValue>>) Section titled AddKafkaProducer(IHostApplicationBuilder, string, Action<ProducerBuilder<TKey, TValue>>) extension 
public static class AspireKafkaProducerExtensions
{
    public static void AddKafkaProducer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<ProducerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}
AspireKafkaProducerExtensions.cs
Parameters
builder IHostApplicationBuilder
connectionName string
configureBuilder Action<ProducerBuilder<TKey, TValue>>
AddKafkaProducer(IHostApplicationBuilder, string, Action<IServiceProvider, ProducerBuilder<TKey, TValue>>) Section titled AddKafkaProducer(IHostApplicationBuilder, string, Action<IServiceProvider, ProducerBuilder<TKey, TValue>>) extension 
public static class AspireKafkaProducerExtensions
{
    public static void AddKafkaProducer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<IServiceProvider, ProducerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}
AspireKafkaProducerExtensions.cs
Parameters
builder IHostApplicationBuilder
connectionName string
configureBuilder Action<IServiceProvider, ProducerBuilder<TKey, TValue>>
AddKafkaProducer(IHostApplicationBuilder, string, Action<KafkaProducerSettings>, Action<ProducerBuilder<TKey, TValue>>) Section titled AddKafkaProducer(IHostApplicationBuilder, string, Action<KafkaProducerSettings>, Action<ProducerBuilder<TKey, TValue>>) extension 
public static class AspireKafkaProducerExtensions
{
    public static void AddKafkaProducer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<KafkaProducerSettings>? configureSettings,
        Action<ProducerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}
AspireKafkaProducerExtensions.cs
Parameters
builder IHostApplicationBuilder
connectionName string
configureSettings Action<KafkaProducerSettings>
configureBuilder Action<ProducerBuilder<TKey, TValue>>
AddKafkaProducer(IHostApplicationBuilder, string, Action<KafkaProducerSettings>, Action<IServiceProvider, ProducerBuilder<TKey, TValue>>) Section titled AddKafkaProducer(IHostApplicationBuilder, string, Action<KafkaProducerSettings>, Action<IServiceProvider, ProducerBuilder<TKey, TValue>>) extension
Registers Kafka.IProducer`2 as a singleton in the services provided by the builder. 
public static class AspireKafkaProducerExtensions
{
    public static void AddKafkaProducer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string connectionName,
        Action<KafkaProducerSettings>? configureSettings,
        Action<IServiceProvider, ProducerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}
AspireKafkaProducerExtensions.cs
Parameters
builder IHostApplicationBuilder The Hosting.IHostApplicationBuilder to read config from and add services to.
connectionName string A name used to retrieve the connection string from the ConnectionStrings configuration section.
configureSettings Action<KafkaProducerSettings> An optional method used for customizing the KafkaProducerSettings.
configureBuilder Action<IServiceProvider, ProducerBuilder<TKey, TValue>> A method used for customizing the Kafka.ProducerBuilder`2.
Remarks
Reads the configuration from "Aspire:Kafka:Producer" section.
AddKeyedKafkaProducer(IHostApplicationBuilder, string) Section titled AddKeyedKafkaProducer(IHostApplicationBuilder, string) extension 
public static class AspireKafkaProducerExtensions
{
    public static void AddKeyedKafkaProducer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string name)
    {
        // ...
    }
}
AspireKafkaProducerExtensions.cs#L59-L62
Parameters
builder IHostApplicationBuilder
name string
AddKeyedKafkaProducer(IHostApplicationBuilder, string, Action<KafkaProducerSettings>) Section titled AddKeyedKafkaProducer(IHostApplicationBuilder, string, Action<KafkaProducerSettings>) extension 
public static class AspireKafkaProducerExtensions
{
    public static void AddKeyedKafkaProducer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string name,
        Action<KafkaProducerSettings>? configureSettings)
    {
        // ...
    }
}
AspireKafkaProducerExtensions.cs#L67-L70
Parameters
builder IHostApplicationBuilder
name string
configureSettings Action<KafkaProducerSettings>
AddKeyedKafkaProducer(IHostApplicationBuilder, string, Action<ProducerBuilder<TKey, TValue>>) Section titled AddKeyedKafkaProducer(IHostApplicationBuilder, string, Action<ProducerBuilder<TKey, TValue>>) extension 
public static class AspireKafkaProducerExtensions
{
    public static void AddKeyedKafkaProducer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string name,
        Action<ProducerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}
AspireKafkaProducerExtensions.cs
Parameters
builder IHostApplicationBuilder
name string
configureBuilder Action<ProducerBuilder<TKey, TValue>>
AddKeyedKafkaProducer(IHostApplicationBuilder, string, Action<IServiceProvider, ProducerBuilder<TKey, TValue>>) Section titled AddKeyedKafkaProducer(IHostApplicationBuilder, string, Action<IServiceProvider, ProducerBuilder<TKey, TValue>>) extension 
public static class AspireKafkaProducerExtensions
{
    public static void AddKeyedKafkaProducer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string name,
        Action<IServiceProvider, ProducerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}
AspireKafkaProducerExtensions.cs
Parameters
builder IHostApplicationBuilder
name string
configureBuilder Action<IServiceProvider, ProducerBuilder<TKey, TValue>>
AddKeyedKafkaProducer(IHostApplicationBuilder, string, Action<KafkaProducerSettings>, Action<ProducerBuilder<TKey, TValue>>) Section titled AddKeyedKafkaProducer(IHostApplicationBuilder, string, Action<KafkaProducerSettings>, Action<ProducerBuilder<TKey, TValue>>) extension 
public static class AspireKafkaProducerExtensions
{
    public static void AddKeyedKafkaProducer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string name,
        Action<KafkaProducerSettings>? configureSettings,
        Action<ProducerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}
AspireKafkaProducerExtensions.cs
Parameters
builder IHostApplicationBuilder
name string
configureSettings Action<KafkaProducerSettings>
configureBuilder Action<ProducerBuilder<TKey, TValue>>
AddKeyedKafkaProducer(IHostApplicationBuilder, string, Action<KafkaProducerSettings>, Action<IServiceProvider, ProducerBuilder<TKey, TValue>>) Section titled AddKeyedKafkaProducer(IHostApplicationBuilder, string, Action<KafkaProducerSettings>, Action<IServiceProvider, ProducerBuilder<TKey, TValue>>) extension
Registers Kafka.IProducer`2 as a keyed singleton for the given name in the services provided by the builder. 
public static class AspireKafkaProducerExtensions
{
    public static void AddKeyedKafkaProducer<TKey, TValue>(
        this IHostApplicationBuilder builder,
        string name,
        Action<KafkaProducerSettings>? configureSettings,
        Action<IServiceProvider, ProducerBuilder<TKey, TValue>>? configureBuilder)
    {
        // ...
    }
}
AspireKafkaProducerExtensions.cs
Parameters
builder IHostApplicationBuilder The Hosting.IHostApplicationBuilder to read config from and add services to.
name string The name of the component, which is used as the ServiceDescriptor.ServiceKey of the service and also to retrieve the connection string from the ConnectionStrings configuration section.
configureSettings Action<KafkaProducerSettings> An optional method used for customizing the KafkaProducerSettings.
configureBuilder Action<IServiceProvider, ProducerBuilder<TKey, TValue>> An optional method used for customizing the Kafka.ProducerBuilder`2.
Remarks
Reads the configuration from "Aspire:Kafka:Producer:{name}" section.
Connect with us

Community

SHA — 037d613 © Microsoft