ElasticsearchBuilderExtensions.AddElasticsearch Method

Reference

Definition

Namespace:: Aspire.Hosting

Assembly:: Aspire.Hosting.Elasticsearch.dll

Package:: Aspire.Hosting.Elasticsearch v8.2.2-preview.1.24521.5

Package:: Aspire.Hosting.Elasticsearch v9.0.0-preview.5.24551.3

Source:: ElasticsearchBuilderExtensions.cs

Source:: ElasticsearchBuilderExtensions.cs

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.

Adds an Elasticsearch container resource to the application model.

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

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

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

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.

password: IResourceBuilder<ParameterResource>

The parameter used to provide the superuser password for the elasticsearch. If null a random password will be generated.

port: Nullable<Int32>

The host port to bind the underlying container to.

Returns

IResourceBuilder<ElasticsearchResource>

A reference to the IResourceBuilder<T>.

Examples

Add an Elasticsearch container to the application model and reference it in a .NET project.

var builder = DistributedApplication.CreateBuilder(args);

var elasticsearch = builder.AddElasticsearch("elasticsearch");
var api = builder.AddProject<Projects.Api>("api")
  .WithReference(elasticsearch);

builder.Build().Run();

Remarks

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

Applies to

Share via