monitors

Creates, updates, deletes, gets or lists a monitors resource.

Overview

Name	monitors
Type	Resource
Id	azure_isv.elastic.monitors

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	ARM id of the monitor resource.
name	string	Name of the monitor resource.
elasticProperties	object	Elastic cloud properties.
generateApiKey	boolean	Flag to determine if User API Key has to be generated and shared.
hostingType	string	Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. Known values are: "Hosted" and "Serverless".
identity	object	Identity properties of the monitor resource.
kind	string	The kind of the Elastic resource - observability, security, search etc.
liftrResourceCategory	string	Known values are: "Unknown" and "MonitorLogs".
liftrResourcePreference	integer	The priority of the resource.
location	string	The location of the monitor resource. Required.
monitoringStatus	string	Flag specifying if the resource monitoring is enabled or disabled. Known values are: "Enabled" and "Disabled".
planDetails	object	Plan details of the monitor resource.
projectDetails	object	Project details of the monitor resource IF it belongs to Serverless offer kind.
provisioningState	string	Provisioning state of the monitor resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
saaSAzureSubscriptionStatus	string	Status of Azure Subscription where Marketplace SaaS is located.
sku	object	SKU of the monitor resource.
sourceCampaignId	string	A unique identifier associated with the campaign.
sourceCampaignName	string	Name of the marketing campaign.
subscriptionState	string	State of the Azure Subscription containing the monitor resource.
systemData	object	The system metadata relating to this resource.
tags	object	The tags of the monitor resource.
type	string	The type of the monitor resource.
userInfo	object	User information.
version	string	Version of elastic of the monitor resource.

list_by_resource_group

Name	Datatype	Description
id	string	ARM id of the monitor resource.
name	string	Name of the monitor resource.
elasticProperties	object	Elastic cloud properties.
generateApiKey	boolean	Flag to determine if User API Key has to be generated and shared.
hostingType	string	Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. Known values are: "Hosted" and "Serverless".
identity	object	Identity properties of the monitor resource.
kind	string	The kind of the Elastic resource - observability, security, search etc.
liftrResourceCategory	string	Known values are: "Unknown" and "MonitorLogs".
liftrResourcePreference	integer	The priority of the resource.
location	string	The location of the monitor resource. Required.
monitoringStatus	string	Flag specifying if the resource monitoring is enabled or disabled. Known values are: "Enabled" and "Disabled".
planDetails	object	Plan details of the monitor resource.
projectDetails	object	Project details of the monitor resource IF it belongs to Serverless offer kind.
provisioningState	string	Provisioning state of the monitor resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
saaSAzureSubscriptionStatus	string	Status of Azure Subscription where Marketplace SaaS is located.
sku	object	SKU of the monitor resource.
sourceCampaignId	string	A unique identifier associated with the campaign.
sourceCampaignName	string	Name of the marketing campaign.
subscriptionState	string	State of the Azure Subscription containing the monitor resource.
systemData	object	The system metadata relating to this resource.
tags	object	The tags of the monitor resource.
type	string	The type of the monitor resource.
userInfo	object	User information.
version	string	Version of elastic of the monitor resource.

list

