IResourceWithEnvironment

Interface

📦 Aspire.Hosting v13.3.0

interface IResourceWithEnvironment {
  withCertificateTrustScope(scope: CertificateTrustScope): IResourceWithEnvironment;
  withDeveloperCertificateTrust(trust: boolean): IResourceWithEnvironment;
  withEnvironment(
      name: string,
      value: IExpressionValue): IResourceWithEnvironment;
  withEnvironmentCallback(callback: (arg: EnvironmentCallbackContext) => Promise<void>): IResourceWithEnvironment;
  withHttpsDeveloperCertificate(password?: ParameterResource): IResourceWithEnvironment;
  withOtlpExporter(protocol?: OtlpProtocol): IResourceWithEnvironment;
  withoutHttpsCertificate(): IResourceWithEnvironment;
  withReference(
      source: EndpointReference|string|uri,
      connectionName?: string,
      optional?: boolean,
      name?: string): IResourceWithEnvironment;
  withReferenceEnvironment(options: ReferenceEnvironmentInjectionOptions): IResourceWithEnvironment;
}

9 members

Methods

method withCertificateTrustScope builder

Sets the certificate trust scope

withCertificateTrustScope(scope: CertificateTrustScope): IResourceWithEnvironment

Parameters

scope CertificateTrustScope

Returns

IResourceWithEnvironment

method withDeveloperCertificateTrust builder

Configures developer certificate trust

withDeveloperCertificateTrust(trust: boolean): IResourceWithEnvironment

Parameters

trust boolean

Returns

IResourceWithEnvironment

method withEnvironment builder

Sets an environment variable

withEnvironment(
    name: string,
    value: IExpressionValue): IResourceWithEnvironment

Parameters

name string

value IExpressionValue

Returns

IResourceWithEnvironment

method withEnvironmentCallback builder

Sets environment variables via callback

withEnvironmentCallback(callback: (arg: EnvironmentCallbackContext) => Promise<void>): IResourceWithEnvironment

Parameters

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

Returns

IResourceWithEnvironment

method withHttpsDeveloperCertificate builder

Configures HTTPS with a developer certificate

withHttpsDeveloperCertificate(password?: ParameterResource): IResourceWithEnvironment

Parameters

password ParameterResource optional

Returns

IResourceWithEnvironment

method withOtlpExporter builder

Configures OTLP telemetry export

withOtlpExporter(protocol?: OtlpProtocol): IResourceWithEnvironment

Parameters

protocol OtlpProtocol optional

Returns

IResourceWithEnvironment

method withoutHttpsCertificate builder

Removes HTTPS certificate configuration

withoutHttpsCertificate(): IResourceWithEnvironment

Returns

IResourceWithEnvironment

method withReference builder

Adds a reference to another resource

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

Parameters

source EndpointReference|string|uri

connectionName string optional

optional boolean optional = False

name string optional

Returns

IResourceWithEnvironment

method withReferenceEnvironment builder

Configures which reference values are injected into environment variables

withReferenceEnvironment(options: ReferenceEnvironmentInjectionOptions): IResourceWithEnvironment

Parameters

options ReferenceEnvironmentInjectionOptions

Returns

IResourceWithEnvironment