Skip to content
Docs Try Aspire
Docs Try

KeycloakResource

Handle
📦 Aspire.Hosting.Keycloak v13.3.0-preview.1.26254.5
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;
}

Properties

property adminPasswordParameter ParameterResource get
Gets the AdminPasswordParameter property
property adminUserNameParameter ParameterResource get
Gets the AdminUserNameParameter property

Methods

method withDataBindMount builder
Adds a data bind mount for Keycloak
withDataBindMount(source: string): KeycloakResource
source string
KeycloakResource
method withDataVolume builder
Adds a data volume for Keycloak
withDataVolume(name?: string): KeycloakResource
name string optional
KeycloakResource
method withDisabledFeatures builder
Disables Keycloak features
withDisabledFeatures(features: string[]): KeycloakResource
features string[]
KeycloakResource
method withEnabledFeatures builder
Enables Keycloak features
withEnabledFeatures(features: string[]): KeycloakResource
features string[]
KeycloakResource
method withOtlpExporter builder
Configures the OTLP exporter for Keycloak
withOtlpExporter(protocol?: OtlpProtocol): KeycloakResource
protocol OtlpProtocol optional
KeycloakResource
method withRealmImport builder
Imports a Keycloak realm configuration
withRealmImport(importPath: string): KeycloakResource
importPath string
KeycloakResource