monitors

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

Overview

Name	monitors
Type	Resource
Id	azure_isv.datadog.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.
datadogOrganizationProperties	object	Specify the Datadog organization name. In the case of linking to existing organizations, Id, ApiKey, and Applicationkey is required as well.
identity	object	:vartype identity: ~azure.mgmt.datadog.models.IdentityProperties
liftrResourceCategory	string	Known values are: "Unknown" and "MonitorLogs".
liftrResourcePreference	integer	The priority of the resource.
location	string	Required.
marketplaceSubscriptionStatus	string	Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. Known values are: "Provisioning", "Active", "Suspended", and "Unsubscribed".
monitoringStatus	string	Flag specifying if the resource monitoring is enabled or disabled. Known values are: "Enabled" and "Disabled".
provisioningState	string	Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
sku	object	:vartype sku: ~azure.mgmt.datadog.models.ResourceSku
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Dictionary of .
type	string	The type of the monitor resource.
userInfo	object	Includes name, email and optionally, phone number. User Information can't be null.

list_by_resource_group

Name	Datatype	Description
id	string	ARM id of the monitor resource.
name	string	Name of the monitor resource.
datadogOrganizationProperties	object	Specify the Datadog organization name. In the case of linking to existing organizations, Id, ApiKey, and Applicationkey is required as well.
identity	object	:vartype identity: ~azure.mgmt.datadog.models.IdentityProperties
liftrResourceCategory	string	Known values are: "Unknown" and "MonitorLogs".
liftrResourcePreference	integer	The priority of the resource.
location	string	Required.
marketplaceSubscriptionStatus	string	Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. Known values are: "Provisioning", "Active", "Suspended", and "Unsubscribed".
monitoringStatus	string	Flag specifying if the resource monitoring is enabled or disabled. Known values are: "Enabled" and "Disabled".
provisioningState	string	Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
sku	object	:vartype sku: ~azure.mgmt.datadog.models.ResourceSku
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Dictionary of .
type	string	The type of the monitor resource.
userInfo	object	Includes name, email and optionally, phone number. User Information can't be null.

list

Name	Datatype	Description
id	string	ARM id of the monitor resource.
name	string	Name of the monitor resource.
datadogOrganizationProperties	object	Specify the Datadog organization name. In the case of linking to existing organizations, Id, ApiKey, and Applicationkey is required as well.
identity	object	:vartype identity: ~azure.mgmt.datadog.models.IdentityProperties
liftrResourceCategory	string	Known values are: "Unknown" and "MonitorLogs".
liftrResourcePreference	integer	The priority of the resource.
location	string	Required.
marketplaceSubscriptionStatus	string	Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state. Known values are: "Provisioning", "Active", "Suspended", and "Unsubscribed".
monitoringStatus	string	Flag specifying if the resource monitoring is enabled or disabled. Known values are: "Enabled" and "Disabled".
provisioningState	string	Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
sku	object	:vartype sku: ~azure.mgmt.datadog.models.ResourceSku
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Dictionary of .
type	string	The type of the monitor resource.
userInfo	object	Includes name, email and optionally, phone number. User Information can't be null.

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 the properties of a specific monitor resource. Get the properties of a specific monitor resource.
list_by_resource_group	select	resource_group_name, subscription_id		List all monitors under the specified resource group. List all monitors under the specified resource group.
list	select	subscription_id		List all monitors under the specified subscription. List all monitors under the specified subscription.
create	insert	resource_group_name, monitor_name, subscription_id, location		Create a monitor resource. Create a monitor resource.
update	update	resource_group_name, monitor_name, subscription_id		Update a monitor resource. Update a monitor resource.
delete	delete	resource_group_name, monitor_name, subscription_id		Delete a monitor resource. Delete a monitor resource.
list_api_keys	exec	resource_group_name, monitor_name, subscription_id		List the api keys for a given monitor resource. List the api keys for a given monitor resource.
list_hosts	exec	resource_group_name, monitor_name, subscription_id		List the hosts for a given monitor resource. List the hosts for a given monitor resource.
list_linked_resources	exec	resource_group_name, monitor_name, subscription_id		List all Azure resources associated to the same Datadog organization as the target resource. List all Azure resources associated to the same Datadog organization as the target resource.
list_monitored_resources	exec	resource_group_name, monitor_name, subscription_id		List the resources currently being monitored by the Datadog monitor resource. List the resources currently being monitored by the Datadog monitor resource.
get_default_key	exec	resource_group_name, monitor_name, subscription_id		Get the default api key. Get the default api key.
set_default_key	exec	resource_group_name, monitor_name, subscription_id, key		Set the default api key. Set the default api key.
refresh_set_password_link	exec	resource_group_name, monitor_name, subscription_id		Refresh the set password link and return a latest one. Refresh the set password link and return a latest one.

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 the properties of a specific monitor resource. Get the properties of a specific monitor resource.

