ValkeyResource Class

Reference

Definition

Namespace:: Aspire.Hosting.ApplicationModel

Assembly:: Aspire.Hosting.Valkey.dll

Package:: Aspire.Hosting.Valkey v8.2.0

Package:: Aspire.Hosting.Valkey v9.0.0

Source:: ValkeyResource.cs

Source:: ValkeyResource.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 Valkey resource independent of the hosting model.

public class ValkeyResource : Aspire.Hosting.ApplicationModel.ContainerResource, Aspire.Hosting.ApplicationModel.IResourceWithConnectionString

type ValkeyResource = class
    inherit ContainerResource
    interface IResourceWithConnectionString
    interface IResource
    interface IManifestExpressionProvider
    interface IValueProvider
    interface IValueWithReferences

Public Class ValkeyResource
Inherits ContainerResource
Implements IResourceWithConnectionString

Inheritance: Object

Resource

ContainerResource
ValkeyResource

Implements: IManifestExpressionProvider IResource IResourceWithConnectionString IValueProvider IValueWithReferences

Constructors

ValkeyResource(String)

A resource that represents a Valkey resource independent of the hosting model.

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
ConnectionStringExpression	Gets the connection string expression for the Valkey server.
Entrypoint	The container Entrypoint. (Inherited from ContainerResource)
Name	Gets the name of the resource. (Inherited from Resource)
PrimaryEndpoint	Gets the primary endpoint for the Valkey server.

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