Skip to content
Aspire
Docs Try Aspire
Docs Try

Install Aspire CLI

macOS

curl -sSL https://aspire.dev/install.sh | bash

Linux

curl -sSL https://aspire.dev/install.sh | bash

Windows

irm https://aspire.dev/install.ps1 | iex
More installation options

IDistributedApplicationBuilder

Interface
📦 Aspire.Hosting v13.2.0-preview.1.26159.1 
interface IDistributedApplicationBuilder {
  readonly appHostDirectory: string;
  readonly eventing: IDistributedApplicationEventing;
  readonly executionContext: DistributedApplicationExecutionContext;
  addConnectionString(
      name: string,
      environmentVariableName?: string): IResourceWithConnectionString;
  addConnectionStringBuilder(name: string, connectionStringBuilder: (obj: ReferenceExpressionBuilder) => void): ConnectionStringResource;
  addContainer(
      name: string,
      image: string): ContainerResource;
  addContainerRegistry(
      name: string,
      endpoint: ParameterResource,
      repository?: ParameterResource): 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;
  addParameter(
      name: string,
      secret?: boolean): ParameterResource;
  addParameterFromConfiguration(
      name: string,
      configurationKey: string,
      secret?: boolean): ParameterResource;
  addProject(
      name: string,
      projectPath: string,
      launchProfileName: string): ProjectResource;
  addProjectWithOptions(name: string, projectPath: string, configure: (obj: ProjectResourceOptions) => void): ProjectResource;
  build(): DistributedApplication;
}
18 members

Properties

property appHostDirectory string get
Gets the AppHostDirectory property
property eventing IDistributedApplicationEventing get
Gets the Eventing property
property executionContext DistributedApplicationExecutionContext get
Gets the ExecutionContext 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 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 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 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 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
Connect with us

Community

SHA — 037d613 © Microsoft