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

propertyadminPasswordParameterParameterResourceget

Gets the parameter that contains the Keycloak admin password.

propertyadminUserNameParameterParameterResourceget

Gets the parameter that contains the Keycloak admin.

Methods

methodwithDataBindMountbuilder

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

withDataBindMount(source: string): KeycloakResource

Parameters

sourcestring

Returns

KeycloakResource

methodwithDataVolumebuilder

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

withDataVolume(name?: string): KeycloakResource

Parameters

namestringoptional

Returns

KeycloakResource

methodwithDisabledFeaturesbuilder

Additional feature names to disable for the keycloak resource

withDisabledFeatures(features: string[]): KeycloakResource

Parameters

featuresstring[]

Returns

KeycloakResource

methodwithEnabledFeaturesbuilder

Additional feature names to enable for the keycloak resource

withEnabledFeatures(features: string[]): KeycloakResource

Parameters

featuresstring[]

Returns

KeycloakResource

methodwithOtlpExporterbuilder

Configures the OTLP exporter for Keycloak

withOtlpExporter(protocol?: OtlpProtocol): KeycloakResource

Parameters

protocolOtlpProtocoloptional

Returns

KeycloakResource

methodwithRealmImportbuilder

Adds a realm import to a Keycloak container resource.

withRealmImport(importPath: string): KeycloakResource

Parameters

importPathstring

Returns

KeycloakResource