MongoDBBuilderExtensions.AddMongoDB Method

  • Reference

Definition

Namespace:
Aspire.Hosting
Assembly:
Aspire.Hosting.MongoDB.dll
Package:
Aspire.Hosting.MongoDB v8.0.0-preview.7.24251.11
Source:
MongoDBBuilderExtensions.cs

Adds a MongoDB resource to the application model. A container is used for local development. This version the package defaults to the 7.0.8 tag of the mongo container image.

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

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>.

Applies to