MosquittoServerResource

Handle

📦 CommunityToolkit.Aspire.Hosting.Mosquitto v13.5.0

interface MosquittoServerResource
  extends IComputeResource,
    IExpressionValue,
    IManifestExpressionProvider,
    IResource,
    IResourceWithArgs,
    IResourceWithConnectionString,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IValueProvider,
    IValueWithReferences {
  readonly connectionStringExpression: ReferenceExpression;
  readonly host: EndpointReferenceExpression;
  readonly port: EndpointReferenceExpression;
  readonly primaryEndpoint: EndpointReference;
  readonly uriExpression: ReferenceExpression;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): MosquittoServerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): MosquittoServerResource;
}

7 members

Properties

propertyconnectionStringExpressionReferenceExpressionget

Gets the connection string expression for the Mosquitto broker in the form of `mqtt://host:port`, suitable for use by MQTT clients.

propertyhostEndpointReferenceExpressionget

Gets the host of the primary MQTT endpoint.

propertyportEndpointReferenceExpressionget

Gets the port of the primary MQTT endpoint.

propertyprimaryEndpointEndpointReferenceget

Gets the primary MQTT endpoint for the Mosquitto broker.

propertyuriExpressionReferenceExpressionget

Gets the connection URI expression for the Mosquitto broker.

Methods

methodwithDataBindMountbuilder

Adds a bind mount for the data folder to a Mosquitto container resource.

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

Parameters

sourcestring

isReadOnlybooleanoptional= False

Returns

MosquittoServerResource

methodwithDataVolumebuilder

Adds a named volume for the data folder to a Mosquitto container resource.

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