KafkaServerResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.Kafka / KafkaServerResource

KafkaServerResource

Docs Reference TypeScript APIs Aspire.Hosting.Kafka KafkaServerResource

Handle TypeScript

📦 Aspire.Hosting.Kafka v13.2.0-preview.1.26159.1

interface KafkaServerResource
  extends IComputeResource,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  entrypoint: string;
  readonly host: EndpointReferenceExpression;
  readonly internalEndpoint: EndpointReference;
  readonly name: string;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  shellExecution: boolean;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): KafkaServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): KafkaServerResource;
  withKafkaUI(configureContainer?: (obj: KafkaUIContainerResource) => void, containerName?: string): KafkaServerResource;
}

Implements

• IComputeResource
• IManifestExpressionProvider
• IResource
• IResourceWithArgs
• IResourceWithConnectionString
• IResourceWithEndpoints
• IResourceWithEnvironment
• IResourceWithProbes
• IResourceWithWaitSupport
• IValueProvider
• IValueWithReferences

Search members of KafkaServerResource…

method property

13 members Clear filters

Properties

property connectionStringExpression ReferenceExpression get

Gets the ConnectionStringExpression property

property entrypoint string get · set

Gets the Entrypoint property

property host EndpointReferenceExpression get

Gets the Host property

property internalEndpoint EndpointReference get

Gets the InternalEndpoint property

property name string get

Gets the Name property

property port EndpointReferenceExpression get

Gets the Port property

property primaryEndpoint EndpointReference get

Gets the PrimaryEndpoint property

property shellExecution boolean get · set

Gets the ShellExecution property

Methods

method withDataBindMount builder

Adds a data bind mount to the Kafka container

withDataBindMount(
    source: string,
    isReadOnly?: boolean): KafkaServerResource

Parameters

source string

isReadOnly boolean optional = False

Returns

KafkaServerResource

method withDataVolume builder

Adds a data volume to the Kafka container

withDataVolume(
    name?: string,
    isReadOnly?: boolean): KafkaServerResource

Parameters

name string optional

isReadOnly boolean optional = False

Returns

KafkaServerResource

method withKafkaUI builder

Adds a Kafka UI container to manage the Kafka resource

withKafkaUI(configureContainer?: (obj: KafkaUIContainerResource) => void, containerName?: string): KafkaServerResource

Parameters

configureContainer (obj: KafkaUIContainerResource) => void optional

containerName string optional

Returns

KafkaServerResource