Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Classic
  3. API Docs
  4. elasticcloud
  5. Elasticsearch

We recommend using Azure Native.

Azure v6.23.0 published on Thursday, May 22, 2025 by Pulumi
pulumi/pulumi-azure

azure.elasticcloud.Elasticsearch

Explore with Pulumi AI

We recommend using Azure Native.

Azure v6.23.0 published on Thursday, May 22, 2025 by Pulumi
pulumi/pulumi-azure

Manages an Elasticsearch in Elastic Cloud.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const test = new azure.core.ResourceGroup("test", {
    name: "example-resources",
    location: "West Europe",
});
const testElasticsearch = new azure.elasticcloud.Elasticsearch("test", {
    name: "example-elasticsearch",
    resourceGroupName: test.name,
    location: test.location,
    skuName: "ess-consumption-2024_Monthly",
    elasticCloudEmailAddress: "user@example.com",
});
Copy
import pulumi
import pulumi_azure as azure

test = azure.core.ResourceGroup("test",
    name="example-resources",
    location="West Europe")
test_elasticsearch = azure.elasticcloud.Elasticsearch("test",
    name="example-elasticsearch",
    resource_group_name=test.name,
    location=test.location,
    sku_name="ess-consumption-2024_Monthly",
    elastic_cloud_email_address="user@example.com")
Copy
package main

