ConnectionStringResource Class

Reference

Definition

Namespace:: Aspire.Hosting

Assembly:: Aspire.Hosting.dll

Package:: Aspire.Hosting v9.2.0

Package:: Aspire.Hosting v9.3.0

Source:: ConnectionStringResource.cs

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

Adds a connection string to the distributed application a resource with the specified expression.

public sealed class ConnectionStringResource : Aspire.Hosting.ApplicationModel.Resource, Aspire.Hosting.ApplicationModel.IResourceWithConnectionString, Aspire.Hosting.ApplicationModel.IResourceWithoutLifetime

type ConnectionStringResource = class
    inherit Resource
    interface IResourceWithConnectionString
    interface IResource
    interface IManifestExpressionProvider
    interface IValueProvider
    interface IValueWithReferences
    interface IResourceWithoutLifetime

Public NotInheritable Class ConnectionStringResource
Inherits Resource
Implements IResourceWithConnectionString, IResourceWithoutLifetime

Inheritance: Object

Resource
ConnectionStringResource

Implements: IManifestExpressionProvider IResource IResourceWithConnectionString IResourceWithoutLifetime IValueProvider IValueWithReferences

Constructors

ConnectionStringResource(String, ReferenceExpression)

Adds a connection string to the distributed application a resource with the specified expression.

Properties

Annotations	Gets the annotations associated with the resource. (Inherited from Resource)
ConnectionStringExpression	Describes the connection string format string used for this resource.
Name	Gets the name of the resource. (Inherited from Resource)

Extension Methods

GetDeploymentTargetAnnotation(IResource, IComputeEnvironmentResource)	Gets the deployment target for the specified resource, if any. Throws an exception if there are multiple compute environments and a compute environment is not explicitly specified.
GetReplicaCount(IResource)	Gets the number of replicas for the specified resource. Defaults to `1` if no ReplicaAnnotation is found.
HasAnnotationIncludingAncestorsOfType<T>(IResource)	Gets whether `resource` or its ancestors have an annotation of type `T`
HasAnnotationOfType<T>(IResource)	Gets whether `resource` has an annotation of type `T`
ProcessArgumentValuesAsync(IResource, DistributedApplicationExecutionContext, Action<Object,String,Exception,Boolean>, ILogger, String, CancellationToken)	Processes argument values for the specified resource in the given execution context.
ProcessEnvironmentVariableValuesAsync(IResource, DistributedApplicationExecutionContext, Action<String,Object,String,Exception>, ILogger, String, CancellationToken)	Processes environment variable values for the specified resource within the given execution context.
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.
TryGetUrls(IResource, IEnumerable<ResourceUrlAnnotation>)	Attempts to retrieve the URLs for the given resource.
AsProvisioningParameter(IManifestExpressionProvider, AzureResourceInfrastructure, String, Nullable<Boolean>)	Creates a new ProvisioningParameter in `infrastructure`, or reuses an existing bicep parameter if one with
IsContainer(IResource)	Determines whether the specified resource is a container resource.
AsEnvironmentPlaceholder(IManifestExpressionProvider, DockerComposeServiceResource)	Creates a placeholder for an environment variable in the Docker Compose file.
IsExisting(IResource)	Determines if the resource is an existing resource.

Applies to

Share via