KeycloakResource

Docs / Reference / TypeScript APIs / Aspire.Hosting.Keycloak / KeycloakResource

KeycloakResource

Docs Reference TypeScript APIs Aspire.Hosting.Keycloak KeycloakResource

Handle TypeScript

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

interface KeycloakResource
  extends IComputeResource,
    IResource,
    IResourceWithArgs,
    IResourceWithEndpoints,
    IResourceWithEnvironment,
    IResourceWithProbes,
    IResourceWithWaitSupport,
    IResourceWithServiceDiscovery {
  entrypoint: string;
  readonly name: string;
  shellExecution: boolean;
  withDataBindMount(source: string): KeycloakResource;
  withDataVolume(name?: string): KeycloakResource;
  withDisabledFeatures(features: string[]): KeycloakResource;
  withEnabledFeatures(features: string[]): KeycloakResource;
  withOtlpExporter(): KeycloakResource;
  withOtlpExporterWithProtocol(protocol: OtlpProtocol): KeycloakResource;
  withRealmImport(importPath: string): KeycloakResource;
}

Implements

• IComputeResource
• IResource
• IResourceWithArgs
• IResourceWithEndpoints
• IResourceWithEnvironment
• IResourceWithProbes
• IResourceWithWaitSupport
• IResourceWithServiceDiscovery

Search members of KeycloakResource…

method property

12 members Clear filters

Properties

property entrypoint string get · set

Gets the Entrypoint property

property name string get

Gets the Name property

property shellExecution boolean get · set

Gets the ShellExecution property

Methods

method withDataBindMount builder

Adds a data bind mount for Keycloak

withDataBindMount(source: string): KeycloakResource

Parameters

source string

Returns

KeycloakResource

method withDataVolume builder

Adds a data volume for Keycloak

withDataVolume(name?: string): KeycloakResource

Parameters

name string optional

Returns

KeycloakResource

method withDisabledFeatures builder

Disables Keycloak features

withDisabledFeatures(features: string[]): KeycloakResource

Parameters

features string[]

Returns

KeycloakResource

method withEnabledFeatures builder

Enables Keycloak features

withEnabledFeatures(features: string[]): KeycloakResource

Parameters

features string[]

Returns

KeycloakResource

method withOtlpExporter builder

Configures the OTLP exporter for Keycloak

withOtlpExporter(): KeycloakResource

Returns

KeycloakResource

method withOtlpExporterWithProtocol builder

Configures the OTLP exporter for Keycloak with a specific protocol

withOtlpExporterWithProtocol(protocol: OtlpProtocol): KeycloakResource

Parameters

protocol OtlpProtocol

Returns

KeycloakResource

method withRealmImport builder

Imports a Keycloak realm configuration

withRealmImport(importPath: string): KeycloakResource

Parameters

importPath string

Returns

KeycloakResource