MongoDBBuilderExtensions.AddMongoDB Method

Reference

Definition

Namespace:: Aspire.Hosting

Assembly:: Aspire.Hosting.MongoDB.dll

Package:: Aspire.Hosting.MongoDB v8.2.0

Package:: Aspire.Hosting.MongoDB v9.0.0

Package:: Aspire.Hosting.MongoDB v9.1.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Overloads

AddMongoDB(IDistributedApplicationBuilder, String, Nullable<Int32>)	Adds a MongoDB resource to the application model. A container is used for local development.
AddMongoDB(IDistributedApplicationBuilder, String, Nullable<Int32>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)	Adds a MongoDB resource to the application model. A container is used for local development.

AddMongoDB(IDistributedApplicationBuilder, String, Nullable<Int32>)

Source:: MongoDBBuilderExtensions.cs

Source:: MongoDBBuilderExtensions.cs

Source:: MongoDBBuilderExtensions.cs

Adds a MongoDB resource to the application model. A container is used for local development.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.MongoDBServerResource> AddMongoDB(this Aspire.Hosting.IDistributedApplicationBuilder builder, string name, int? port = default);

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.MongoDBServerResource> AddMongoDB(this Aspire.Hosting.IDistributedApplicationBuilder builder, string name, int? port);

static member AddMongoDB : Aspire.Hosting.IDistributedApplicationBuilder * string * Nullable<int> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.MongoDBServerResource>

<Extension()>
Public Function AddMongoDB (builder As IDistributedApplicationBuilder, name As String, Optional port As Nullable(Of Integer) = Nothing) As IResourceBuilder(Of MongoDBServerResource)

<Extension()>
Public Function AddMongoDB (builder As IDistributedApplicationBuilder, name As String, port As Nullable(Of Integer)) As IResourceBuilder(Of MongoDBServerResource)

Parameters

builder: IDistributedApplicationBuilder

The IDistributedApplicationBuilder.

name: String

The name of the resource. This name will be used as the connection string name when referenced in a dependency.

port: Nullable<Int32>

The host port for MongoDB.

Returns

IResourceBuilder<MongoDBServerResource>

A reference to the IResourceBuilder<T>.

Remarks

This version of the package defaults to the tag of the container image.

Applies to

.NET Aspire 9.1.0 and other versions

Product	Versions
.NET Aspire	8.0.0, 9.0.0, 9.1.0

AddMongoDB(IDistributedApplicationBuilder, String, Nullable<Int32>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)

Source:: MongoDBBuilderExtensions.cs

Source:: MongoDBBuilderExtensions.cs

Adds a MongoDB resource to the application model. A container is used for local development.

public static Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.MongoDBServerResource> AddMongoDB(this Aspire.Hosting.IDistributedApplicationBuilder builder, string name, int? port = default, Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource>? userName = default, Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource>? password = default);

static member AddMongoDB : Aspire.Hosting.IDistributedApplicationBuilder * string * Nullable<int> * Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource> * Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource> -> Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.MongoDBServerResource>

<Extension()>
Public Function AddMongoDB (builder As IDistributedApplicationBuilder, name As String, Optional port As Nullable(Of Integer) = Nothing, Optional userName As IResourceBuilder(Of ParameterResource) = Nothing, Optional password As IResourceBuilder(Of ParameterResource) = Nothing) As IResourceBuilder(Of MongoDBServerResource)