IResourceWithConnectionString

1. Docs
2. /Reference
3. /Search TypeScript APIs
4. /Aspire.Hosting
5. /IResourceWithConnectionString

Interface

📦 Aspire.Hosting v13.6.0

interface IResourceWithConnectionString {
  getConnectionProperty(key: string): ReferenceExpression;
  onConnectionStringAvailable(callback: (arg: ConnectionStringAvailableEvent) => Promise<void>): IResourceWithConnectionString;
  withConnectionProperty(
      name: string,
      value: string | ReferenceExpression): IResourceWithConnectionString;
}

Methods

methodgetConnectionProperty

Retrieves the value of a specified connection property from the resource's connection properties.

getConnectionProperty(key: string): ReferenceExpression

Parameters

keystring

Returns

ReferenceExpression

methodonConnectionStringAvailablebuilder

Subscribes to the ConnectionStringAvailable event.

onConnectionStringAvailable(callback: (arg: ConnectionStringAvailableEvent) => Promise<void>): IResourceWithConnectionString

Parameters

callback(arg: ConnectionStringAvailableEvent) => Promise<void>

Returns

IResourceWithConnectionString

methodwithConnectionPropertybuilder

Adds a connection property annotation to the resource being built.

withConnectionProperty(
    name: string,
    value: string | ReferenceExpression): IResourceWithConnectionString

Parameters

namestring

valuestring | ReferenceExpression

Returns

IResourceWithConnectionString