IDistributedApplicationBuilder

Interface

📦 Aspire.Hosting v13.6.0

interface IDistributedApplicationBuilder {
  readonly appHostDirectory: string;
  readonly environment: IHostEnvironment;
  readonly eventing: IDistributedApplicationEventing;
  readonly executionContext: DistributedApplicationExecutionContext;
  readonly pipeline: IDistributedApplicationPipeline;
  readonly userSecretsManager: IUserSecretsManager;
  addConnectionString(
      name: string,
      environmentVariableNameOrExpression?: string | ReferenceExpression): IResourceWithConnectionString;
  addContainer(
      name: string,
      image: string | AddContainerOptions): ContainerResource;
  addContainerRegistry(
      name: string,
      endpoint: string | ParameterResource,
      repository?: string | ParameterResource): ContainerRegistryResource;
  addCSharpApp(
      name: string,
      path: string,
      options?: ProjectResourceOptions): CSharpAppResource;
  addDockerfile(
      name: string,
      contextPath: string,
      dockerfilePath?: string,
      stage?: string): ContainerResource;
  addDockerfileBuilder(name: string, contextPath: string, callback: (arg: DockerfileBuilderCallbackContext) => Promise<void>, stage?: string): ContainerResource;
  addDockerfileFactory(name: string, contextPath: string, dockerfileFactory: (arg: DockerfileFactoryContext) => Promise<string>, stage?: string): ContainerResource;
  addDotnetTool(
      name: string,
      packageId: string): DotnetToolResource;
  addEventingSubscriber(subscribe: (arg: EventingSubscriberRegistrationContext) => Promise<void>): void;
  addExecutable(
      name: string,
      command: string,
      workingDirectory: string,
      args: string[]): ExecutableResource;
  addExternalService(
      name: string,
      url: string | uri | ParameterResource): ExternalServiceResource;
  addHealthCheck(name: string, check: () => Promise<HealthCheckResult>): void;
  addParameter(
      name: string,
      value?: string,
      publishValueAsDefault?: boolean,
      secret?: boolean): ParameterResource;
  addParameterFromConfiguration(
      name: string,
      configurationKey: string,
      secret?: boolean): ParameterResource;
  addParameterWithGeneratedValue(
      name: string,
      value: GenerateParameterDefault,
      secret?: boolean,
      persist?: boolean): ParameterResource;
  addProject(
      name: string,
      projectPath: string,
      launchProfileOrOptions?: string | ProjectResourceOptions): ProjectResource;
  build(): DistributedApplication;
  getConfiguration(): IConfiguration;
  subscribeAfterPublish(callback: (arg: AfterPublishEvent) => Promise<void>): DistributedApplicationEventSubscription;
  subscribeAfterResourcesCreated(callback: (arg: AfterResourcesCreatedEvent) => Promise<void>): DistributedApplicationEventSubscription;
  subscribeBeforePublish(callback: (arg: BeforePublishEvent) => Promise<void>): DistributedApplicationEventSubscription;
  subscribeBeforeStart(callback: (arg: BeforeStartEvent) => Promise<void>): DistributedApplicationEventSubscription;
  tryAddEventingSubscriber(subscribe: (arg: EventingSubscriberRegistrationContext) => Promise<void>): void;
}

29 members

Properties

propertyappHostDirectorystringget

Directory of the project where the AppHost is located. Defaults to the content root if there's no project.

propertyenvironmentIHostEnvironmentget

Gets the Environment property

propertyeventingIDistributedApplicationEventingget

Eventing infrastructure for AppHost lifecycle.

propertyexecutionContextDistributedApplicationExecutionContextget

Execution context for this invocation of the AppHost.

propertypipelineIDistributedApplicationPipelineget

Gets the deployment pipeline for this distributed application.

propertyuserSecretsManagerIUserSecretsManagerget

Gets the service for managing user secrets.

Methods

methodaddConnectionStringbuilder

Adds a connection string resource

addConnectionString(
    name: string,
    environmentVariableNameOrExpression?: string | ReferenceExpression): IResourceWithConnectionString

Parameters

namestring

environmentVariableNameOrExpressionstring | ReferenceExpressionoptional

Returns

IResourceWithConnectionString

methodaddContainerbuilder

Adds a container resource to the application.

addContainer(
    name: string,
    image: string | AddContainerOptions): ContainerResource

Parameters

namestring

imagestring | AddContainerOptions

Returns

ContainerResource

methodaddContainerRegistrybuilder

Adds a container registry resource

addContainerRegistry(
    name: string,
    endpoint: string | ParameterResource,
    repository?: string | ParameterResource): ContainerRegistryResource

Parameters

namestring

endpointstring | ParameterResource

repositorystring | ParameterResourceoptional

Returns

ContainerRegistryResource

methodaddCSharpAppbuilder

Adds a C# application resource

addCSharpApp(
    name: string,
    path: string,
    options?: ProjectResourceOptions): CSharpAppResource

Parameters

namestring

pathstring

optionsProjectResourceOptionsoptional

Returns

CSharpAppResource

methodaddDockerfilebuilder

Adds a Dockerfile to the application model that can be treated like a container resource.

addDockerfile(
    name: string,
    contextPath: string,
    dockerfilePath?: string,
    stage?: string): ContainerResource

Parameters

namestring

contextPathstring

dockerfilePathstringoptional

