IDistributedApplicationBuilder

Docs / Reference / Search TypeScript APIs / Aspire.Hosting / IDistributedApplicationBuilder

IDistributedApplicationBuilder

Docs Reference Search TypeScript APIs Aspire.Hosting IDistributedApplicationBuilder

Interface

📦 Aspire.Hosting v13.2.0

interface IDistributedApplicationBuilder {
  readonly appHostDirectory: string;
  readonly environment: IHostEnvironment;
  readonly eventing: IDistributedApplicationEventing;
  readonly executionContext: DistributedApplicationExecutionContext;
  readonly userSecretsManager: IUserSecretsManager;
  addConnectionString(
      name: string,
      environmentVariableName?: string): IResourceWithConnectionString;
  addConnectionStringBuilder(name: string, connectionStringBuilder: (obj: ReferenceExpressionBuilder) => void): ConnectionStringResource;
  addConnectionStringExpression(
      name: string,
      connectionStringExpression: ReferenceExpression): ConnectionStringResource;
  addContainer(
      name: string,
      image: string): ContainerResource;
  addContainerRegistry(
      name: string,
      endpoint: ParameterResource,
      repository?: ParameterResource): ContainerRegistryResource;
  addContainerRegistryFromString(
      name: string,
      endpoint: string,
      repository?: string): ContainerRegistryResource;
  addCSharpApp(
      name: string,
      path: string): ProjectResource;
  addCSharpAppWithOptions(name: string, path: string, configure: (obj: ProjectResourceOptions) => void): CSharpAppResource;
  addDockerfile(
      name: string,
      contextPath: string,
      dockerfilePath?: string,
      stage?: string): ContainerResource;
  addDotnetTool(
      name: string,
      packageId: string): DotnetToolResource;
  addExecutable(
      name: string,
      command: string,
      workingDirectory: string,
      args: string[]): ExecutableResource;
  addExternalService(
      name: string,
      url: string): ExternalServiceResource;
  addExternalServiceParameter(
      name: string,
      urlParameter: ParameterResource): ExternalServiceResource;
  addExternalServiceUri(
      name: string,
      uri: uri): ExternalServiceResource;
  addParameter(
      name: string,
      secret?: boolean): ParameterResource;
  addParameterFromConfiguration(
      name: string,
      configurationKey: string,
      secret?: boolean): ParameterResource;
  addParameterWithValue(
      name: string,
      value: string,
      publishValueAsDefault?: boolean,
      secret?: boolean): ParameterResource;
  addProject(
      name: string,
      projectPath: string,
      launchProfileName: string): ProjectResource;
  addProjectWithOptions(name: string, projectPath: string, configure: (obj: ProjectResourceOptions) => void): ProjectResource;
  build(): DistributedApplication;
  getConfiguration(): IConfiguration;
  subscribeAfterResourcesCreated(callback: (arg: AfterResourcesCreatedEvent) => void): DistributedApplicationEventSubscription;
  subscribeBeforeStart(callback: (arg: BeforeStartEvent) => void): DistributedApplicationEventSubscription;
}

Search members of IDistributedApplicationBuilder…

method property

28 members Clear filters

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 userSecretsManager IUserSecretsManager get

Gets the UserSecretsManager property

Methods

method addConnectionString builder

Adds a connection string resource

addConnectionString(
    name: string,
    environmentVariableName?: string): IResourceWithConnectionString

Parameters

name string

environmentVariableName string optional

Returns

IResourceWithConnectionString

method addConnectionStringBuilder builder

Adds a connection string with a builder callback

addConnectionStringBuilder(name: string, connectionStringBuilder: (obj: ReferenceExpressionBuilder) => void): ConnectionStringResource

Parameters

name string

connectionStringBuilder (obj: ReferenceExpressionBuilder) => void

Returns

ConnectionStringResource

method addConnectionStringExpression builder

Adds a connection string with a reference expression

addConnectionStringExpression(
    name: string,
    connectionStringExpression: ReferenceExpression): ConnectionStringResource

Parameters

name string

connectionStringExpression ReferenceExpression

Returns

ConnectionStringResource

method addContainer builder

Adds a container resource

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

Parameters

name string

image string

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 addContainerRegistryFromString builder

Adds a container registry with string endpoint

addContainerRegistryFromString(
    name: string,
    endpoint: string,
    repository?: string): ContainerRegistryResource

Parameters

name string

endpoint string

repository string optional

Returns

ContainerRegistryResource

method addCSharpApp builder

Adds a C# application resource

addCSharpApp(
    name: string,
    path: string): ProjectResource

Parameters

name string

path string

Returns

ProjectResource

method addCSharpAppWithOptions builder

Adds a C# application resource with configuration options

addCSharpAppWithOptions(name: string, path: string, configure: (obj: ProjectResourceOptions) => void): CSharpAppResource

Parameters

name string

path string

configure (obj: ProjectResourceOptions) => void

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 addDotnetTool builder

Adds a .NET tool resource

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

Parameters

name string

packageId string

Returns

DotnetToolResource

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: string): ExternalServiceResource

Parameters

name string

url string

Returns

ExternalServiceResource

method addExternalServiceParameter builder

Adds an external service with a parameter URL

addExternalServiceParameter(
    name: string,
    urlParameter: ParameterResource): ExternalServiceResource

Parameters

name string

urlParameter ParameterResource

Returns

ExternalServiceResource

method addExternalServiceUri builder

Adds an external service with a URI

addExternalServiceUri(
    name: string,
    uri: uri): ExternalServiceResource

Parameters

name string

uri uri

Returns

ExternalServiceResource

method addParameter builder

Adds a parameter resource

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

Parameters

name string

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 addParameterWithValue builder

Adds a parameter with a default value

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

Parameters

name string

value string

publishValueAsDefault boolean optional = False

secret boolean optional = False

Returns

ParameterResource

method addProject builder

Adds a .NET project resource

addProject(
    name: string,
    projectPath: string,
    launchProfileName: string): ProjectResource

Parameters

name string

projectPath string

launchProfileName string

Returns

ProjectResource

method addProjectWithOptions builder

Adds a project resource with configuration options

addProjectWithOptions(name: string, projectPath: string, configure: (obj: ProjectResourceOptions) => void): ProjectResource

Parameters

name string

projectPath string

configure (obj: ProjectResourceOptions) => void

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) => void): DistributedApplicationEventSubscription

Parameters

callback (arg: AfterResourcesCreatedEvent) => void

Returns

DistributedApplicationEventSubscription

method subscribeBeforeStart

Subscribes to the BeforeStart event

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

Parameters

callback (arg: BeforeStartEvent) => void

Returns

DistributedApplicationEventSubscription