monitors

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

Overview

Name	monitors
Type	Resource
Id	azure_isv.elastic.monitors

Fields

vw_monitors

Name	Datatype	Description
id	text	ARM id of the monitor resource.
name	text	Name of the monitor resource.
elastic_properties	text	field from the properties object
generate_api_key	text	field from the properties object
identity	text	Identity properties.
liftr_resource_category	text	field from the properties object
liftr_resource_preference	text	field from the properties object
location	text	The location of the monitor resource
monitorName	text	field from the properties object
monitoring_status	text	field from the properties object
plan_details	text	field from the properties object
provisioning_state	text	field from the properties object
resourceGroupName	text	field from the properties object
saa_s_azure_subscription_status	text	field from the properties object
sku	text	Microsoft.Elastic SKU.
source_campaign_id	text	field from the properties object
source_campaign_name	text	field from the properties object
subscriptionId	text	field from the properties object
subscription_state	text	field from the properties object
system_data	text	field from the properties object
tags	text	The tags of the monitor resource.
type	text	The type of the monitor resource.
user_info	text	field from the properties object
version	text	field from the properties object

monitors

Name	Datatype	Description
id	string	ARM id of the monitor resource.
name	string	Name of the monitor resource.
identity	object	Identity properties.
location	string	The location of the monitor resource
properties	object	Properties specific to the monitor resource.
sku	object	Microsoft.Elastic SKU.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	The tags of the monitor resource.
type	string	The type of the monitor resource.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	monitorName, resourceGroupName, subscriptionId
list	SELECT	subscriptionId
list_by_resource_group	SELECT	resourceGroupName, subscriptionId
create	INSERT	monitorName, resourceGroupName, subscriptionId, data__location
delete	DELETE	monitorName, resourceGroupName, subscriptionId
update	UPDATE	monitorName, resourceGroupName, subscriptionId
upgrade	EXEC	monitorName, resourceGroupName, subscriptionId

SELECT examples

vw_monitors

SELECT
id,
name,
elastic_properties,
generate_api_key,
identity,
liftr_resource_category,
liftr_resource_preference,
location,
monitorName,
monitoring_status,
plan_details,
provisioning_state,
resourceGroupName,
saa_s_azure_subscription_status,
sku,
source_campaign_id,
source_campaign_name,
subscriptionId,
subscription_state,
system_data,
tags,
type,
user_info,
version
FROM azure_isv.elastic.vw_monitors
WHERE subscriptionId = '{{ subscriptionId }}';

monitors

SELECT
id,
name,
identity,
location,
properties,
sku,
systemData,
tags,
type
FROM azure_isv.elastic.monitors
WHERE subscriptionId = '{{ subscriptionId }}';

INSERT example

Use the following StackQL query and manifest file to create a new monitors resource.

All Properties

/*+ create */
INSERT INTO azure_isv.elastic.monitors (
monitorName,
resourceGroupName,
subscriptionId,
data__location,
sku,
properties,
identity,
tags,
location
)
SELECT 
'{{ monitorName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__location }}',
'{{ sku }}',
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: sku
      value:
        - name: name
          value: string
    - name: properties
      value:
        - name: provisioningState
          value: []
        - name: monitoringStatus
          value: []
        - name: elasticProperties
          value:
            - name: elasticCloudUser
              value:
                - name: emailAddress
                  value: string
                - name: id
                  value: string
                - name: elasticCloudSsoDefaultUrl
                  value: string
            - name: elasticCloudDeployment
              value:
                - name: name
                  value: string
                - name: deploymentId
                  value: string
                - name: azureSubscriptionId
                  value: string
                - name: elasticsearchRegion
                  value: string
                - name: elasticsearchServiceUrl
                  value: string
                - name: kibanaServiceUrl
                  value: string
                - name: kibanaSsoUrl
                  value: string
        - name: userInfo
          value:
            - name: firstName
              value: string
            - name: lastName
              value: string
            - name: companyName
              value: string
            - name: emailAddress
              value: string
            - name: companyInfo
              value:
                - name: domain
                  value: string
                - name: business
                  value: string
                - name: employeesNumber
                  value: string
                - name: state
                  value: string
                - name: country
                  value: string
        - name: planDetails
          value:
            - name: offerID
              value: string
            - name: publisherID
              value: string
            - name: termID
              value: string
            - name: planID
              value: string
            - name: planName
              value: string
        - name: version
          value: string
        - name: subscriptionState
          value: string
        - name: saaSAzureSubscriptionStatus
          value: string
        - name: sourceCampaignName
          value: string
        - name: sourceCampaignId
          value: string
        - name: liftrResourceCategory
          value: []
        - name: liftrResourcePreference
          value: integer
        - name: generateApiKey
          value: boolean
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: []
    - name: tags
      value: object
    - name: location
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string

UPDATE example

Updates a monitors resource.

/*+ update */
UPDATE azure_isv.elastic.monitors
SET 
tags = '{{ tags }}'
WHERE 
monitorName = '{{ monitorName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified monitors resource.

/*+ delete */
DELETE FROM azure_isv.elastic.monitors
WHERE monitorName = '{{ monitorName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';