Share via


Microsoft.Elastic monitors

Bicep resource definition

The monitors resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Elastic/monitors resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.Elastic/monitors@2025-06-01' = {
  identity: {
    type: 'string'
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  properties: {
    elasticProperties: {
      elasticCloudDeployment: {}
      elasticCloudUser: {}
    }
    generateApiKey: bool
    hostingType: 'string'
    monitoringStatus: 'string'
    planDetails: {
      offerID: 'string'
      planID: 'string'
      planName: 'string'
      publisherID: 'string'
      termID: 'string'
    }
    projectDetails: {
      configurationType: 'string'
      projectType: 'string'
    }
    saaSAzureSubscriptionStatus: 'string'
    sourceCampaignId: 'string'
    sourceCampaignName: 'string'
    subscriptionState: 'string'
    userInfo: {
      companyInfo: {
        business: 'string'
        country: 'string'
        domain: 'string'
        employeesNumber: 'string'
        state: 'string'
      }
      companyName: 'string'
      emailAddress: 'string'
      firstName: 'string'
      lastName: 'string'
    }
    version: 'string'
  }
  sku: {
    name: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Microsoft.Elastic/monitors

Name Description Value
identity Identity properties of the monitor resource. IdentityProperties
kind The kind of the Elastic resource - observability, security, search etc. string
location The location of the monitor resource string (required)
name The resource name string

Constraints:
Pattern = ^.*$ (required)
properties Properties of the monitor resource. MonitorProperties
sku SKU of the monitor resource. ResourceSku
tags Resource tags Dictionary of tag names and values. See Tags in templates

CompanyInfo

Name Description Value
business Business of the company string

Constraints:
Max length = 128
country Country of the company location. string

Constraints:
Max length = 128
domain Domain of the company string

Constraints:
Max length = 256
employeesNumber Number of employees in the company string

Constraints:
Max length = 20
state State of the company location. string

Constraints:
Max length = 128

ElasticCloudDeployment

Name Description Value

ElasticCloudUser

Name Description Value

ElasticMonitorResourceTags

Name Description Value

ElasticProperties

Name Description Value
elasticCloudDeployment Details of the elastic cloud deployment. ElasticCloudDeployment
elasticCloudUser Details of the user's elastic account. ElasticCloudUser

IdentityProperties

Name Description Value
type Managed identity type. 'SystemAssigned'

MonitorProperties

Name Description Value
elasticProperties Elastic cloud properties. ElasticProperties
generateApiKey Flag to determine if User API Key has to be generated and shared. bool
hostingType Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. 'Hosted'
'Serverless'
monitoringStatus Flag specifying if the resource monitoring is enabled or disabled. 'Disabled'
'Enabled'
planDetails Plan details of the monitor resource. PlanDetails
projectDetails Project details of the monitor resource IF it belongs to Serverless offer kind. ProjectDetails
saaSAzureSubscriptionStatus Status of Azure Subscription where Marketplace SaaS is located. string
sourceCampaignId A unique identifier associated with the campaign. string
sourceCampaignName Name of the marketing campaign. string
subscriptionState State of the Azure Subscription containing the monitor resource string
userInfo User information. UserInfo
version Version of elastic of the monitor resource string

PlanDetails

Name Description Value
offerID Offer ID of the plan string
planID Plan ID string
planName Plan Name string
publisherID Publisher ID of the plan string
termID Term ID of the plan string

ProjectDetails

Name Description Value
configurationType Configuration type of the Elasticsearch project 'GeneralPurpose'
'NotApplicable'
'TimeSeries'
'Vector'
projectType Project type; ex: Elasticsearch / Observability / Security 'Elasticsearch'
'NotApplicable'
'Observability'
'Security'

ResourceSku

Name Description Value
name Name of the SKU. string (required)

UserInfo

Name Description Value
companyInfo Company information of the user to be passed to partners. CompanyInfo
companyName Company name of the user string

Constraints:
Max length = 128
emailAddress Email of the user used by Elastic for contacting them if needed string

Constraints:
Pattern = ^([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@"]+)*)@(([a-zA-Z-_0-9]+\.)+[a-zA-Z]{2,})$
firstName First name of the user string

Constraints:
Max length = 128
lastName Last name of the user string

Constraints:
Max length = 128

Usage Examples

Azure Quickstart Samples

The following Azure Quickstart templates contain Bicep samples for deploying this resource type.

Bicep File Description
Creates an Elastic Cloud (Elasticsearch) resource This QuickStart template creates a new ‘Elastic Cloud (Elasticsearch) – An Azure Native ISV Service’ resource in your Azure subscription, which you can use to create and manage your Elastic deployments, right from Azure.

ARM template resource definition

The monitors resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Elastic/monitors resource, add the following JSON to your template.

{
  "type": "Microsoft.Elastic/monitors",
  "apiVersion": "2025-06-01",
  "name": "string",
  "identity": {
    "type": "string"
  },
  "kind": "string",
  "location": "string",
  "properties": {
    "elasticProperties": {
      "elasticCloudDeployment": {
      },
      "elasticCloudUser": {
      }
    },
    "generateApiKey": "bool",
    "hostingType": "string",
    "monitoringStatus": "string",
    "planDetails": {
      "offerID": "string",
      "planID": "string",
      "planName": "string",
      "publisherID": "string",
      "termID": "string"
    },
    "projectDetails": {
      "configurationType": "string",
      "projectType": "string"
    },
    "saaSAzureSubscriptionStatus": "string",
    "sourceCampaignId": "string",
    "sourceCampaignName": "string",
    "subscriptionState": "string",
    "userInfo": {
      "companyInfo": {
        "business": "string",
        "country": "string",
        "domain": "string",
        "employeesNumber": "string",
        "state": "string"
      },
      "companyName": "string",
      "emailAddress": "string",
      "firstName": "string",
      "lastName": "string"
    },
    "version": "string"
  },
  "sku": {
    "name": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Microsoft.Elastic/monitors

Name Description Value
apiVersion The api version '2025-06-01'
identity Identity properties of the monitor resource. IdentityProperties
kind The kind of the Elastic resource - observability, security, search etc. string
location The location of the monitor resource string (required)
name The resource name string

Constraints:
Pattern = ^.*$ (required)
properties Properties of the monitor resource. MonitorProperties
sku SKU of the monitor resource. ResourceSku
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Elastic/monitors'

CompanyInfo

Name Description Value
business Business of the company string

Constraints:
Max length = 128
country Country of the company location. string

Constraints:
Max length = 128
domain Domain of the company string

Constraints:
Max length = 256
employeesNumber Number of employees in the company string

Constraints:
Max length = 20
state State of the company location. string

Constraints:
Max length = 128

ElasticCloudDeployment

Name Description Value

ElasticCloudUser

Name Description Value

ElasticMonitorResourceTags

Name Description Value

ElasticProperties

Name Description Value
elasticCloudDeployment Details of the elastic cloud deployment. ElasticCloudDeployment
elasticCloudUser Details of the user's elastic account. ElasticCloudUser

IdentityProperties

Name Description Value
type Managed identity type. 'SystemAssigned'

MonitorProperties

Name Description Value
elasticProperties Elastic cloud properties. ElasticProperties
generateApiKey Flag to determine if User API Key has to be generated and shared. bool
hostingType Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. 'Hosted'
'Serverless'
monitoringStatus Flag specifying if the resource monitoring is enabled or disabled. 'Disabled'
'Enabled'
planDetails Plan details of the monitor resource. PlanDetails
projectDetails Project details of the monitor resource IF it belongs to Serverless offer kind. ProjectDetails
saaSAzureSubscriptionStatus Status of Azure Subscription where Marketplace SaaS is located. string
sourceCampaignId A unique identifier associated with the campaign. string
sourceCampaignName Name of the marketing campaign. string
subscriptionState State of the Azure Subscription containing the monitor resource string
userInfo User information. UserInfo
version Version of elastic of the monitor resource string

PlanDetails

Name Description Value
offerID Offer ID of the plan string
planID Plan ID string
planName Plan Name string
publisherID Publisher ID of the plan string
termID Term ID of the plan string

ProjectDetails

Name Description Value
configurationType Configuration type of the Elasticsearch project 'GeneralPurpose'
'NotApplicable'
'TimeSeries'
'Vector'
projectType Project type; ex: Elasticsearch / Observability / Security 'Elasticsearch'
'NotApplicable'
'Observability'
'Security'

ResourceSku

Name Description Value
name Name of the SKU. string (required)

UserInfo

Name Description Value
companyInfo Company information of the user to be passed to partners. CompanyInfo
companyName Company name of the user string

Constraints:
Max length = 128
emailAddress Email of the user used by Elastic for contacting them if needed string

Constraints:
Pattern = ^([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@"]+)*)@(([a-zA-Z-_0-9]+\.)+[a-zA-Z]{2,})$
firstName First name of the user string

Constraints:
Max length = 128
lastName Last name of the user string

Constraints:
Max length = 128

Usage Examples

Azure Quickstart Templates

The following Azure Quickstart templates deploy this resource type.

Template Description
Creates an Elastic Cloud (Elasticsearch) resource

Deploy to Azure
This QuickStart template creates a new ‘Elastic Cloud (Elasticsearch) – An Azure Native ISV Service’ resource in your Azure subscription, which you can use to create and manage your Elastic deployments, right from Azure.

Terraform (AzAPI provider) resource definition

The monitors resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Elastic/monitors resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Elastic/monitors@2025-06-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "string"
    properties = {
      elasticProperties = {
        elasticCloudDeployment = {
        }
        elasticCloudUser = {
        }
      }
      generateApiKey = bool
      hostingType = "string"
      monitoringStatus = "string"
      planDetails = {
        offerID = "string"
        planID = "string"
        planName = "string"
        publisherID = "string"
        termID = "string"
      }
      projectDetails = {
        configurationType = "string"
        projectType = "string"
      }
      saaSAzureSubscriptionStatus = "string"
      sourceCampaignId = "string"
      sourceCampaignName = "string"
      subscriptionState = "string"
      userInfo = {
        companyInfo = {
          business = "string"
          country = "string"
          domain = "string"
          employeesNumber = "string"
          state = "string"
        }
        companyName = "string"
        emailAddress = "string"
        firstName = "string"
        lastName = "string"
      }
      version = "string"
    }
    sku = {
      name = "string"
    }
  }
}

Property Values

Microsoft.Elastic/monitors

Name Description Value
identity Identity properties of the monitor resource. IdentityProperties
kind The kind of the Elastic resource - observability, security, search etc. string
location The location of the monitor resource string (required)
name The resource name string

Constraints:
Pattern = ^.*$ (required)
properties Properties of the monitor resource. MonitorProperties
sku SKU of the monitor resource. ResourceSku
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Elastic/monitors@2025-06-01"

CompanyInfo

Name Description Value
business Business of the company string

Constraints:
Max length = 128
country Country of the company location. string

Constraints:
Max length = 128
domain Domain of the company string

Constraints:
Max length = 256
employeesNumber Number of employees in the company string

Constraints:
Max length = 20
state State of the company location. string

Constraints:
Max length = 128

ElasticCloudDeployment

Name Description Value

ElasticCloudUser

Name Description Value

ElasticMonitorResourceTags

Name Description Value

ElasticProperties

Name Description Value
elasticCloudDeployment Details of the elastic cloud deployment. ElasticCloudDeployment
elasticCloudUser Details of the user's elastic account. ElasticCloudUser

IdentityProperties

Name Description Value
type Managed identity type. 'SystemAssigned'

MonitorProperties

Name Description Value
elasticProperties Elastic cloud properties. ElasticProperties
generateApiKey Flag to determine if User API Key has to be generated and shared. bool
hostingType Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. 'Hosted'
'Serverless'
monitoringStatus Flag specifying if the resource monitoring is enabled or disabled. 'Disabled'
'Enabled'
planDetails Plan details of the monitor resource. PlanDetails
projectDetails Project details of the monitor resource IF it belongs to Serverless offer kind. ProjectDetails
saaSAzureSubscriptionStatus Status of Azure Subscription where Marketplace SaaS is located. string
sourceCampaignId A unique identifier associated with the campaign. string
sourceCampaignName Name of the marketing campaign. string
subscriptionState State of the Azure Subscription containing the monitor resource string
userInfo User information. UserInfo
version Version of elastic of the monitor resource string

PlanDetails

Name Description Value
offerID Offer ID of the plan string
planID Plan ID string
planName Plan Name string
publisherID Publisher ID of the plan string
termID Term ID of the plan string

ProjectDetails

Name Description Value
configurationType Configuration type of the Elasticsearch project 'GeneralPurpose'
'NotApplicable'
'TimeSeries'
'Vector'
projectType Project type; ex: Elasticsearch / Observability / Security 'Elasticsearch'
'NotApplicable'
'Observability'
'Security'

ResourceSku

Name Description Value
name Name of the SKU. string (required)

UserInfo

Name Description Value
companyInfo Company information of the user to be passed to partners. CompanyInfo
companyName Company name of the user string

Constraints:
Max length = 128
emailAddress Email of the user used by Elastic for contacting them if needed string

Constraints:
Pattern = ^([^<>()\[\]\.,;:\s@"]+(\.[^<>()\[\]\.,;:\s@"]+)*)@(([a-zA-Z-_0-9]+\.)+[a-zA-Z]{2,})$
firstName First name of the user string

Constraints:
Max length = 128
lastName Last name of the user string

Constraints:
Max length = 128