stagestringoptional

Returns

ContainerResource

methodaddDockerfileBuilderbuilder

Adds a container resource built from a programmatically generated Dockerfile

addDockerfileBuilder(name: string, contextPath: string, callback: (arg: DockerfileBuilderCallbackContext) => Promise<void>, stage?: string): ContainerResource

Parameters

namestring

contextPathstring

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

stagestringoptional

Returns

ContainerResource

methodaddDockerfileFactorybuilder

Adds a Dockerfile to the application model that can be treated like a container resource, with the Dockerfile content generated by an asynchronous factory function.

addDockerfileFactory(name: string, contextPath: string, dockerfileFactory: (arg: DockerfileFactoryContext) => Promise<string>, stage?: string): ContainerResource

Parameters

namestring

contextPathstring

dockerfileFactory(arg: DockerfileFactoryContext) => Promise<string>

stagestringoptional

Returns

ContainerResource

methodaddDotnetToolbuilder

Adds a .NET tool resource to the application model.

addDotnetTool(
    name: string,
    packageId: string): DotnetToolResource

Parameters

namestring

packageIdstring

Returns

DotnetToolResource

methodaddEventingSubscriber

Adds an ATS-friendly eventing subscriber callback to the distributed-application builder.

addEventingSubscriber(subscribe: (arg: EventingSubscriberRegistrationContext) => Promise<void>): void

Parameters

subscribe(arg: EventingSubscriberRegistrationContext) => Promise<void>

methodaddExecutablebuilder

Adds an executable resource to the application model.

addExecutable(
    name: string,
    command: string,
    workingDirectory: string,
    args: string[]): ExecutableResource

Parameters

namestring

commandstring

workingDirectorystring

argsstring[]

Returns

ExecutableResource

methodaddExternalServicebuilder

Adds an external service resource

addExternalService(
    name: string,
    url: string | uri | ParameterResource): ExternalServiceResource

Parameters

namestring

urlstring | uri | ParameterResource

Returns

ExternalServiceResource

methodaddHealthCheck

Adds a custom health check callback to the distributed-application builder.

addHealthCheck(name: string, check: () => Promise<HealthCheckResult>): void

Parameters

namestring

check() => Promise<HealthCheckResult>

methodaddParameterbuilder

Adds a parameter resource

addParameter(
    name: string,
    value?: string,
    publishValueAsDefault?: boolean,
    secret?: boolean): ParameterResource

Parameters

namestring

valuestringoptional

publishValueAsDefaultbooleanoptional= False

secretbooleanoptional= False

Returns

ParameterResource

methodaddParameterFromConfigurationbuilder

Adds a parameter resource to the application, with a value coming from configuration.

addParameterFromConfiguration(
    name: string,
    configurationKey: string,
    secret?: boolean): ParameterResource

Parameters

namestring

configurationKeystring

secretbooleanoptional= False

Returns

ParameterResource

methodaddParameterWithGeneratedValuebuilder

Adds a parameter with a generated default value

addParameterWithGeneratedValue(
    name: string,
    value: GenerateParameterDefault,
    secret?: boolean,
    persist?: boolean): ParameterResource

Parameters

namestring

valueGenerateParameterDefault

secretbooleanoptional= False

persistbooleanoptional= False

Returns

ParameterResource

methodaddProjectbuilder

Adds a .NET project resource

addProject(
    name: string,
    projectPath: string,
    launchProfileOrOptions?: string | ProjectResourceOptions): ProjectResource

Parameters

namestring

projectPathstring

launchProfileOrOptionsstring | ProjectResourceOptionsoptional

Returns

ProjectResource

methodbuild

Builds the distributed application

build(): DistributedApplication

Returns

DistributedApplication

methodgetConfiguration

Gets the application configuration.

getConfiguration(): IConfiguration

Returns

IConfiguration

methodsubscribeAfterPublish

Subscribes to the AfterPublish event, which fires after the application is published.

subscribeAfterPublish(callback: (arg: AfterPublishEvent) => Promise<void>): DistributedApplicationEventSubscription

Parameters

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

Returns

DistributedApplicationEventSubscription

methodsubscribeAfterResourcesCreated

Subscribes to the AfterResourcesCreated event, which fires after all resources are created.

subscribeAfterResourcesCreated(callback: (arg: AfterResourcesCreatedEvent) => Promise<void>): DistributedApplicationEventSubscription

Parameters

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

Returns

DistributedApplicationEventSubscription

methodsubscribeBeforePublish

Subscribes to the BeforePublish event, which fires before the application is published.

subscribeBeforePublish(callback: (arg: BeforePublishEvent) => Promise<void>): DistributedApplicationEventSubscription

Parameters

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

Returns

DistributedApplicationEventSubscription

methodsubscribeBeforeStart

Subscribes to the BeforeStart event, which fires before the application starts.

subscribeBeforeStart(callback: (arg: BeforeStartEvent) => Promise<void>): DistributedApplicationEventSubscription

Parameters

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

Returns

DistributedApplicationEventSubscription

methodtryAddEventingSubscriber

Attempts to add an ATS-friendly eventing subscriber callback to the distributed-application builder.

tryAddEventingSubscriber(subscribe: (arg: EventingSubscriberRegistrationContext) => Promise<void>): void

Parameters

subscribe(arg: EventingSubscriberRegistrationContext) => Promise<void>