IResourceWithConnectionString

Interface

📦 Aspire.Hosting v13.4.0

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

Parameters

namestring

valueReferenceExpression

Returns

IResourceWithConnectionString