IDistributedApplicationBuilder

Interface

📦 Aspire.Hosting v13.3.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?: ReferenceExpression): IResourceWithConnectionString;
  addContainer(
      name: string,
      image: AddContainerOptions): ContainerResource;
  addContainerRegistry(
      name: string,
      endpoint: ParameterResource,
      repository?: 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;
  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: ParameterResource): ExternalServiceResource;
  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?: ProjectResourceOptions): ProjectResource;
  build(): DistributedApplication;
  getConfiguration(): IConfiguration;
  subscribeAfterResourcesCreated(callback: (arg: AfterResourcesCreatedEvent) => Promise<void>): DistributedApplicationEventSubscription;
  subscribeBeforeStart(callback: (arg: BeforeStartEvent) => Promise<void>): DistributedApplicationEventSubscription;
  tryAddEventingSubscriber(subscribe: (arg: EventingSubscriberRegistrationContext) => Promise<void>): void;
}

25 members

Properties

property appHostDirectory string get

Gets the AppHostDirectory property

property environment IHostEnvironment get

Gets the Environment property

property eventing IDistributedApplicationEventing get

Gets the Eventing property

property executionContext DistributedApplicationExecutionContext get

Gets the ExecutionContext property

property pipeline IDistributedApplicationPipeline get

Gets the Pipeline property

property userSecretsManager IUserSecretsManager get

Gets the UserSecretsManager property

Methods

method addConnectionString builder

Adds a connection string resource

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

Parameters

name string

environmentVariableNameOrExpression ReferenceExpression optional

Returns

IResourceWithConnectionString

method addContainer builder

Adds a container resource

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

Parameters

name string

image AddContainerOptions

Returns

ContainerResource

method addContainerRegistry builder

Adds a container registry resource

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

Parameters

name string

endpoint ParameterResource

repository ParameterResource optional

Returns

ContainerRegistryResource

method addCSharpApp builder

Adds a C# application resource

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

Parameters

name string

path string

options ProjectResourceOptions optional

Returns

CSharpAppResource

method addDockerfile builder

Adds a container resource built from a Dockerfile

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

Parameters

name string

contextPath string

dockerfilePath string optional

stage string optional

Returns

ContainerResource

method addDockerfileBuilder builder

Adds a container resource built from a programmatically generated Dockerfile

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

Parameters

name string

contextPath string

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

stage string optional

Returns

ContainerResource

method addDotnetTool builder

Adds a .NET tool resource

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

Parameters

name string

packageId string

Returns

DotnetToolResource

method addEventingSubscriber

Adds an eventing subscriber

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

Parameters

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

method addExecutable builder

Adds an executable resource

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

Parameters

name string

command string

workingDirectory string

args string[]

Returns

ExecutableResource

method addExternalService builder

Adds an external service resource

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

Parameters

name string

url ParameterResource

Returns

ExternalServiceResource

method addParameter builder

Adds a parameter resource

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

Parameters

name string

value string optional

publishValueAsDefault boolean optional = False

secret boolean optional = False

Returns

ParameterResource

method addParameterFromConfiguration builder

Adds a parameter sourced from configuration

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

Parameters

name string

configurationKey string

secret boolean optional = False

Returns

ParameterResource

method addParameterWithGeneratedValue builder

Adds a parameter with a generated default value

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

Parameters

name string

value GenerateParameterDefault

secret boolean optional = False

persist boolean optional = False

Returns

ParameterResource

method addProject builder

Adds a .NET project resource

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

Parameters

name string

projectPath string

launchProfileOrOptions ProjectResourceOptions optional

Returns

ProjectResource

method build

Builds the distributed application

build(): DistributedApplication

Returns

DistributedApplication

method getConfiguration

Gets the application configuration

getConfiguration(): IConfiguration

Returns

IConfiguration

method subscribeAfterResourcesCreated

Subscribes to the AfterResourcesCreated event

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

Parameters

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

Returns

DistributedApplicationEventSubscription

method subscribeBeforeStart

Subscribes to the BeforeStart event

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

Parameters

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

Returns

DistributedApplicationEventSubscription

method tryAddEventingSubscriber

Attempts to add an eventing subscriber

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

Parameters

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