IResourceWithEnvironment

Interface

📦 Aspire.Hosting v13.6.0

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

10 members

Methods

methodwithCertificateTrustScopebuilder

Sets the certificate trust scope

withCertificateTrustScope(scope: CertificateTrustScope): IResourceWithEnvironment

Parameters

scopeCertificateTrustScope

Returns

IResourceWithEnvironment

methodwithDeveloperCertificateTrustbuilder

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

trustboolean

Returns

IResourceWithEnvironment

methodwithEnvironmentbuilder

Sets an environment variable

withEnvironment(
    name: string,
    value: string | ReferenceExpression | EndpointReference | ParameterResource | ExternalServiceResource | IResourceWithConnectionString | IExpressionValue): IResourceWithEnvironment

Parameters

namestring

value

string | ReferenceExpression | EndpointReference | ParameterResource | ExternalServiceResource | IResourceWithConnectionString | IExpressionValue

Returns

IResourceWithEnvironment

methodwithEnvironmentCallbackbuilder

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

methodwithHttpsCertificateConfigurationbuilder

Adds a callback that allows configuring the resource to use a specific HTTPS/TLS certificate key pair for server authentication.

withHttpsCertificateConfiguration(callback: (arg: HttpsCertificateConfigurationCallbackAnnotationContext) => Promise<void>): IResourceWithEnvironment

Parameters

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

Returns

IResourceWithEnvironment

methodwithHttpsDeveloperCertificatebuilder

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

passwordParameterResourceoptional

Returns

IResourceWithEnvironment

methodwithOtlpExporterbuilder

Configures OTLP telemetry export

withOtlpExporter(protocol?: OtlpProtocol): IResourceWithEnvironment

Parameters

protocolOtlpProtocoloptional

Returns

IResourceWithEnvironment

methodwithoutHttpsCertificatebuilder

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

withoutHttpsCertificate(): IResourceWithEnvironment

Returns

IResourceWithEnvironment

methodwithReferencebuilder

Adds a reference to another resource

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

Parameters

sourceIResource | EndpointReference | string | uri

connectionNamestringoptional

optionalbooleanoptional= False

namestringoptional

Returns

IResourceWithEnvironment

methodwithReferenceEnvironmentbuilder

Configures how information is injected into environment variables when the resource references other resources.

withReferenceEnvironment(options: ReferenceEnvironmentInjectionOptions): IResourceWithEnvironment

Parameters

optionsReferenceEnvironmentInjectionOptions

Returns

IResourceWithEnvironment