RabbitMQServerResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.RabbitMQ / RabbitMQServerResource

RabbitMQServerResource

Docs Reference TypeScript APIs Aspire.Hosting.RabbitMQ RabbitMQServerResource

Handle TypeScript

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

interface RabbitMQServerResource
  extends IComputeResource,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  entrypoint: string;
  readonly host: EndpointReferenceExpression;
  readonly managementEndpoint: EndpointReference;
  readonly name: string;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  shellExecution: boolean;
  readonly uriExpression: ReferenceExpression;
  readonly userNameReference: ReferenceExpression;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): RabbitMQServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): RabbitMQServerResource;
  withManagementPlugin(): RabbitMQServerResource;
  withManagementPluginWithPort(port: number): RabbitMQServerResource;
}

Implements

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

Search members of RabbitMQServerResource…

method property

16 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 managementEndpoint EndpointReference get

Gets the ManagementEndpoint 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

property uriExpression ReferenceExpression get

Gets the UriExpression property

property userNameReference ReferenceExpression get

Gets the UserNameReference property

Methods

method withDataBindMount builder

Adds a data bind mount to the RabbitMQ container

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

Parameters

source string

isReadOnly boolean optional = False

Returns

RabbitMQServerResource

method withDataVolume builder

Adds a data volume to the RabbitMQ container

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

Parameters

name string optional

isReadOnly boolean optional = False

Returns

RabbitMQServerResource

method withManagementPlugin builder

Enables the RabbitMQ management plugin

withManagementPlugin(): RabbitMQServerResource

Returns

RabbitMQServerResource

method withManagementPluginWithPort builder

Enables the RabbitMQ management plugin with a specific port

withManagementPluginWithPort(port: number): RabbitMQServerResource

Parameters

port number

Returns

RabbitMQServerResource