IResourceWithEnvironment

Interface

📦 Aspire.Hosting v13.4.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

Indicates whether developer certificates should be treated as trusted certificate authorities for the resource at run time. Currently this indicates trust for the ASP.NET Core developer certificate. The developer certificate will only be trusted when running in local development scenarios; in publish mode resources will use their default 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

Allows for the population of environment variables on a resource.

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

Parameters

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

Returns

IResourceWithEnvironment

method withHttpsDeveloperCertificate builder

Indicates that a resource should use the developer certificate key pair for HTTPS endpoints at run time. Currently this indicates use of the ASP.NET Core developer certificate. The developer certificate will only be used when running in local development scenarios; in publish mode resources will use their default certificate configuration.

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

Disable HTTPS/TLS server certificate configuration for the resource. No HTTPS/TLS termination configuration will be applied.

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 how information is injected into environment variables when the resource references other resources.

withReferenceEnvironment(options: ReferenceEnvironmentInjectionOptions): IResourceWithEnvironment

Parameters

options ReferenceEnvironmentInjectionOptions

Returns

IResourceWithEnvironment