IResourceWithEnvironment.withReference

Docs/Reference/Search TypeScript APIs/Aspire.Hosting/IResourceWithEnvironment/withReference

withReference

Docs Reference Search TypeScript APIs Aspire.Hosting IResourceWithEnvironment withReference

Method

📦 Aspire.Hosting v13.4.0

interface IResourceWithEnvironment {
  // ... omitted for brevity
  withReference(
      source: EndpointReference|string|uri,
      connectionName?: string,
      optional?: boolean,
      name?: string): IResourceWithEnvironment;
}

Signature

methodwithReferencebuilder

Adds a reference to another resource

withReference(
    source: EndpointReference|string|uri,
    connectionName?: string,
    optional?: boolean,
    name?: string): IResourceWithEnvironment

Parameters

sourceEndpointReference|string|uri

connectionNamestringoptional

optionalbooleanoptional= False

namestringoptional

Returns

IResourceWithEnvironment

Defined on

This method is defined on the following type:

interfaceIResourceWithEnvironment9 members