Skip to content
DocsTry Aspire
DocsTry

AspireKafkaProducerExtensions Methods

ClassMethods12 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)
{
// ...
}
}
builderIHostApplicationBuilder
connectionNamestring
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)
{
// ...
}
}
builderIHostApplicationBuilder
connectionNamestring
configureSettingsAction<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)
{
// ...
}
}
builderIHostApplicationBuilder
connectionNamestring
configureBuilderAction<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)
{
// ...
}
}
builderIHostApplicationBuilder
connectionNamestring
configureBuilderAction<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)
{
// ...
}
}
builderIHostApplicationBuilder
connectionNamestring
configureSettingsAction<KafkaProducerSettings>
configureBuilderAction<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)
{
// ...
}
}
builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder to read config from and add services to.
connectionNamestringA name used to retrieve the connection string from the ConnectionStrings configuration section.
configureSettingsAction<KafkaProducerSettings>An optional method used for customizing the KafkaProducerSettings.
configureBuilderAction<IServiceProvider, ProducerBuilder<TKey, TValue>>A method used for customizing the Kafka.ProducerBuilder`2.
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)
{
// ...
}
}
builderIHostApplicationBuilder
namestring
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)
{
// ...
}
}
builderIHostApplicationBuilder
namestring
configureSettingsAction<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)
{
// ...
}
}
builderIHostApplicationBuilder
namestring
configureBuilderAction<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)
{
// ...
}
}
builderIHostApplicationBuilder
namestring
configureBuilderAction<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)
{
// ...
}
}
builderIHostApplicationBuilder
namestring
configureSettingsAction<KafkaProducerSettings>
configureBuilderAction<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)
{
// ...
}
}
builderIHostApplicationBuilderThe Hosting.IHostApplicationBuilder to read config from and add services to.
namestringThe 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.
configureSettingsAction<KafkaProducerSettings>An optional method used for customizing the KafkaProducerSettings.
configureBuilderAction<IServiceProvider, ProducerBuilder<TKey, TValue>>An optional method used for customizing the Kafka.ProducerBuilder`2.
Reads the configuration from "Aspire:Kafka:Producer:{name}" section.