Name	Datatype	Description
id	string	ARM id of the monitor resource.
name	string	Name of the monitor resource.
elasticProperties	object	Elastic cloud properties.
generateApiKey	boolean	Flag to determine if User API Key has to be generated and shared.
hostingType	string	Hosting type of the monitor resource - either Hosted deployments OR Serverless Projects. Known values are: "Hosted" and "Serverless".
identity	object	Identity properties of the monitor resource.
kind	string	The kind of the Elastic resource - observability, security, search etc.
liftrResourceCategory	string	Known values are: "Unknown" and "MonitorLogs".
liftrResourcePreference	integer	The priority of the resource.
location	string	The location of the monitor resource. Required.
monitoringStatus	string	Flag specifying if the resource monitoring is enabled or disabled. Known values are: "Enabled" and "Disabled".
planDetails	object	Plan details of the monitor resource.
projectDetails	object	Project details of the monitor resource IF it belongs to Serverless offer kind.
provisioningState	string	Provisioning state of the monitor resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
saaSAzureSubscriptionStatus	string	Status of Azure Subscription where Marketplace SaaS is located.
sku	object	SKU of the monitor resource.
sourceCampaignId	string	A unique identifier associated with the campaign.
sourceCampaignName	string	Name of the marketing campaign.
subscriptionState	string	State of the Azure Subscription containing the monitor resource.
systemData	object	The system metadata relating to this resource.
tags	object	The tags of the monitor resource.
type	string	The type of the monitor resource.
userInfo	object	User information.
version	string	Version of elastic of the monitor resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, monitor_name, subscription_id		Get detailed properties of a specific Elastic monitor resource, helping you manage observability and performance. Get detailed properties of a specific Elastic monitor resource, helping you manage observability and performance.
list_by_resource_group	select	resource_group_name, subscription_id		List all Elastic monitor resources within a specified resource group of the subscription, helping you audit and manage your monitoring setup. List all Elastic monitor resources within a specified resource group of the subscription, helping you audit and manage your monitoring setup.
list	select	subscription_id		List all Elastic monitor resources within a specified subscription, helping you audit and manage your monitoring setup. List all Elastic monitor resources within a specified subscription, helping you audit and manage your monitoring setup.
create	insert	resource_group_name, monitor_name, subscription_id, location		Create a new Elastic monitor resource in your Azure subscription, enabling observability and monitoring of your Azure resources through Elastic. Create a new Elastic monitor resource in your Azure subscription, enabling observability and monitoring of your Azure resources through Elastic.
update	update	resource_group_name, monitor_name, subscription_id		Update an existing Elastic monitor resource in your Azure subscription, ensuring optimal observability and performance. Update an existing Elastic monitor resource in your Azure subscription, ensuring optimal observability and performance.
delete	delete	resource_group_name, monitor_name, subscription_id		Delete an existing Elastic monitor resource from your Azure subscription, removing its observability and monitoring capabilities. Delete an existing Elastic monitor resource from your Azure subscription, removing its observability and monitoring capabilities.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
monitor_name	string	Monitor resource name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get detailed properties of a specific Elastic monitor resource, helping you manage observability and performance. Get detailed properties of a specific Elastic monitor resource, helping you manage observability and performance.

SELECT
id,
name,
elasticProperties,
generateApiKey,
hostingType,
identity,
kind,
liftrResourceCategory,
liftrResourcePreference,
location,
monitoringStatus,
planDetails,
projectDetails,
provisioningState,
saaSAzureSubscriptionStatus,
sku,
sourceCampaignId,
sourceCampaignName,
subscriptionState,
systemData,
tags,
type,
userInfo,
version
FROM azure_isv.elastic.monitors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND monitor_name = '{{ monitor_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List all Elastic monitor resources within a specified resource group of the subscription, helping you audit and manage your monitoring setup. List all Elastic monitor resources within a specified resource group of the subscription, helping you audit and manage your monitoring setup.

SELECT
id,
name,
elasticProperties,
generateApiKey,
hostingType,
identity,
kind,
liftrResourceCategory,
liftrResourcePreference,
location,
monitoringStatus,
planDetails,
projectDetails,
provisioningState,
saaSAzureSubscriptionStatus,
sku,
sourceCampaignId,
sourceCampaignName,
subscriptionState,
systemData,
tags,
type,
userInfo,
version
FROM azure_isv.elastic.monitors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all Elastic monitor resources within a specified subscription, helping you audit and manage your monitoring setup. List all Elastic monitor resources within a specified subscription, helping you audit and manage your monitoring setup.

