KeycloakResource

Handle

📦 Aspire.Hosting.Keycloak v13.4.0-preview.1.26281.18

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

8 members

Properties

property adminPasswordParameter ParameterResource get

Gets the parameter that contains the Keycloak admin password.

property adminUserNameParameter ParameterResource get

Gets the parameter that contains the Keycloak admin.

Methods

method withDataBindMount builder

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

withDataBindMount(source: string): KeycloakResource

Parameters

source string

Returns

KeycloakResource

method withDataVolume builder

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

withDataVolume(name?: string): KeycloakResource

Parameters

name string optional

Returns

KeycloakResource

method withDisabledFeatures builder

Additional feature names to disable for the keycloak resource

withDisabledFeatures(features: string[]): KeycloakResource

Parameters

features string[]

Returns

KeycloakResource

method withEnabledFeatures builder

Additional feature names to enable for the keycloak resource

withEnabledFeatures(features: string[]): KeycloakResource

Parameters

features string[]

Returns

KeycloakResource

method withOtlpExporter builder

Configures the OTLP exporter for Keycloak

withOtlpExporter(protocol?: OtlpProtocol): KeycloakResource

Parameters

protocol OtlpProtocol optional

Returns

KeycloakResource

method withRealmImport builder

Adds a realm import to a Keycloak container resource.

withRealmImport(importPath: string): KeycloakResource

Parameters

importPath string

Returns

KeycloakResource