KeycloakResource Class

Reference

Definition

Namespace:: Aspire.Hosting.ApplicationModel

Assembly:: Aspire.Hosting.Keycloak.dll

Package:: Aspire.Hosting.Keycloak v8.2.2-preview.1.24521.5

Package:: Aspire.Hosting.Keycloak v9.0.0-preview.5.24551.3

Source:: KeycloakResource.cs

Source:: KeycloakResource.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

A resource that represents a Keycloak resource.

public sealed class KeycloakResource : Aspire.Hosting.ApplicationModel.ContainerResource, Aspire.Hosting.IResourceWithServiceDiscovery

type KeycloakResource = class
    inherit ContainerResource
    interface IResourceWithServiceDiscovery
    interface IResourceWithEndpoints
    interface IResource

Public NotInheritable Class KeycloakResource
Inherits ContainerResource
Implements IResourceWithServiceDiscovery

Inheritance: Object

Resource

ContainerResource
KeycloakResource

Implements: IResource IResourceWithEndpoints IResourceWithServiceDiscovery

Constructors

KeycloakResource(String, ParameterResource, ParameterResource)

A resource that represents a Keycloak resource.

Properties

AdminPasswordParameter	Gets the parameter that contains the Keycloak admin password.
AdminUserNameParameter	Gets the parameter that contains the Keycloak admin.
Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
Entrypoint	The container Entrypoint. (Inherited from ContainerResource)
Name	Gets the name of the resource. (Inherited from Resource)

Extension Methods

GetEndpoint(IResourceWithEndpoints, String)	Gets an endpoint reference for the specified endpoint name.
GetEndpoints(IResourceWithEndpoints)	Gets the endpoints for the specified resource.
GetEnvironmentVariableValuesAsync(IResourceWithEnvironment, DistributedApplicationOperation)	Get the environment variables from the given resource.
GetReplicaCount(IResource)	Gets the number of replicas for the specified resource. Defaults to `1` if no ReplicaAnnotation is found.
TryGetAnnotationsIncludingAncestorsOfType<T>(IResource, IEnumerable<T>)	Attempts to retrieve all annotations of the specified type from the given resource including from parents.
TryGetAnnotationsOfType<T>(IResource, IEnumerable<T>)	Attempts to retrieve all annotations of the specified type from the given resource.
TryGetContainerImageName(IResource, String)	Attempts to get the container image name from the given resource.
TryGetContainerMounts(IResource, IEnumerable<ContainerMountAnnotation>)	Attempts to get the container mounts for the specified resource.
TryGetEndpoints(IResource, IEnumerable<EndpointAnnotation>)	Attempts to retrieve the endpoints for the given resource.
TryGetEnvironmentVariables(IResource, IEnumerable<EnvironmentCallbackAnnotation>)	Attempts to get the environment variables from the given resource.
TryGetLastAnnotation<T>(IResource, T)	Attempts to get the last annotation of the specified type from the resource.
IsContainer(IResource)	Determines whether the specified resource is a container resource.

Applies to

Share via