Aspirerelease/17.0
Watch Aspire live streamsDocsTry Aspire

OpenWebUIResource

Handle
📦 CommunityToolkit.Aspire.Hosting.Ollama v13.6.1

A resource that represents an Open WebUI resource

type OpenWebUIResource interface {
ExpressionValue
IComputeResource
Resource
ResourceWithArgs
ResourceWithConnectionString
ResourceWithEndpoints
ResourceWithEnvironment
ResourceWithWaitSupport
}

Properties

propertyConnectionStringExpression*ReferenceExpressionget
Gets the connection string expression for the Open WebUI endpoint.
ConnectionStringExpression() *ReferenceExpression
propertyHostEndpointReferenceExpressionget
Gets the host endpoint reference for this resource.
Host() EndpointReferenceExpression
propertyOllamaResources[]OllamaResourceget
Gets the list of Ollama resources that are associated with this Open WebUI resource.
OllamaResources() ([]OllamaResource, error)
propertyPortEndpointReferenceExpressionget
Gets the port endpoint reference for this resource.
Port() EndpointReferenceExpression
propertyPrimaryEndpointEndpointReferenceget
Gets the http endpoint for the Open WebUI resource.
PrimaryEndpoint() EndpointReference
propertyUriExpression*ReferenceExpressionget
Gets the connection URI expression for the Open WebUI endpoint.
UriExpression() *ReferenceExpression

Methods

methodWithDataVolumebuilder
Adds a data volume to the Open WebUI container.
WithDataVolume(options ...*WithDataVolumeOptions) OpenWebUIResource
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.
IsReadOnly*boolA flag that indicates if this is a read-only volume.
OpenWebUIResource

A reference to the IResourceBuilder.

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

methodWithHostPortbuilder
Configures the host port that the Open WebUI resource is exposed on instead of using randomly assigned port.
WithHostPort(port *float64) OpenWebUIResource
port*float64The port to bind on the host. If null is used random port will be assigned.
OpenWebUIResource

The resource builder for Open WebUI.

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