SELECT
id,
name,
elasticProperties,
generateApiKey,
hostingType,
identity,
kind,
liftrResourceCategory,
liftrResourcePreference,
location,
monitoringStatus,
planDetails,
projectDetails,
provisioningState,
saaSAzureSubscriptionStatus,
sku,
sourceCampaignId,
sourceCampaignName,
subscriptionState,
systemData,
tags,
type,
userInfo,
version
FROM azure_isv.elastic.monitors
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a new Elastic monitor resource in your Azure subscription, enabling observability and monitoring of your Azure resources through Elastic. Create a new Elastic monitor resource in your Azure subscription, enabling observability and monitoring of your Azure resources through Elastic.

INSERT INTO azure_isv.elastic.monitors (
kind,
sku,
properties,
identity,
tags,
location,
resource_group_name,
monitor_name,
subscription_id
)
SELECT 
'{{ kind }}',
'{{ sku }}',
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}' /* required */,
'{{ resource_group_name }}',
'{{ monitor_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: monitors
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the monitors resource.
  - name: monitor_name
    value: "{{ monitor_name }}"
    description: Required parameter for the monitors resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the monitors resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      The kind of the Elastic resource - observability, security, search etc.
  - name: sku
    description: |
      SKU of the monitor resource.
    value:
      name: "{{ name }}"
  - name: properties
    description: |
      Properties of the monitor resource.
    value:
      provisioningState: "{{ provisioningState }}"
      monitoringStatus: "{{ monitoringStatus }}"
      elasticProperties:
        elasticCloudUser:
          emailAddress: "{{ emailAddress }}"
          id: "{{ id }}"
          elasticCloudSsoDefaultUrl: "{{ elasticCloudSsoDefaultUrl }}"
        elasticCloudDeployment:
          name: "{{ name }}"
          deploymentId: "{{ deploymentId }}"
          azureSubscriptionId: "{{ azureSubscriptionId }}"
          elasticsearchRegion: "{{ elasticsearchRegion }}"
          elasticsearchServiceUrl: "{{ elasticsearchServiceUrl }}"
          kibanaServiceUrl: "{{ kibanaServiceUrl }}"
          kibanaSsoUrl: "{{ kibanaSsoUrl }}"
      userInfo:
        firstName: "{{ firstName }}"
        lastName: "{{ lastName }}"
        companyName: "{{ companyName }}"
        emailAddress: "{{ emailAddress }}"
        companyInfo:
          domain: "{{ domain }}"
          business: "{{ business }}"
          employeesNumber: "{{ employeesNumber }}"
          state: "{{ state }}"
          country: "{{ country }}"
      planDetails:
        offerID: "{{ offerID }}"
        publisherID: "{{ publisherID }}"
        termID: "{{ termID }}"
        planID: "{{ planID }}"
        planName: "{{ planName }}"
      version: "{{ version }}"
      subscriptionState: "{{ subscriptionState }}"
      saaSAzureSubscriptionStatus: "{{ saaSAzureSubscriptionStatus }}"
      sourceCampaignName: "{{ sourceCampaignName }}"
      sourceCampaignId: "{{ sourceCampaignId }}"
      liftrResourceCategory: "{{ liftrResourceCategory }}"
      liftrResourcePreference: {{ liftrResourcePreference }}
      generateApiKey: {{ generateApiKey }}
      hostingType: "{{ hostingType }}"
      projectDetails:
        projectType: "{{ projectType }}"
        configurationType: "{{ configurationType }}"
  - name: identity
    description: |
      Identity properties of the monitor resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      The tags of the monitor resource.
  - name: location
    value: "{{ location }}"
    description: |
      The location of the monitor resource. Required.

UPDATE examples

update

Update an existing Elastic monitor resource in your Azure subscription, ensuring optimal observability and performance. Update an existing Elastic monitor resource in your Azure subscription, ensuring optimal observability and performance.

UPDATE azure_isv.elastic.monitors
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND monitor_name = '{{ monitor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
kind,
location,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Delete an existing Elastic monitor resource from your Azure subscription, removing its observability and monitoring capabilities. Delete an existing Elastic monitor resource from your Azure subscription, removing its observability and monitoring capabilities.

DELETE FROM azure_isv.elastic.monitors
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND monitor_name = '{{ monitor_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;