Share via


KafkaServerResource Class

Definition

A resource that represents a Kafka broker.

public class KafkaServerResource : Aspire.Hosting.ApplicationModel.ContainerResource, Aspire.Hosting.ApplicationModel.IResourceWithConnectionString
type KafkaServerResource = class
    inherit ContainerResource
    interface IResourceWithConnectionString
    interface IResource
    interface IManifestExpressionProvider
    interface IValueProvider
    interface IValueWithReferences
    interface IResourceWithEnvironment
Public Class KafkaServerResource
Inherits ContainerResource
Implements IResourceWithConnectionString
Inheritance
KafkaServerResource
Implements

Constructors

KafkaServerResource(String)

A resource that represents a Kafka broker.

Properties

Annotations

Gets the annotations associated with the resource.

(Inherited from Resource)
ConnectionStringExpression

Gets the connection string expression for the Kafka broker.

Entrypoint

The container Entrypoint.

(Inherited from ContainerResource)
InternalEndpoint

Gets the internal endpoint for the Kafka broker. This endpoint is used for container to broker communication. To connect to the Kafka broker from a host process, use PrimaryEndpoint.

Name

Gets the name of the resource.

(Inherited from Resource)
PrimaryEndpoint

Gets the primary endpoint for the Kafka broker. This endpoint is used for host processes to Kafka broker communication. To connect to the Kafka broker from a host process, use InternalEndpoint.

Extension Methods

GetEndpoint(IResourceWithEndpoints, String)

Gets an endpoint reference for the specified endpoint name.

GetEndpoints(IResourceWithEndpoints)

Gets the endpoints for the specified resource.

GetEnvironmentVariableValuesAsync(IResourceWithEnvironment, DistributedApplicationOperation)

Get the environment variables from the given resource.

GetReplicaCount(IResource)

Gets the number of replicas for the specified resource. Defaults to 1 if no ReplicaAnnotation is found.

TryGetAnnotationsOfType<T>(IResource, IEnumerable<T>)

Attempts to retrieve all annotations of the specified type from the given resource.

TryGetContainerImageName(IResource, String)

Attempts to get the container image name from the given resource.

TryGetContainerMounts(IResource, IEnumerable<ContainerMountAnnotation>)

Attempts to get the container mounts for the specified resource.

TryGetEndpoints(IResource, IEnumerable<EndpointAnnotation>)

Attempts to retrieve the endpoints for the given resource.

TryGetEnvironmentVariables(IResource, IEnumerable<EnvironmentCallbackAnnotation>)

Attempts to get the environment variables from the given resource.

TryGetLastAnnotation<T>(IResource, T)

Attempts to get the last annotation of the specified type from the resource.

IsContainer(IResource)

Determines whether the specified resource is a container resource.

Applies to