SELECT
id,
name,
datadogOrganizationProperties,
identity,
liftrResourceCategory,
liftrResourcePreference,
location,
marketplaceSubscriptionStatus,
monitoringStatus,
provisioningState,
sku,
systemData,
tags,
type,
userInfo
FROM azure_isv.datadog.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 monitors under the specified resource group. List all monitors under the specified resource group.

SELECT
id,
name,
datadogOrganizationProperties,
identity,
liftrResourceCategory,
liftrResourcePreference,
location,
marketplaceSubscriptionStatus,
monitoringStatus,
provisioningState,
sku,
systemData,
tags,
type,
userInfo
FROM azure_isv.datadog.monitors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

List all monitors under the specified subscription. List all monitors under the specified subscription.

SELECT
id,
name,
datadogOrganizationProperties,
identity,
liftrResourceCategory,
liftrResourcePreference,
location,
marketplaceSubscriptionStatus,
monitoringStatus,
provisioningState,
sku,
systemData,
tags,
type,
userInfo
FROM azure_isv.datadog.monitors
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a monitor resource. Create a monitor resource.

INSERT INTO azure_isv.datadog.monitors (
sku,
properties,
identity,
tags,
location,
resource_group_name,
monitor_name,
subscription_id
)
SELECT 
'{{ sku }}',
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}' /* required */,
'{{ resource_group_name }}',
'{{ monitor_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
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: sku
    description: |
      :vartype sku: ~azure.mgmt.datadog.models.ResourceSku
    value:
      name: "{{ name }}"
  - name: properties
    description: |
      Properties specific to the monitor resource.
    value:
      provisioningState: "{{ provisioningState }}"
      monitoringStatus: "{{ monitoringStatus }}"
      marketplaceSubscriptionStatus: "{{ marketplaceSubscriptionStatus }}"
      datadogOrganizationProperties:
        name: "{{ name }}"
        id: "{{ id }}"
        linkingAuthCode: "{{ linkingAuthCode }}"
        linkingClientId: "{{ linkingClientId }}"
        redirectUri: "{{ redirectUri }}"
        apiKey: "{{ apiKey }}"
        applicationKey: "{{ applicationKey }}"
        enterpriseAppId: "{{ enterpriseAppId }}"
        cspm: {{ cspm }}
      userInfo:
        name: "{{ name }}"
        emailAddress: "{{ emailAddress }}"
        phoneNumber: "{{ phoneNumber }}"
      liftrResourceCategory: "{{ liftrResourceCategory }}"
      liftrResourcePreference: {{ liftrResourcePreference }}
  - name: identity
    description: |
      :vartype identity: ~azure.mgmt.datadog.models.IdentityProperties
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Dictionary of .
  - name: location
    value: "{{ location }}"
    description: |
      Required.

UPDATE examples

update

Update a monitor resource. Update a monitor resource.

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

DELETE examples

delete

Delete a monitor resource. Delete a monitor resource.

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

Lifecycle Methods

list_api_keys

List the api keys for a given monitor resource. List the api keys for a given monitor resource.

EXEC azure_isv.datadog.monitors.list_api_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_hosts

List the hosts for a given monitor resource. List the hosts for a given monitor resource.

EXEC azure_isv.datadog.monitors.list_hosts 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_linked_resources

List all Azure resources associated to the same Datadog organization as the target resource. List all Azure resources associated to the same Datadog organization as the target resource.

EXEC azure_isv.datadog.monitors.list_linked_resources 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

list_monitored_resources

List the resources currently being monitored by the Datadog monitor resource. List the resources currently being monitored by the Datadog monitor resource.

EXEC azure_isv.datadog.monitors.list_monitored_resources 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_default_key

Get the default api key. Get the default api key.

EXEC azure_isv.datadog.monitors.get_default_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

set_default_key

Set the default api key. Set the default api key.

EXEC azure_isv.datadog.monitors.set_default_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"createdBy": "{{ createdBy }}", 
"name": "{{ name }}", 
"key": "{{ key }}", 
"created": "{{ created }}"
}'
;

refresh_set_password_link

Refresh the set password link and return a latest one. Refresh the set password link and return a latest one.

EXEC azure_isv.datadog.monitors.refresh_set_password_link 
@resource_group_name='{{ resource_group_name }}' --required, 
@monitor_name='{{ monitor_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;