IResourceWithConnectionString Interface

Reference

Definition

Namespace:: Aspire.Hosting.ApplicationModel

Assembly:: Aspire.Hosting.dll

Package:: Aspire.Hosting v8.0.0

Package:: Aspire.Hosting v8.0.1

Source:: IResourceWithConnectionString.cs

Source:: IResourceWithConnectionString.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.

Represents a resource that has a connection string associated with it.

public interface IResourceWithConnectionString : Aspire.Hosting.ApplicationModel.IManifestExpressionProvider, Aspire.Hosting.ApplicationModel.IResource, Aspire.Hosting.ApplicationModel.IValueProvider, Aspire.Hosting.ApplicationModel.IValueWithReferences

type IResourceWithConnectionString = interface
    interface IResource
    interface IManifestExpressionProvider
    interface IValueProvider
    interface IValueWithReferences

Public Interface IResourceWithConnectionString
Implements IManifestExpressionProvider, IResource, IValueProvider, IValueWithReferences

Derived: Aspire.Hosting.ApplicationModel.AzureOpenAIResource

Aspire.Hosting.ApplicationModel.AzureSignalRResource

Aspire.Hosting.ApplicationModel.MongoDBDatabaseResource

Aspire.Hosting.ApplicationModel.MongoDBServerResource

Aspire.Hosting.ApplicationModel.MySqlDatabaseResource

More…

Implements: IManifestExpressionProvider IResource IValueProvider IValueWithReferences

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from IResource)
ConnectionStringEnvironmentVariable	The environment variable name to use for the connection string.
ConnectionStringExpression	Describes the connection string format string used for this resource.
Name	Gets the name of the resource. (Inherited from IResource)
References	The referenced objects of the value. (Inherited from IValueWithReferences)
ValueExpression	Gets the expression that represents a value in manifest. (Inherited from IManifestExpressionProvider)

Methods

GetConnectionStringAsync(CancellationToken)	Gets the connection string associated with the resource.
GetValueAsync(CancellationToken)	Gets the value for use as an environment variable. (Inherited from IValueProvider)

Explicit Interface Implementations

IManifestExpressionProvider.ValueExpression
IValueProvider.GetValueAsync(CancellationToken)
IValueWithReferences.References

Extension Methods

GetReplicaCount(IResource)	Gets the number of replicas for the specified resource. Defaults to `1` if no ReplicaAnnotation is found.
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