NatsBuilderExtensions.AddNats Method

Definition

Namespace:: Aspire.Hosting

Assembly:: Aspire.Hosting.Nats.dll

Package:: Aspire.Hosting.Nats v13.0.0

Package:: Aspire.Hosting.Nats v8.2.0

Package:: Aspire.Hosting.Nats v9.5.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

AddNats(IDistributedApplicationBuilder, String, Nullable<Int32>)	Adds a NATS server resource to the application model. A container is used for local development. This configures a default user name and password for the NATS server.
AddNats(IDistributedApplicationBuilder, String, Nullable<Int32>, IResourceBuilder<ParameterResource>, IResourceBuilder<ParameterResource>)	Adds a NATS server resource to the application model. A container is used for local development.

AddNats(IDistributedApplicationBuilder, String, Nullable<Int32>)

Source:: NatsBuilderExtensions.cs

Source:: NatsBuilderExtensions.cs

Source:: NatsBuilderExtensions.cs

Source:: NatsBuilderExtensions.cs

Source:: NatsBuilderExtensions.cs

Source:: NatsBuilderExtensions.cs

Source:: NatsBuilderExtensions.cs

Adds a NATS server resource to the application model. A container is used for local development. This configures a default user name and password for the NATS server.

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

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, port As Nullable(Of Integer)) As IResourceBuilder(Of 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 <inheritdoc cref="F:Aspire.Hosting.Nats.NatsContainerImageTags.Tag"></inheritdoc> tag of the <inheritdoc cref="F:Aspire.Hosting.Nats.NatsContainerImageTags.Image"></inheritdoc> container image.

Applies to

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

Source:: NatsBuilderExtensions.cs

Source:: NatsBuilderExtensions.cs

Source:: NatsBuilderExtensions.cs

Source:: NatsBuilderExtensions.cs

Source:: NatsBuilderExtensions.cs

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, Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource>? userName = default, Aspire.Hosting.ApplicationModel.IResourceBuilder<Aspire.Hosting.ApplicationModel.ParameterResource>? password = default);

static member AddNats : 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.NatsServerResource>

<Extension()>
Public Function AddNats (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 NatsServerResource)