FlociAzureContainerResource

Handle

📦 CommunityToolkit.Aspire.Hosting.Floci v13.5.0

interface FlociAzureContainerResource
  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 scheme: EndpointReferenceExpression;
  withDataBindMount(
      source: string,
      isReadOnly?: boolean): FlociAzureContainerResource;
  withDataVolume(
      name: string,
      isReadOnly?: boolean): FlociAzureContainerResource;
  withDockerSocket(socketPath?: string): FlociAzureContainerResource;
  withFlociUI(configureContainer?: (obj: FlociUIContainerResource) => Promise<void>, containerName?: string): FlociAzureContainerResource;
}

9 members

Properties

propertyconnectionStringExpressionReferenceExpressionget

Gets the emulator endpoint URL, following the primary endpoint's `Scheme`.

propertyhostEndpointReferenceExpressionget

Gets the host endpoint reference for the primary endpoint.

propertyportEndpointReferenceExpressionget

Gets the port endpoint reference for the primary endpoint.

propertyprimaryEndpointEndpointReferenceget

Gets the primary endpoint reference for the Floci container.

propertyschemeEndpointReferenceExpressionget

Gets the scheme endpoint reference for the primary endpoint. `http` unless a TLS certificate has been configured, in which case the endpoint is switched to `https` before the application starts. Floci serves both on the same port, so the port never changes.

Methods

methodwithDataBindMountbuilder

Configures a bind mount for persistent Floci Azure state.

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

Parameters

sourcestring

isReadOnlybooleanoptional= False

Returns

FlociAzureContainerResource

methodwithDataVolumebuilder

Configures a named data volume for persistent Floci Azure state.

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

Parameters

namestring

isReadOnlybooleanoptional= False

Returns

FlociAzureContainerResource

methodwithDockerSocketbuilder

Mounts the Docker socket into the Floci Azure container so that Azure Functions and other container-backed services can launch sibling containers. Also sets `FLOCI_AZ_DOCKER_DOCKER_HOST` to `unix:///var/run/docker.sock` (the container-side path where the socket is always mounted) so Floci can connect to it.

withDockerSocket(socketPath?: string): FlociAzureContainerResource

Parameters

socketPathstringoptional= /var/run/docker.sock

Returns

FlociAzureContainerResource

methodwithFlociUIbuilder

Adds a Floci UI web console container for the Floci Azure resource

withFlociUI(configureContainer?: (obj: FlociUIContainerResource) => Promise<void>, containerName?: string): FlociAzureContainerResource

Parameters

configureContainer(obj: FlociUIContainerResource) => Promise<void>optional

containerNamestringoptional

Returns

FlociAzureContainerResource