DbGateContainerResource

Handle

📦 CommunityToolkit.Aspire.Hosting.DbGate v13.4.0

interface DbGateContainerResource
  extends IComputeResource,
    IResource,
    IResourceWithArgs,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport {
  readonly primaryEndpoint: EndpointReference;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): DbGateContainerResource;
  withDataVolume(
      name?: string,
      isReadOnly?: boolean): DbGateContainerResource;
  withHostPort(port: number): DbGateContainerResource;
}

Properties

property primaryEndpoint EndpointReference get

Gets the primary endpoint for the DbGate.

Methods

method withDataBindMount builder

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

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

Parameters

source string

isReadOnly boolean optional = False

Returns

DbGateContainerResource

method withDataVolume builder

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

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

Parameters

name string optional

isReadOnly boolean optional = False

Returns

DbGateContainerResource

method withHostPort builder

Configures the host port that the DbGate resource is exposed on instead of using randomly assigned port.

withHostPort(port: number): DbGateContainerResource

Parameters

port number

Returns

DbGateContainerResource