NatsBuilderExtensions.AddNats Method

Definition

Namespace:

Aspire.Hosting

Assembly:

Aspire.Hosting.Nats.dll

Package:

Aspire.Hosting.Nats v8.2.0

Source:

NatsBuilderExtensions.cs

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

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

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

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

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

Returns

IResourceBuilder<NatsServerResource>

The IResourceBuilder<T>.

Remarks

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