KafkaBuilderExtensions.AddKafka Method

Definition

Namespace:

Aspire.Hosting

Assembly:

Aspire.Hosting.Kafka.dll

Package:

Aspire.Hosting.Kafka v8.2.0

Source:

KafkaBuilderExtensions.cs

Adds a Kafka resource to the application. A container is used for local development.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.KafkaServerResource> AddKafka (this Aspire.Hosting.IDistributedApplicationBuilder builder, string name, int? port = default);

static member AddKafka : Aspire.Hosting.IDistributedApplicationBuilder * string * Nullable<int> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.KafkaServerResource>

<Extension()>
Public Function AddKafka (builder As IDistributedApplicationBuilder, name As String, Optional port As Nullable(Of Integer) = Nothing) As IResourceBuilder(Of KafkaServerResource)

Parameters

builder

IDistributedApplicationBuilder

The IDistributedApplicationBuilder.

name

String

The name of the resource. This name will be used as the connection string name when referenced in a dependency

port

Nullable<Int32>

The host port of Kafka broker.

Returns

IResourceBuilder<KafkaServerResource>

A reference to the IResourceBuilder<T>.

Remarks

This version of the package defaults to the tag of the container image.