import (
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/core"
	"github.com/pulumi/pulumi-azure/sdk/v6/go/azure/elasticcloud"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		test, err := core.NewResourceGroup(ctx, "test", &core.ResourceGroupArgs{
			Name:     pulumi.String("example-resources"),
			Location: pulumi.String("West Europe"),
		})
		if err != nil {
			return err
		}
		_, err = elasticcloud.NewElasticsearch(ctx, "test", &elasticcloud.ElasticsearchArgs{
			Name:                     pulumi.String("example-elasticsearch"),
			ResourceGroupName:        test.Name,
			Location:                 test.Location,
			SkuName:                  pulumi.String("ess-consumption-2024_Monthly"),
			ElasticCloudEmailAddress: pulumi.String("user@example.com"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Azure = Pulumi.Azure;

return await Deployment.RunAsync(() => 
{
    var test = new Azure.Core.ResourceGroup("test", new()
    {
        Name = "example-resources",
        Location = "West Europe",
    });

    var testElasticsearch = new Azure.ElasticCloud.Elasticsearch("test", new()
    {
        Name = "example-elasticsearch",
        ResourceGroupName = test.Name,
        Location = test.Location,
        SkuName = "ess-consumption-2024_Monthly",
        ElasticCloudEmailAddress = "user@example.com",
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azure.core.ResourceGroup;
import com.pulumi.azure.core.ResourceGroupArgs;
import com.pulumi.azure.elasticcloud.Elasticsearch;
import com.pulumi.azure.elasticcloud.ElasticsearchArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var test = new ResourceGroup("test", ResourceGroupArgs.builder()
            .name("example-resources")
            .location("West Europe")
            .build());

        var testElasticsearch = new Elasticsearch("testElasticsearch", ElasticsearchArgs.builder()
            .name("example-elasticsearch")
            .resourceGroupName(test.name())
            .location(test.location())
            .skuName("ess-consumption-2024_Monthly")
            .elasticCloudEmailAddress("user@example.com")
            .build());

    }
}
Copy
resources:
  test:
    type: azure:core:ResourceGroup
    properties:
      name: example-resources
      location: West Europe
  testElasticsearch:
    type: azure:elasticcloud:Elasticsearch
    name: test
    properties:
      name: example-elasticsearch
      resourceGroupName: ${test.name}
      location: ${test.location}
      skuName: ess-consumption-2024_Monthly
      elasticCloudEmailAddress: user@example.com
Copy

API Providers

This resource uses the following Azure API Providers:

  • Microsoft.Elastic: 2023-06-01

Create Elasticsearch Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new Elasticsearch(name: string, args: ElasticsearchArgs, opts?: CustomResourceOptions);
@overload
def Elasticsearch(resource_name: str,
                  args: ElasticsearchArgs,
                  opts: Optional[ResourceOptions] = None)

@overload
def Elasticsearch(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  elastic_cloud_email_address: Optional[str] = None,
                  resource_group_name: Optional[str] = None,
                  sku_name: Optional[str] = None,
                  location: Optional[str] = None,
                  logs: Optional[ElasticsearchLogsArgs] = None,
                  monitoring_enabled: Optional[bool] = None,
                  name: Optional[str] = None,
                  tags: Optional[Mapping[str, str]] = None)
func NewElasticsearch(ctx *Context, name string, args ElasticsearchArgs, opts ...ResourceOption) (*Elasticsearch, error)
public Elasticsearch(string name, ElasticsearchArgs args, CustomResourceOptions? opts = null)
public Elasticsearch(String name, ElasticsearchArgs args)
public Elasticsearch(String name, ElasticsearchArgs args, CustomResourceOptions options)

type: azure:elasticcloud:Elasticsearch
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. ElasticsearchArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. ElasticsearchArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. ElasticsearchArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. ElasticsearchArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. ElasticsearchArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var elasticsearchResource = new Azure.ElasticCloud.Elasticsearch("elasticsearchResource", new()
{
    ElasticCloudEmailAddress = "string",
    ResourceGroupName = "string",
    SkuName = "string",
    Location = "string",
    Logs = new Azure.ElasticCloud.Inputs.ElasticsearchLogsArgs
    {
        FilteringTags = new[]
        {
            new Azure.ElasticCloud.Inputs.ElasticsearchLogsFilteringTagArgs
            {
                Action = "string",
                Name = "string",
                Value = "string",
            },
        },
        SendActivityLogs = false,
        SendAzureadLogs = false,
        SendSubscriptionLogs = false,
    },
    MonitoringEnabled = false,
    Name = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := elasticcloud.NewElasticsearch(ctx, "elasticsearchResource", &elasticcloud.ElasticsearchArgs{
	ElasticCloudEmailAddress: pulumi.String("string"),
	ResourceGroupName:        pulumi.String("string"),
	SkuName:                  pulumi.String("string"),
	Location:                 pulumi.String("string"),
	Logs: &elasticcloud.ElasticsearchLogsArgs{
		FilteringTags: elasticcloud.ElasticsearchLogsFilteringTagArray{
			&elasticcloud.ElasticsearchLogsFilteringTagArgs{
				Action: pulumi.String("string"),
				Name:   pulumi.String("string"),
				Value:  pulumi.String("string"),
			},
		},
		SendActivityLogs:     pulumi.Bool(false),
		SendAzureadLogs:      pulumi.Bool(false),
		SendSubscriptionLogs: pulumi.Bool(false),
	},
	MonitoringEnabled: pulumi.Bool(false),
	Name:              pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var elasticsearchResource = new Elasticsearch("elasticsearchResource", ElasticsearchArgs.builder()
    .elasticCloudEmailAddress("string")
    .resourceGroupName("string")
    .skuName("string")
    .location("string")
    .logs(ElasticsearchLogsArgs.builder()
        .filteringTags(ElasticsearchLogsFilteringTagArgs.builder()
            .action("string")
            .name("string")
            .value("string")
            .build())
        .sendActivityLogs(false)
        .sendAzureadLogs(false)
        .sendSubscriptionLogs(false)
        .build())
    .monitoringEnabled(false)
    .name("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
elasticsearch_resource = azure.elasticcloud.Elasticsearch("elasticsearchResource",
    elastic_cloud_email_address="string",
    resource_group_name="string",
    sku_name="string",
    location="string",
    logs={
        "filtering_tags": [{
            "action": "string",
            "name": "string",
            "value": "string",
        }],
        "send_activity_logs": False,
        "send_azuread_logs": False,
        "send_subscription_logs": False,
    },
    monitoring_enabled=False,
    name="string",
    tags={
        "string": "string",
    })
Copy
const elasticsearchResource = new azure.elasticcloud.Elasticsearch("elasticsearchResource", {
    elasticCloudEmailAddress: "string",
    resourceGroupName: "string",
    skuName: "string",
    location: "string",
    logs: {
        filteringTags: [{
            action: "string",
            name: "string",
            value: "string",
        }],
        sendActivityLogs: false,
        sendAzureadLogs: false,
        sendSubscriptionLogs: false,
    },
    monitoringEnabled: false,
    name: "string",
    tags: {
        string: "string",
    },
});
Copy
type: azure:elasticcloud:Elasticsearch
properties:
    elasticCloudEmailAddress: string
    location: string
    logs:
        filteringTags:
            - action: string
              name: string
              value: string
        sendActivityLogs: false
        sendAzureadLogs: false
        sendSubscriptionLogs: false
    monitoringEnabled: false
    name: string
    resourceGroupName: string
    skuName: string
    tags:
        string: string
Copy

Elasticsearch Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The Elasticsearch resource accepts the following input properties:

ElasticCloudEmailAddress
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Email Address which should be associated with this Elasticsearch account. Changing this forces a new Elasticsearch to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
SkuName
This property is required.
Changes to this property will trigger replacement.
string

Specifies the name of the SKU for this Elasticsearch. Changing this forces a new Elasticsearch to be created.

Note: The SKU depends on the Elasticsearch Plans available for your account and is a combination of PlanID_Term. Ex: If the plan ID is "planXYZ" and term is "Yearly", the SKU will be "planXYZ_Yearly". You may find your eligible plans here or in the online documentation here for more details or in case of any issues with the SKU.

Location Changes to this property will trigger replacement. string
The Azure Region where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
Logs ElasticsearchLogs
A logs block as defined below.
MonitoringEnabled Changes to this property will trigger replacement. bool
Specifies if the Elasticsearch should have monitoring configured? Defaults to true. Changing this forces a new Elasticsearch to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Elasticsearch resource. Changing this forces a new Elasticsearch to be created.
Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Elasticsearch resource.
ElasticCloudEmailAddress
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Email Address which should be associated with this Elasticsearch account. Changing this forces a new Elasticsearch to be created.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
SkuName
This property is required.
Changes to this property will trigger replacement.
string

Specifies the name of the SKU for this Elasticsearch. Changing this forces a new Elasticsearch to be created.

Note: The SKU depends on the Elasticsearch Plans available for your account and is a combination of PlanID_Term. Ex: If the plan ID is "planXYZ" and term is "Yearly", the SKU will be "planXYZ_Yearly". You may find your eligible plans here or in the online documentation here for more details or in case of any issues with the SKU.

Location Changes to this property will trigger replacement. string
The Azure Region where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
Logs ElasticsearchLogsArgs
A logs block as defined below.
MonitoringEnabled Changes to this property will trigger replacement. bool
Specifies if the Elasticsearch should have monitoring configured? Defaults to true. Changing this forces a new Elasticsearch to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Elasticsearch resource. Changing this forces a new Elasticsearch to be created.
Tags map[string]string
A mapping of tags which should be assigned to the Elasticsearch resource.
elasticCloudEmailAddress
This property is required.
Changes to this property will trigger replacement.
String
Specifies the Email Address which should be associated with this Elasticsearch account. Changing this forces a new Elasticsearch to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
skuName
This property is required.
Changes to this property will trigger replacement.
String

Specifies the name of the SKU for this Elasticsearch. Changing this forces a new Elasticsearch to be created.

Note: The SKU depends on the Elasticsearch Plans available for your account and is a combination of PlanID_Term. Ex: If the plan ID is "planXYZ" and term is "Yearly", the SKU will be "planXYZ_Yearly". You may find your eligible plans here or in the online documentation here for more details or in case of any issues with the SKU.

location Changes to this property will trigger replacement. String
The Azure Region where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
logs ElasticsearchLogs
A logs block as defined below.
monitoringEnabled Changes to this property will trigger replacement. Boolean
Specifies if the Elasticsearch should have monitoring configured? Defaults to true. Changing this forces a new Elasticsearch to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Elasticsearch resource. Changing this forces a new Elasticsearch to be created.
tags Map<String,String>
A mapping of tags which should be assigned to the Elasticsearch resource.
elasticCloudEmailAddress
This property is required.
Changes to this property will trigger replacement.
string
Specifies the Email Address which should be associated with this Elasticsearch account. Changing this forces a new Elasticsearch to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Resource Group where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
skuName
This property is required.
Changes to this property will trigger replacement.
string

Specifies the name of the SKU for this Elasticsearch. Changing this forces a new Elasticsearch to be created.

Note: The SKU depends on the Elasticsearch Plans available for your account and is a combination of PlanID_Term. Ex: If the plan ID is "planXYZ" and term is "Yearly", the SKU will be "planXYZ_Yearly". You may find your eligible plans here or in the online documentation here for more details or in case of any issues with the SKU.

location Changes to this property will trigger replacement. string
The Azure Region where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
logs ElasticsearchLogs
A logs block as defined below.
monitoringEnabled Changes to this property will trigger replacement. boolean
Specifies if the Elasticsearch should have monitoring configured? Defaults to true. Changing this forces a new Elasticsearch to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Elasticsearch resource. Changing this forces a new Elasticsearch to be created.
tags {[key: string]: string}
A mapping of tags which should be assigned to the Elasticsearch resource.
elastic_cloud_email_address
This property is required.
Changes to this property will trigger replacement.
str
Specifies the Email Address which should be associated with this Elasticsearch account. Changing this forces a new Elasticsearch to be created.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Resource Group where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
sku_name
This property is required.
Changes to this property will trigger replacement.
str

Specifies the name of the SKU for this Elasticsearch. Changing this forces a new Elasticsearch to be created.

Note: The SKU depends on the Elasticsearch Plans available for your account and is a combination of PlanID_Term. Ex: If the plan ID is "planXYZ" and term is "Yearly", the SKU will be "planXYZ_Yearly". You may find your eligible plans here or in the online documentation here for more details or in case of any issues with the SKU.

location Changes to this property will trigger replacement. str
The Azure Region where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
logs ElasticsearchLogsArgs
A logs block as defined below.
monitoring_enabled Changes to this property will trigger replacement. bool
Specifies if the Elasticsearch should have monitoring configured? Defaults to true. Changing this forces a new Elasticsearch to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Elasticsearch resource. Changing this forces a new Elasticsearch to be created.
tags Mapping[str, str]
A mapping of tags which should be assigned to the Elasticsearch resource.
elasticCloudEmailAddress
This property is required.
Changes to this property will trigger replacement.
String
Specifies the Email Address which should be associated with this Elasticsearch account. Changing this forces a new Elasticsearch to be created.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Resource Group where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
skuName
This property is required.
Changes to this property will trigger replacement.
String

Specifies the name of the SKU for this Elasticsearch. Changing this forces a new Elasticsearch to be created.

Note: The SKU depends on the Elasticsearch Plans available for your account and is a combination of PlanID_Term. Ex: If the plan ID is "planXYZ" and term is "Yearly", the SKU will be "planXYZ_Yearly". You may find your eligible plans here or in the online documentation here for more details or in case of any issues with the SKU.

location Changes to this property will trigger replacement. String
The Azure Region where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
logs Property Map
A logs block as defined below.
monitoringEnabled Changes to this property will trigger replacement. Boolean
Specifies if the Elasticsearch should have monitoring configured? Defaults to true. Changing this forces a new Elasticsearch to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Elasticsearch resource. Changing this forces a new Elasticsearch to be created.
tags Map<String>
A mapping of tags which should be assigned to the Elasticsearch resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the Elasticsearch resource produces the following output properties:

ElasticCloudDeploymentId string
The ID of the Deployment within Elastic Cloud.
ElasticCloudSsoDefaultUrl string
The Default URL used for Single Sign On (SSO) to Elastic Cloud.
ElasticCloudUserId string
The ID of the User Account within Elastic Cloud.
ElasticsearchServiceUrl string
The URL to the Elasticsearch Service associated with this Elasticsearch.
Id string
The provider-assigned unique ID for this managed resource.
KibanaServiceUrl string
The URL to the Kibana Dashboard associated with this Elasticsearch.
KibanaSsoUri string
The URI used for SSO to the Kibana Dashboard associated with this Elasticsearch.
ElasticCloudDeploymentId string
The ID of the Deployment within Elastic Cloud.
ElasticCloudSsoDefaultUrl string
The Default URL used for Single Sign On (SSO) to Elastic Cloud.
ElasticCloudUserId string
The ID of the User Account within Elastic Cloud.
ElasticsearchServiceUrl string
The URL to the Elasticsearch Service associated with this Elasticsearch.
Id string
The provider-assigned unique ID for this managed resource.
KibanaServiceUrl string
The URL to the Kibana Dashboard associated with this Elasticsearch.
KibanaSsoUri string
The URI used for SSO to the Kibana Dashboard associated with this Elasticsearch.
elasticCloudDeploymentId String
The ID of the Deployment within Elastic Cloud.
elasticCloudSsoDefaultUrl String
The Default URL used for Single Sign On (SSO) to Elastic Cloud.
elasticCloudUserId String
The ID of the User Account within Elastic Cloud.
elasticsearchServiceUrl String
The URL to the Elasticsearch Service associated with this Elasticsearch.
id String
The provider-assigned unique ID for this managed resource.
kibanaServiceUrl String
The URL to the Kibana Dashboard associated with this Elasticsearch.
kibanaSsoUri String
The URI used for SSO to the Kibana Dashboard associated with this Elasticsearch.
elasticCloudDeploymentId string
The ID of the Deployment within Elastic Cloud.
elasticCloudSsoDefaultUrl string
The Default URL used for Single Sign On (SSO) to Elastic Cloud.
elasticCloudUserId string
The ID of the User Account within Elastic Cloud.
elasticsearchServiceUrl string
The URL to the Elasticsearch Service associated with this Elasticsearch.
id string
The provider-assigned unique ID for this managed resource.
kibanaServiceUrl string
The URL to the Kibana Dashboard associated with this Elasticsearch.
kibanaSsoUri string
The URI used for SSO to the Kibana Dashboard associated with this Elasticsearch.
elastic_cloud_deployment_id str
The ID of the Deployment within Elastic Cloud.
elastic_cloud_sso_default_url str
The Default URL used for Single Sign On (SSO) to Elastic Cloud.
elastic_cloud_user_id str
The ID of the User Account within Elastic Cloud.
elasticsearch_service_url str
The URL to the Elasticsearch Service associated with this Elasticsearch.
id str
The provider-assigned unique ID for this managed resource.
kibana_service_url str
The URL to the Kibana Dashboard associated with this Elasticsearch.
kibana_sso_uri str
The URI used for SSO to the Kibana Dashboard associated with this Elasticsearch.
elasticCloudDeploymentId String
The ID of the Deployment within Elastic Cloud.
elasticCloudSsoDefaultUrl String
The Default URL used for Single Sign On (SSO) to Elastic Cloud.
elasticCloudUserId String
The ID of the User Account within Elastic Cloud.
elasticsearchServiceUrl String
The URL to the Elasticsearch Service associated with this Elasticsearch.
id String
The provider-assigned unique ID for this managed resource.
kibanaServiceUrl String
The URL to the Kibana Dashboard associated with this Elasticsearch.
kibanaSsoUri String
The URI used for SSO to the Kibana Dashboard associated with this Elasticsearch.

Look up Existing Elasticsearch Resource

Get an existing Elasticsearch resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ElasticsearchState, opts?: CustomResourceOptions): Elasticsearch
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        elastic_cloud_deployment_id: Optional[str] = None,
        elastic_cloud_email_address: Optional[str] = None,
        elastic_cloud_sso_default_url: Optional[str] = None,
        elastic_cloud_user_id: Optional[str] = None,
        elasticsearch_service_url: Optional[str] = None,
        kibana_service_url: Optional[str] = None,
        kibana_sso_uri: Optional[str] = None,
        location: Optional[str] = None,
        logs: Optional[ElasticsearchLogsArgs] = None,
        monitoring_enabled: Optional[bool] = None,
        name: Optional[str] = None,
        resource_group_name: Optional[str] = None,
        sku_name: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None) -> Elasticsearch
func GetElasticsearch(ctx *Context, name string, id IDInput, state *ElasticsearchState, opts ...ResourceOption) (*Elasticsearch, error)
public static Elasticsearch Get(string name, Input<string> id, ElasticsearchState? state, CustomResourceOptions? opts = null)
public static Elasticsearch get(String name, Output<String> id, ElasticsearchState state, CustomResourceOptions options)
resources:  _:    type: azure:elasticcloud:Elasticsearch    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ElasticCloudDeploymentId string
The ID of the Deployment within Elastic Cloud.
ElasticCloudEmailAddress Changes to this property will trigger replacement. string
Specifies the Email Address which should be associated with this Elasticsearch account. Changing this forces a new Elasticsearch to be created.
ElasticCloudSsoDefaultUrl string
The Default URL used for Single Sign On (SSO) to Elastic Cloud.
ElasticCloudUserId string
The ID of the User Account within Elastic Cloud.
ElasticsearchServiceUrl string
The URL to the Elasticsearch Service associated with this Elasticsearch.
KibanaServiceUrl string
The URL to the Kibana Dashboard associated with this Elasticsearch.
KibanaSsoUri string
The URI used for SSO to the Kibana Dashboard associated with this Elasticsearch.
Location Changes to this property will trigger replacement. string
The Azure Region where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
Logs ElasticsearchLogs
A logs block as defined below.
MonitoringEnabled Changes to this property will trigger replacement. bool
Specifies if the Elasticsearch should have monitoring configured? Defaults to true. Changing this forces a new Elasticsearch to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Elasticsearch resource. Changing this forces a new Elasticsearch to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
SkuName Changes to this property will trigger replacement. string

Specifies the name of the SKU for this Elasticsearch. Changing this forces a new Elasticsearch to be created.

Note: The SKU depends on the Elasticsearch Plans available for your account and is a combination of PlanID_Term. Ex: If the plan ID is "planXYZ" and term is "Yearly", the SKU will be "planXYZ_Yearly". You may find your eligible plans here or in the online documentation here for more details or in case of any issues with the SKU.

Tags Dictionary<string, string>
A mapping of tags which should be assigned to the Elasticsearch resource.
ElasticCloudDeploymentId string
The ID of the Deployment within Elastic Cloud.
ElasticCloudEmailAddress Changes to this property will trigger replacement. string
Specifies the Email Address which should be associated with this Elasticsearch account. Changing this forces a new Elasticsearch to be created.
ElasticCloudSsoDefaultUrl string
The Default URL used for Single Sign On (SSO) to Elastic Cloud.
ElasticCloudUserId string
The ID of the User Account within Elastic Cloud.
ElasticsearchServiceUrl string
The URL to the Elasticsearch Service associated with this Elasticsearch.
KibanaServiceUrl string
The URL to the Kibana Dashboard associated with this Elasticsearch.
KibanaSsoUri string
The URI used for SSO to the Kibana Dashboard associated with this Elasticsearch.
Location Changes to this property will trigger replacement. string
The Azure Region where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
Logs ElasticsearchLogsArgs
A logs block as defined below.
MonitoringEnabled Changes to this property will trigger replacement. bool
Specifies if the Elasticsearch should have monitoring configured? Defaults to true. Changing this forces a new Elasticsearch to be created.
Name Changes to this property will trigger replacement. string
The name which should be used for this Elasticsearch resource. Changing this forces a new Elasticsearch to be created.
ResourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
SkuName Changes to this property will trigger replacement. string

Specifies the name of the SKU for this Elasticsearch. Changing this forces a new Elasticsearch to be created.

Note: The SKU depends on the Elasticsearch Plans available for your account and is a combination of PlanID_Term. Ex: If the plan ID is "planXYZ" and term is "Yearly", the SKU will be "planXYZ_Yearly". You may find your eligible plans here or in the online documentation here for more details or in case of any issues with the SKU.

Tags map[string]string
A mapping of tags which should be assigned to the Elasticsearch resource.
elasticCloudDeploymentId String
The ID of the Deployment within Elastic Cloud.
elasticCloudEmailAddress Changes to this property will trigger replacement. String
Specifies the Email Address which should be associated with this Elasticsearch account. Changing this forces a new Elasticsearch to be created.
elasticCloudSsoDefaultUrl String
The Default URL used for Single Sign On (SSO) to Elastic Cloud.
elasticCloudUserId String
The ID of the User Account within Elastic Cloud.
elasticsearchServiceUrl String
The URL to the Elasticsearch Service associated with this Elasticsearch.
kibanaServiceUrl String
The URL to the Kibana Dashboard associated with this Elasticsearch.
kibanaSsoUri String
The URI used for SSO to the Kibana Dashboard associated with this Elasticsearch.
location Changes to this property will trigger replacement. String
The Azure Region where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
logs ElasticsearchLogs
A logs block as defined below.
monitoringEnabled Changes to this property will trigger replacement. Boolean
Specifies if the Elasticsearch should have monitoring configured? Defaults to true. Changing this forces a new Elasticsearch to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Elasticsearch resource. Changing this forces a new Elasticsearch to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
skuName Changes to this property will trigger replacement. String

Specifies the name of the SKU for this Elasticsearch. Changing this forces a new Elasticsearch to be created.

Note: The SKU depends on the Elasticsearch Plans available for your account and is a combination of PlanID_Term. Ex: If the plan ID is "planXYZ" and term is "Yearly", the SKU will be "planXYZ_Yearly". You may find your eligible plans here or in the online documentation here for more details or in case of any issues with the SKU.

tags Map<String,String>
A mapping of tags which should be assigned to the Elasticsearch resource.
elasticCloudDeploymentId string
The ID of the Deployment within Elastic Cloud.
elasticCloudEmailAddress Changes to this property will trigger replacement. string
Specifies the Email Address which should be associated with this Elasticsearch account. Changing this forces a new Elasticsearch to be created.
elasticCloudSsoDefaultUrl string
The Default URL used for Single Sign On (SSO) to Elastic Cloud.
elasticCloudUserId string
The ID of the User Account within Elastic Cloud.
elasticsearchServiceUrl string
The URL to the Elasticsearch Service associated with this Elasticsearch.
kibanaServiceUrl string
The URL to the Kibana Dashboard associated with this Elasticsearch.
kibanaSsoUri string
The URI used for SSO to the Kibana Dashboard associated with this Elasticsearch.
location Changes to this property will trigger replacement. string
The Azure Region where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
logs ElasticsearchLogs
A logs block as defined below.
monitoringEnabled Changes to this property will trigger replacement. boolean
Specifies if the Elasticsearch should have monitoring configured? Defaults to true. Changing this forces a new Elasticsearch to be created.
name Changes to this property will trigger replacement. string
The name which should be used for this Elasticsearch resource. Changing this forces a new Elasticsearch to be created.
resourceGroupName Changes to this property will trigger replacement. string
The name of the Resource Group where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
skuName Changes to this property will trigger replacement. string

Specifies the name of the SKU for this Elasticsearch. Changing this forces a new Elasticsearch to be created.

Note: The SKU depends on the Elasticsearch Plans available for your account and is a combination of PlanID_Term. Ex: If the plan ID is "planXYZ" and term is "Yearly", the SKU will be "planXYZ_Yearly". You may find your eligible plans here or in the online documentation here for more details or in case of any issues with the SKU.

tags {[key: string]: string}
A mapping of tags which should be assigned to the Elasticsearch resource.
elastic_cloud_deployment_id str
The ID of the Deployment within Elastic Cloud.
elastic_cloud_email_address Changes to this property will trigger replacement. str
Specifies the Email Address which should be associated with this Elasticsearch account. Changing this forces a new Elasticsearch to be created.
elastic_cloud_sso_default_url str
The Default URL used for Single Sign On (SSO) to Elastic Cloud.
elastic_cloud_user_id str
The ID of the User Account within Elastic Cloud.
elasticsearch_service_url str
The URL to the Elasticsearch Service associated with this Elasticsearch.
kibana_service_url str
The URL to the Kibana Dashboard associated with this Elasticsearch.
kibana_sso_uri str
The URI used for SSO to the Kibana Dashboard associated with this Elasticsearch.
location Changes to this property will trigger replacement. str
The Azure Region where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
logs ElasticsearchLogsArgs
A logs block as defined below.
monitoring_enabled Changes to this property will trigger replacement. bool
Specifies if the Elasticsearch should have monitoring configured? Defaults to true. Changing this forces a new Elasticsearch to be created.
name Changes to this property will trigger replacement. str
The name which should be used for this Elasticsearch resource. Changing this forces a new Elasticsearch to be created.
resource_group_name Changes to this property will trigger replacement. str
The name of the Resource Group where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
sku_name Changes to this property will trigger replacement. str

Specifies the name of the SKU for this Elasticsearch. Changing this forces a new Elasticsearch to be created.

Note: The SKU depends on the Elasticsearch Plans available for your account and is a combination of PlanID_Term. Ex: If the plan ID is "planXYZ" and term is "Yearly", the SKU will be "planXYZ_Yearly". You may find your eligible plans here or in the online documentation here for more details or in case of any issues with the SKU.

tags Mapping[str, str]
A mapping of tags which should be assigned to the Elasticsearch resource.
elasticCloudDeploymentId String
The ID of the Deployment within Elastic Cloud.
elasticCloudEmailAddress Changes to this property will trigger replacement. String
Specifies the Email Address which should be associated with this Elasticsearch account. Changing this forces a new Elasticsearch to be created.
elasticCloudSsoDefaultUrl String
The Default URL used for Single Sign On (SSO) to Elastic Cloud.
elasticCloudUserId String
The ID of the User Account within Elastic Cloud.
elasticsearchServiceUrl String
The URL to the Elasticsearch Service associated with this Elasticsearch.
kibanaServiceUrl String
The URL to the Kibana Dashboard associated with this Elasticsearch.
kibanaSsoUri String
The URI used for SSO to the Kibana Dashboard associated with this Elasticsearch.
location Changes to this property will trigger replacement. String
The Azure Region where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
logs Property Map
A logs block as defined below.
monitoringEnabled Changes to this property will trigger replacement. Boolean
Specifies if the Elasticsearch should have monitoring configured? Defaults to true. Changing this forces a new Elasticsearch to be created.
name Changes to this property will trigger replacement. String
The name which should be used for this Elasticsearch resource. Changing this forces a new Elasticsearch to be created.
resourceGroupName Changes to this property will trigger replacement. String
The name of the Resource Group where the Elasticsearch resource should exist. Changing this forces a new Elasticsearch to be created.
skuName Changes to this property will trigger replacement. String

Specifies the name of the SKU for this Elasticsearch. Changing this forces a new Elasticsearch to be created.

Note: The SKU depends on the Elasticsearch Plans available for your account and is a combination of PlanID_Term. Ex: If the plan ID is "planXYZ" and term is "Yearly", the SKU will be "planXYZ_Yearly". You may find your eligible plans here or in the online documentation here for more details or in case of any issues with the SKU.

tags Map<String>
A mapping of tags which should be assigned to the Elasticsearch resource.

Supporting Types

ElasticsearchLogs
, ElasticsearchLogsArgs

FilteringTags List<ElasticsearchLogsFilteringTag>
A list of filtering_tag blocks as defined above.
SendActivityLogs bool
Specifies if the Azure Activity Logs should be sent to the Elasticsearch cluster. Defaults to false.
SendAzureadLogs bool
Specifies if the AzureAD Logs should be sent to the Elasticsearch cluster. Defaults to false.
SendSubscriptionLogs bool
Specifies if the Azure Subscription Logs should be sent to the Elasticsearch cluster. Defaults to false.
FilteringTags []ElasticsearchLogsFilteringTag
A list of filtering_tag blocks as defined above.
SendActivityLogs bool
Specifies if the Azure Activity Logs should be sent to the Elasticsearch cluster. Defaults to false.
SendAzureadLogs bool
Specifies if the AzureAD Logs should be sent to the Elasticsearch cluster. Defaults to false.
SendSubscriptionLogs bool
Specifies if the Azure Subscription Logs should be sent to the Elasticsearch cluster. Defaults to false.
filteringTags List<ElasticsearchLogsFilteringTag>
A list of filtering_tag blocks as defined above.
sendActivityLogs Boolean
Specifies if the Azure Activity Logs should be sent to the Elasticsearch cluster. Defaults to false.
sendAzureadLogs Boolean
Specifies if the AzureAD Logs should be sent to the Elasticsearch cluster. Defaults to false.
sendSubscriptionLogs Boolean
Specifies if the Azure Subscription Logs should be sent to the Elasticsearch cluster. Defaults to false.
filteringTags ElasticsearchLogsFilteringTag[]
A list of filtering_tag blocks as defined above.
sendActivityLogs boolean
Specifies if the Azure Activity Logs should be sent to the Elasticsearch cluster. Defaults to false.
sendAzureadLogs boolean
Specifies if the AzureAD Logs should be sent to the Elasticsearch cluster. Defaults to false.
sendSubscriptionLogs boolean
Specifies if the Azure Subscription Logs should be sent to the Elasticsearch cluster. Defaults to false.
filtering_tags Sequence[ElasticsearchLogsFilteringTag]
A list of filtering_tag blocks as defined above.
send_activity_logs bool
Specifies if the Azure Activity Logs should be sent to the Elasticsearch cluster. Defaults to false.
send_azuread_logs bool
Specifies if the AzureAD Logs should be sent to the Elasticsearch cluster. Defaults to false.
send_subscription_logs bool
Specifies if the Azure Subscription Logs should be sent to the Elasticsearch cluster. Defaults to false.
filteringTags List<Property Map>
A list of filtering_tag blocks as defined above.
sendActivityLogs Boolean
Specifies if the Azure Activity Logs should be sent to the Elasticsearch cluster. Defaults to false.
sendAzureadLogs Boolean
Specifies if the AzureAD Logs should be sent to the Elasticsearch cluster. Defaults to false.
sendSubscriptionLogs Boolean
Specifies if the Azure Subscription Logs should be sent to the Elasticsearch cluster. Defaults to false.

ElasticsearchLogsFilteringTag
, ElasticsearchLogsFilteringTagArgs

Action This property is required. string
Specifies the type of action which should be taken when the Tag matches the name and value. Possible values are Exclude and Include.
Name This property is required. string
Specifies the name (key) of the Tag which should be filtered.
Value This property is required. string
Specifies the value of the Tag which should be filtered.
Action This property is required. string
Specifies the type of action which should be taken when the Tag matches the name and value. Possible values are Exclude and Include.
Name This property is required. string
Specifies the name (key) of the Tag which should be filtered.
Value This property is required. string
Specifies the value of the Tag which should be filtered.
action This property is required. String
Specifies the type of action which should be taken when the Tag matches the name and value. Possible values are Exclude and Include.
name This property is required. String
Specifies the name (key) of the Tag which should be filtered.
value This property is required. String
Specifies the value of the Tag which should be filtered.
action This property is required. string
Specifies the type of action which should be taken when the Tag matches the name and value. Possible values are Exclude and Include.
name This property is required. string
Specifies the name (key) of the Tag which should be filtered.
value This property is required. string
Specifies the value of the Tag which should be filtered.
action This property is required. str
Specifies the type of action which should be taken when the Tag matches the name and value. Possible values are Exclude and Include.
name This property is required. str
Specifies the name (key) of the Tag which should be filtered.
value This property is required. str
Specifies the value of the Tag which should be filtered.
action This property is required. String
Specifies the type of action which should be taken when the Tag matches the name and value. Possible values are Exclude and Include.
name This property is required. String
Specifies the name (key) of the Tag which should be filtered.
value This property is required. String
Specifies the value of the Tag which should be filtered.

Import

Elasticsearch’s can be imported using the resource id, e.g.

$ pulumi import azure:elasticcloud/elasticsearch:Elasticsearch example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.Elastic/monitors/monitor1
Copy

To learn more about importing existing cloud resources, see Importing resources.

Package Details

Repository
Azure Classic pulumi/pulumi-azure
License
Apache-2.0
Notes
This Pulumi package is based on the azurerm Terraform Provider.

We recommend using Azure Native.

Azure v6.23.0 published on Thursday, May 22, 2025 by Pulumi
pulumi/pulumi-azure