Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

KeycloakResource

Handle
📦 Aspire.Hosting.Keycloak v17.0.0-preview.1.26565.2

A resource that represents a Keycloak resource.

type KeycloakResource interface {
IComputeResource
Resource
ResourceWithArgs
ResourceWithEndpoints
ResourceWithEnvironment
ResourceWithWaitSupport
}

Properties

propertyAdminPasswordParameterParameterResourceget
Gets the parameter that contains the Keycloak admin password.
AdminPasswordParameter() ParameterResource
propertyAdminUserNameParameterParameterResourceget
Gets the parameter that contains the Keycloak admin.
AdminUserNameParameter() ParameterResource
propertyResourceTypeDisplayNamestringget
Gets the ResourceTypeDisplayName property
ResourceTypeDisplayName() (string, error)

Methods

methodWithDataBindMountbuilder
Adds a bind mount for the data folder to a Keycloak container resource.
WithDataBindMount(source string) KeycloakResource
sourcestringThe source directory on the host to mount into the container.
KeycloakResource

The resource builder.

Returns a handle; failures surface later via Err().

methodWithDataVolumebuilder
Adds a named volume for the data folder to a Keycloak container resource.
WithDataVolume(options ...*WithDataVolumeOptions) KeycloakResource
options...*WithDataVolumeOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithDataVolumeOptions argument.

Name*stringThe name of the volume. Defaults to an auto-generated name based on the application and resource names.
KeycloakResource

The resource builder.

Returns a handle; failures surface later via Err().

Additional feature names to disable for the keycloak resource
WithDisabledFeatures(features []string) KeycloakResource
features[]stringNames of features to disable for the keycloak resource
KeycloakResource

The resource builder.

Returns a handle; failures surface later via Err().

methodWithEnabledFeaturesbuilder
Additional feature names to enable for the keycloak resource
WithEnabledFeatures(features []string) KeycloakResource
features[]stringNames of features to enable for the keycloak resource
KeycloakResource

The resource builder.

Returns a handle; failures surface later via Err().

methodWithOtlpExporterbuilder
Configures the OTLP exporter for Keycloak
WithOtlpExporter(options ...*WithOtlpExporterOptions) KeycloakResource
options...*WithOtlpExporterOptionsOptional settings, described under Options.

Optional parameters are passed in a trailing options ...*WithOtlpExporterOptions argument.

Protocol*OtlpProtocol
KeycloakResource

Returns a handle; failures surface later via Err().

methodWithRealmImportbuilder
Adds a realm import to a Keycloak container resource.
WithRealmImport(importPath string) KeycloakResource
importPathstring
KeycloakResource

Returns a handle; failures surface later via Err().