1 interface inheriting from IDistributedApplicationBuilder
Aspire.Hosting.Testing (1)
1 implementation of IDistributedApplicationBuilder
Aspire.Hosting (1)
836 references to IDistributedApplicationBuilder
AppHost1 (1)
Aspire.Hosting (122)
ContainerResourceBuilderExtensions.cs (16)
21/// Provides extension methods for <see cref="IDistributedApplicationBuilder"/> to add container resources to the application.
90/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
94public static IResourceBuilder<ContainerResource> AddContainer(this IDistributedApplicationBuilder builder, [ResourceName] string name, string image)
108/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
113public static IResourceBuilder<ContainerResource> AddContainer(this IDistributedApplicationBuilder builder, [ResourceName] string name, string image, string tag)
764/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
777/// When generating the manifest for deployment tools, the <see cref="AddDockerfile(IDistributedApplicationBuilder, string, string, string?, string?)"/>
792public static IResourceBuilder<ContainerResource> AddDockerfile(this IDistributedApplicationBuilder builder, [ResourceName] string name, string contextPath, string? dockerfilePath = null, string? stage = null)
805/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
820public static IResourceBuilder<ContainerResource> AddDockerfileFactory(this IDistributedApplicationBuilder builder, [ResourceName] string name, string contextPath, Func<DockerfileFactoryContext, string> dockerfileFactory, string? stage = null)
834/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
849public static IResourceBuilder<ContainerResource> AddDockerfileFactory(this IDistributedApplicationBuilder builder, [ResourceName] string name, string contextPath, Func<DockerfileFactoryContext, Task<string>> dockerfileFactory, string? stage = null)
863/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
896public static IResourceBuilder<ContainerResource> AddDockerfileBuilder(this IDistributedApplicationBuilder builder, [ResourceName] string name, string contextPath, Func<DockerfileBuilderCallbackContext, Task> callback, string? stage = null)
910/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
942public static IResourceBuilder<ContainerResource> AddDockerfileBuilder(this IDistributedApplicationBuilder builder, [ResourceName] string name, string contextPath, Action<DockerfileBuilderCallbackContext> callback, string? stage = null)
IDistributedApplicationBuilder.cs (10)
26/// The <see cref="IDistributedApplicationBuilder"/> is the central interface for defining
31/// To create an instance of the <see cref="IDistributedApplicationBuilder"/> interface
33/// method. Once the builder is created extension methods which target the <see cref="IDistributedApplicationBuilder"/>
100/// An example of using the <see cref="DistributedApplicationExecutionContext.IsRunMode"/> property on the <see cref="IDistributedApplicationBuilder"/> via
185/// This example shows the implementation of the <see cref="ContainerResourceBuilderExtensions.AddContainer(IDistributedApplicationBuilder, string, string)"/>
187/// the pattern for defining new resources is to include a method that extends <see cref="IDistributedApplicationBuilder"/> and and then
227/// The following example shows the implementation of the <see cref="ParameterResourceBuilderExtensions.AddConnectionString(IDistributedApplicationBuilder, string, string?)"/>
231/// The <see cref="ParameterResourceBuilderExtensions.AddConnectionString(IDistributedApplicationBuilder, string, string?)" /> method creates a new
232/// <see cref="ParameterResource"/> in the application model. The return type of <see cref="ParameterResourceBuilderExtensions.AddConnectionString(IDistributedApplicationBuilder, string, string?)"/>
236/// To work around this issue the <see cref="ParameterResourceBuilderExtensions.AddConnectionString(IDistributedApplicationBuilder, string, string?)"/> method wraps the
ParameterResourceBuilderExtensions.cs (10)
26public static IResourceBuilder<ParameterResource> AddParameter(this IDistributedApplicationBuilder builder, [ResourceName] string name, bool secret = false)
51public static IResourceBuilder<ParameterResource> AddParameter(this IDistributedApplicationBuilder builder, [ResourceName] string name, string value, bool publishValueAsDefault = false, bool secret = false)
72public static IResourceBuilder<ParameterResource> AddParameter(this IDistributedApplicationBuilder builder, string name, Func<string> valueGetter, bool publishValueAsDefault = false, bool secret = false)
105public static IResourceBuilder<ParameterResource> AddParameterFromConfiguration(this IDistributedApplicationBuilder builder, string name, string configurationKey, bool secret = false)
135public static IResourceBuilder<ParameterResource> AddParameter(this IDistributedApplicationBuilder builder, [ResourceName] string name, ParameterDefault value, bool secret = false, bool persist = false)
220internal static IResourceBuilder<T> AddParameter<T>(this IDistributedApplicationBuilder builder, T resource)
243public static IResourceBuilder<IResourceWithConnectionString> AddConnectionString(this IDistributedApplicationBuilder builder, [ResourceName] string name, string? environmentVariableName = null)
306IDistributedApplicationBuilder builder, string name,
341IDistributedApplicationBuilder builder, string name, bool secret, GenerateParameterDefault parameterDefault)
369public static ParameterResource CreateParameter(IDistributedApplicationBuilder builder, string name, bool secret)
ProjectResourceBuilderExtensions.cs (28)
21/// Provides extension methods for <see cref="IDistributedApplicationBuilder"/> to add and configure project resources.
31/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
36/// This overload of the <see cref="AddProject{TProject}(IDistributedApplicationBuilder, string)"/> method takes
66public static IResourceBuilder<ProjectResource> AddProject<TProject>(this IDistributedApplicationBuilder builder, [ResourceName] string name) where TProject : IProjectMetadata, new()
77/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
83/// This overload of the <see cref="AddProject(IDistributedApplicationBuilder, string, string)"/> method adds a project to the application
87/// <inheritdoc cref="AddProject(IDistributedApplicationBuilder, string)" path="/remarks/para[@name='kestrel']" />
99public static IResourceBuilder<ProjectResource> AddProject(this IDistributedApplicationBuilder builder, [ResourceName] string name, string projectPath)
113/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
119/// This overload of the <see cref="AddProject{TProject}(IDistributedApplicationBuilder, string)"/> method takes
134/// <inheritdoc cref="AddProject(IDistributedApplicationBuilder, string)" path="/remarks/para[@name='kestrel']" />
146public static IResourceBuilder<ProjectResource> AddProject<TProject>(this IDistributedApplicationBuilder builder, [ResourceName] string name, string? launchProfileName) where TProject : IProjectMetadata, new()
161/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
168/// This overload of the <see cref="AddProject(IDistributedApplicationBuilder, string, string)"/> method adds a project to the application
172/// <inheritdoc cref="AddProject(IDistributedApplicationBuilder, string)" path="/remarks/para[@name='kestrel']" />
184public static IResourceBuilder<ProjectResource> AddProject(this IDistributedApplicationBuilder builder, [ResourceName] string name, string projectPath, string? launchProfileName)
201/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
207/// This overload of the <see cref="AddProject{TProject}(IDistributedApplicationBuilder, string)"/> method takes
233public static IResourceBuilder<ProjectResource> AddProject<TProject>(this IDistributedApplicationBuilder builder, [ResourceName] string name, Action<ProjectResourceOptions> configure) where TProject : IProjectMetadata, new()
251/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
258/// This overload of the <see cref="AddProject(IDistributedApplicationBuilder, string, string)"/> method adds a project to the application
273public static IResourceBuilder<ProjectResource> AddProject(this IDistributedApplicationBuilder builder, [ResourceName] string name, string projectPath, Action<ProjectResourceOptions> configure)
296/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
302/// This overload of the <see cref="AddCSharpApp(IDistributedApplicationBuilder, string, string)"/> method adds a C# project or file-based app to the application
318public static IResourceBuilder<ProjectResource> AddCSharpApp(this IDistributedApplicationBuilder builder, string name, string path)
330/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
337/// This overload of the <see cref="AddCSharpApp(IDistributedApplicationBuilder, string, string)"/> method adds a C# project or file-based app to the application
353public static IResourceBuilder<CSharpAppResource> AddCSharpApp(this IDistributedApplicationBuilder builder, [ResourceName] string name, string path, Action<ProjectResourceOptions> configure)
Aspire.Hosting.Azure (11)
Aspire.Hosting.Azure.AIFoundry (2)
Aspire.Hosting.Azure.AppConfiguration (2)
Aspire.Hosting.Azure.AppContainers (6)
Aspire.Hosting.Azure.ApplicationInsights (4)
Aspire.Hosting.Azure.AppService (4)
Aspire.Hosting.Azure.CognitiveServices (2)
Aspire.Hosting.Azure.ContainerRegistry (2)
Aspire.Hosting.Azure.CosmosDB (2)
Aspire.Hosting.Azure.EventHubs (1)
Aspire.Hosting.Azure.Functions (7)
Aspire.Hosting.Azure.KeyVault (2)
Aspire.Hosting.Azure.Kusto (2)
Aspire.Hosting.Azure.Kusto.Tests (1)
Aspire.Hosting.Azure.OperationalInsights (2)
Aspire.Hosting.Azure.PostgreSQL (4)
Aspire.Hosting.Azure.Redis (2)
Aspire.Hosting.Azure.Search (1)
Aspire.Hosting.Azure.ServiceBus (1)
Aspire.Hosting.Azure.SignalR (4)
Aspire.Hosting.Azure.Sql (5)
Aspire.Hosting.Azure.Storage (1)
Aspire.Hosting.Azure.Tests (34)
Aspire.Hosting.Azure.WebPubSub (2)
Aspire.Hosting.Containers.Tests (17)
Aspire.Hosting.DevTunnels (2)
Aspire.Hosting.Docker (6)
Aspire.Hosting.Docker.Tests (1)
Aspire.Hosting.Garnet (4)
Aspire.Hosting.Garnet.Tests (6)
Aspire.Hosting.GitHub.Models (4)
Aspire.Hosting.JavaScript (7)
JavaScriptHostingExtensions.cs (7)
23/// Provides extension methods for adding JavaScript applications to an <see cref="IDistributedApplicationBuilder"/>.
89/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/> to add the resource to.</param>
112public static IResourceBuilder<NodeAppResource> AddNodeApp(this IDistributedApplicationBuilder builder, [ResourceName] string name, string appDirectory, string scriptPath)
322public static IResourceBuilder<JavaScriptAppResource> AddJavaScriptApp(this IDistributedApplicationBuilder builder, [ResourceName] string name, string appDirectory, string runScriptName = "dev")
350this IDistributedApplicationBuilder builder,
480/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/> to add the resource to.</param>
497public static IResourceBuilder<ViteAppResource> AddViteApp(this IDistributedApplicationBuilder builder, [ResourceName] string name, string appDirectory, string runScriptName = "dev")
Aspire.Hosting.JavaScript.Tests (34)
Aspire.Hosting.Kafka (2)
Aspire.Hosting.Kafka.Tests (3)
Aspire.Hosting.Keycloak (3)
Aspire.Hosting.Keycloak.Tests (2)
Aspire.Hosting.Kubernetes (4)
Aspire.Hosting.Kubernetes.Tests (1)
Aspire.Hosting.Maui (4)
Aspire.Hosting.Maui.Tests (20)
Aspire.Hosting.Milvus (2)
Aspire.Hosting.Milvus.Tests (6)
Aspire.Hosting.MongoDB (6)
Aspire.Hosting.MongoDB.Tests (9)
Aspire.Hosting.MySql (3)
Aspire.Hosting.MySql.Tests (9)
Aspire.Hosting.Nats (4)
Aspire.Hosting.Nats.Tests (7)
Aspire.Hosting.OpenAI (2)
Aspire.Hosting.Oracle (3)
Aspire.Hosting.Oracle.Tests (7)
Aspire.Hosting.Orleans (4)
Aspire.Hosting.PostgreSQL (3)
Aspire.Hosting.PostgreSQL.Tests (15)
Aspire.Hosting.Python (18)
PythonAppResourceBuilderExtensions.cs (18)
23/// Provides extension methods for adding Python applications to an <see cref="IDistributedApplicationBuilder"/>.
33/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/> to add the resource to.</param>
67this IDistributedApplicationBuilder builder, [ResourceName] string name, string appDirectory, string scriptPath)
74/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/> to add the resource to.</param>
102this IDistributedApplicationBuilder builder, [ResourceName] string name, string appDirectory, string moduleName)
109/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/> to add the resource to.</param>
140this IDistributedApplicationBuilder builder, [ResourceName] string name, string appDirectory, string executableName)
146/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/> to add the resource to.</param>
157/// <item><description><see cref="AddPythonApp(IDistributedApplicationBuilder, string, string, string)"/> - To run a Python script file</description></item>
174this IDistributedApplicationBuilder builder, string name, string appDirectory, string scriptPath, params string[] scriptArgs)
186/// <param name="builder">The <see cref="IDistributedApplicationBuilder"/> to add the resource to.</param>
198/// <item><description><see cref="AddPythonApp(IDistributedApplicationBuilder, string, string, string)"/> - To run a Python script file</description></item>
216this IDistributedApplicationBuilder builder, string name, string appDirectory, string scriptPath,
262this IDistributedApplicationBuilder builder, [ResourceName] string name, string appDirectory, string app)
351IDistributedApplicationBuilder builder, string name, string appDirectory, EntrypointType entrypointType,
359IDistributedApplicationBuilder builder, string name, string appDirectory, EntrypointType entrypointType,
773private static string ResolveDefaultVirtualEnvironmentPath(IDistributedApplicationBuilder builder, string appDirectory, string virtualEnvironmentPath)
1465private static void SetupDependencies(IDistributedApplicationBuilder builder, PythonAppResource resource)
Aspire.Hosting.Python.Tests (2)
Aspire.Hosting.Qdrant (2)
Aspire.Hosting.Qdrant.Tests (8)
Aspire.Hosting.RabbitMQ (3)
Aspire.Hosting.RabbitMQ.Tests (3)
Aspire.Hosting.Redis (4)
Aspire.Hosting.Redis.Tests (23)
Aspire.Hosting.Seq (4)
Aspire.Hosting.Seq.Tests (9)
Aspire.Hosting.SqlServer (2)
Aspire.Hosting.SqlServer.Tests (6)
Aspire.Hosting.Testing (26)
Aspire.Hosting.Testing.Tests (2)
Aspire.Hosting.Tests (226)
Schema\SchemaTests.cs (23)
18public static TheoryData<string, Action<IDistributedApplicationBuilder>> ApplicationSamples
22var data = new TheoryData<string, Action<IDistributedApplicationBuilder>>
24{ "BasicParameter", (IDistributedApplicationBuilder builder) =>
30{ "BasicSecretParameter", (IDistributedApplicationBuilder builder) =>
36{ "FormatterParameter", (IDistributedApplicationBuilder builder) =>
44{ "ConnectionStringParameter", (IDistributedApplicationBuilder builder) =>
50{ "BasicContainer", (IDistributedApplicationBuilder builder) =>
56{ "ContainerWithBuild", (IDistributedApplicationBuilder builder) =>
68{ "ContainerWithBuildAndBuildArgs", (IDistributedApplicationBuilder builder) =>
86{ "ContainerWithBuildAndSecretBuildArgs", (IDistributedApplicationBuilder builder) =>
101{ "ContainerWithVolume", (IDistributedApplicationBuilder builder) =>
107{ "ContainerWithBindMount", (IDistributedApplicationBuilder builder) =>
113{ "BasicContainerWithConnectionString", (IDistributedApplicationBuilder builder) =>
119{ "BasicDockerfile", (IDistributedApplicationBuilder builder) =>
129{ "ContainerWithContainerRuntimeArgs", (IDistributedApplicationBuilder builder) =>
135{ "BasicProject", (IDistributedApplicationBuilder builder) =>
141{ "BasicExecutable", (IDistributedApplicationBuilder builder) =>
147{ "VanillaProjectBasedContainerApp", (IDistributedApplicationBuilder builder) =>
157{ "CustomizedProjectBasedContainerApp", (IDistributedApplicationBuilder builder) =>
172{ "VanillaContainerBasedContainerApp", (IDistributedApplicationBuilder builder) =>
182{ "CustomizedContainerBasedContainerApp", (IDistributedApplicationBuilder builder) =>
197{ "VanillaBicepResource", (IDistributedApplicationBuilder builder) =>
228public void ValidateApplicationSamples(string testCaseName, Action<IDistributedApplicationBuilder> configurator)
Aspire.Hosting.Valkey (4)
Aspire.Hosting.Valkey.Tests (6)
Aspire.Hosting.Yarp (2)
AspireJavaScript.AppHost (1)
AspireWithMaui.AppHost (1)
AspireWithNode.AppHost (1)
AzureAIFoundryEndToEnd.AppHost (1)
AzureAppConfiguration.AppHost (1)
AzureAppService.AppHost (1)
AzureContainerApps.AppHost (1)
AzureFunctionsEndToEnd.AppHost (1)
AzureKusto.AppHost (1)
AzureOpenAIEndToEnd.AppHost (1)
AzureSearch.AppHost (1)
AzureStorageEndToEnd.AppHost (1)
BicepSample.AppHost (1)
BrowserTelemetry.AppHost (1)
CdkSample.AppHost (1)
CosmosEndToEnd.AppHost (1)
CustomResources.AppHost (3)
DatabaseMigration.AppHost (1)
Deployers.AppHost (1)
DevTunnels.AppHost (1)
EventHubs.AppHost (1)
ExternalServices.AppHost (1)
GitHubModelsEndToEnd.AppHost (1)
HealthChecksSandbox.AppHost (1)
KafkaBasic.AppHost (1)
Keycloak.AppHost (1)
MilvusPlayground.AppHost (1)
Mongo.AppHost (1)
MySqlDb.AppHost (1)
Nats.AppHost (1)
OpenAIEndToEnd.AppHost (1)
OracleEndToEnd.AppHost (1)
Orleans.AppHost (1)
ParameterEndToEnd.AppHost (1)
Pipelines.AppHost (1)
PostgresEndToEnd.AppHost (1)
ProxylessEndToEnd.AppHost (1)
Publishers.AppHost (2)
Python.AppHost (1)
Qdrant.AppHost (1)
Redis.AppHost (1)
Seq.AppHost (1)
ServiceBus.AppHost (1)
SignalR.AppHost (1)
SqlServerEndToEnd.AppHost (1)
Stress.AppHost (3)
TestingAppHost1.AppHost (1)
TestProject.AppHost (2)
TestShop.AppHost (1)
WaitForSandbox.AppHost (1)
WebPubSub.AppHost (1)
WithDockerfile.AppHost (1)
Yarp.AppHost (1)