monitors

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

Overview

Name	monitors
Type	Resource
Id	azure_isv.dynatrace.monitors

Fields

The following fields are returned by SELECT queries:

list_linkable_environments

Name	Datatype	Description
environmentId	string	environment id for which user is an admin.
environmentName	string	Name of the environment.
planData	object	Billing plan information.

get_sso_details

Name	Datatype	Description
aadDomains	array	array of Aad(azure active directory) domains.
adminUsers	array	Array of admin user emails.
isSsoEnabled	string	Whether the SSO is enabled for this resource or not. Known values are: "Enabled" and "Disabled".
metadataUrl	string	URL for Azure AD metadata.
singleSignOnUrl	string	The login URL specific to this Dynatrace Environment.

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dynatraceEnvironmentProperties	object	Properties of the Dynatrace environment.
identity	object	The managed service identities assigned to this resource.
liftrResourceCategory	string	Liftr Resource category. Known values are: "Unknown" and "MonitorLogs".
liftrResourcePreference	integer	The priority of the resource.
location	string	The geo-location where the resource lives. Required.
marketplaceSubscriptionStatus	string	Marketplace subscription status. Known values are: "Active" and "Suspended".
monitoringStatus	string	Status of the monitor. Known values are: "Enabled" and "Disabled".
planData	object	Billing plan information.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
systemData	object	System metadata for this resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userInfo	object	User info.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dynatraceEnvironmentProperties	object	Properties of the Dynatrace environment.
identity	object	The managed service identities assigned to this resource.
liftrResourceCategory	string	Liftr Resource category. Known values are: "Unknown" and "MonitorLogs".
liftrResourcePreference	integer	The priority of the resource.
location	string	The geo-location where the resource lives. Required.
marketplaceSubscriptionStatus	string	Marketplace subscription status. Known values are: "Active" and "Suspended".
monitoringStatus	string	Status of the monitor. Known values are: "Enabled" and "Disabled".
planData	object	Billing plan information.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
systemData	object	System metadata for this resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userInfo	object	User info.

get_marketplace_saas_resource_details

Name	Datatype	Description
marketplaceSaaSResourceId	string	Id of the Marketplace SaaS Resource.
marketplaceSubscriptionStatus	string	Marketplace subscription status. Known values are: "Active" and "Suspended".
planId	string	Id of the plan.

list_by_subscription_id

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
dynatraceEnvironmentProperties	object	Properties of the Dynatrace environment.
identity	object	The managed service identities assigned to this resource.
liftrResourceCategory	string	Liftr Resource category. Known values are: "Unknown" and "MonitorLogs".
liftrResourcePreference	integer	The priority of the resource.
location	string	The geo-location where the resource lives. Required.
marketplaceSubscriptionStatus	string	Marketplace subscription status. Known values are: "Active" and "Suspended".
monitoringStatus	string	Status of the monitor. Known values are: "Enabled" and "Disabled".
planData	object	Billing plan information.
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Creating", "Updating", "Deleting", "Succeeded", "Failed", "Canceled", "Deleted", and "NotSpecified".
systemData	object	System metadata for this resource.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
userInfo	object	User info.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_linkable_environments	select	resource_group_name, monitor_name, subscription_id		Gets all the Dynatrace environments that a user can link a azure resource to. Gets all the Dynatrace environments that a user can link a azure resource to.
get_sso_details	select	resource_group_name, monitor_name, subscription_id		Gets the SSO configuration details from the partner. Gets the SSO configuration details from the partner.
get	select	resource_group_name, monitor_name, subscription_id		Get a MonitorResource. Get a MonitorResource.
list_by_resource_group	select	resource_group_name, subscription_id		List MonitorResource resources by resource group. List MonitorResource resources by resource group.
get_marketplace_saas_resource_details	select	subscription_id		Get Marketplace SaaS resource details of a tenant under a specific subscription.
list_by_subscription_id	select	subscription_id		List all MonitorResource by subscriptionId. List all MonitorResource by subscriptionId.
create_or_update	insert	resource_group_name, monitor_name, subscription_id, location		Create a MonitorResource. Create a MonitorResource.
update	update	resource_group_name, monitor_name, subscription_id		Update a MonitorResource. Update a MonitorResource.
create_or_update	replace	resource_group_name, monitor_name, subscription_id, location		Create a MonitorResource. Create a MonitorResource.
delete	delete	resource_group_name, monitor_name, subscription_id		Delete a MonitorResource. Delete a MonitorResource.
list_monitored_resources	exec	resource_group_name, monitor_name, subscription_id		List the resources currently being monitored by the Dynatrace monitor resource. List the resources currently being monitored by the Dynatrace monitor resource.
list_hosts	exec	resource_group_name, monitor_name, subscription_id		List the VM/VMSS resources currently being monitored by the Dynatrace resource. List the VM/VMSS resources currently being monitored by the Dynatrace resource.
list_app_services	exec	resource_group_name, monitor_name, subscription_id		Gets list of App Services with Dynatrace PaaS OneAgent enabled. Gets list of App Services with Dynatrace PaaS OneAgent enabled.
get_vm_host_payload	exec	resource_group_name, monitor_name, subscription_id		Returns the payload that needs to be passed in the request body for installing Dynatrace agent on a VM. Returns the payload that needs to be passed in the request body for installing Dynatrace agent on a VM.
get_metric_status	exec	resource_group_name, monitor_name, subscription_id		Get metric status.

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	Name of the Monitor resource. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

list_linkable_environments

Gets all the Dynatrace environments that a user can link a azure resource to. Gets all the Dynatrace environments that a user can link a azure resource to.

SELECT
environmentId,
environmentName,
planData
FROM azure_isv.dynatrace.monitors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND monitor_name = '{{ monitor_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get_sso_details

Gets the SSO configuration details from the partner. Gets the SSO configuration details from the partner.

SELECT
aadDomains,
adminUsers,
isSsoEnabled,
metadataUrl,
singleSignOnUrl
FROM azure_isv.dynatrace.monitors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND monitor_name = '{{ monitor_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Get a MonitorResource. Get a MonitorResource.

SELECT
id,
name,
dynatraceEnvironmentProperties,
identity,
liftrResourceCategory,
liftrResourcePreference,
location,
marketplaceSubscriptionStatus,
monitoringStatus,
planData,
provisioningState,
systemData,
tags,
type,
userInfo
FROM azure_isv.dynatrace.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 MonitorResource resources by resource group. List MonitorResource resources by resource group.

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

get_marketplace_saas_resource_details

Get Marketplace SaaS resource details of a tenant under a specific subscription.

SELECT
marketplaceSaaSResourceId,
marketplaceSubscriptionStatus,
planId
FROM azure_isv.dynatrace.monitors
WHERE subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription_id

List all MonitorResource by subscriptionId. List all MonitorResource by subscriptionId.

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

INSERT examples

create_or_update

Create a MonitorResource. Create a MonitorResource.

INSERT INTO azure_isv.dynatrace.monitors (
tags,
location,
identity,
properties,
resource_group_name,
monitor_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ identity }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ monitor_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
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: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      tenantId: "{{ tenantId }}"
      principalId: "{{ principalId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: properties
    value:
      monitoringStatus: "{{ monitoringStatus }}"
      marketplaceSubscriptionStatus: "{{ marketplaceSubscriptionStatus }}"
      dynatraceEnvironmentProperties:
        userId: "{{ userId }}"
        accountInfo:
          accountId: "{{ accountId }}"
          regionId: "{{ regionId }}"
        environmentInfo:
          environmentId: "{{ environmentId }}"
          ingestionKey: "{{ ingestionKey }}"
          logsIngestionEndpoint: "{{ logsIngestionEndpoint }}"
          landingURL: "{{ landingURL }}"
        singleSignOnProperties:
          singleSignOnState: "{{ singleSignOnState }}"
          enterpriseAppId: "{{ enterpriseAppId }}"
          singleSignOnUrl: "{{ singleSignOnUrl }}"
          aadDomains:
            - "{{ aadDomains }}"
          provisioningState: "{{ provisioningState }}"
      userInfo:
        firstName: "{{ firstName }}"
        lastName: "{{ lastName }}"
        emailAddress: "{{ emailAddress }}"
        phoneNumber: "{{ phoneNumber }}"
        country: "{{ country }}"
      planData:
        usageType: "{{ usageType }}"
        billingCycle: "{{ billingCycle }}"
        planDetails: "{{ planDetails }}"
        effectiveDate: "{{ effectiveDate }}"

UPDATE examples

update

Update a MonitorResource. Update a MonitorResource.

UPDATE azure_isv.dynatrace.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,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create a MonitorResource. Create a MonitorResource.

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

DELETE examples

delete

Delete a MonitorResource. Delete a MonitorResource.

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

Lifecycle Methods

list_monitored_resources

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

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

list_hosts

List the VM/VMSS resources currently being monitored by the Dynatrace resource. List the VM/VMSS resources currently being monitored by the Dynatrace resource.

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

list_app_services

Gets list of App Services with Dynatrace PaaS OneAgent enabled. Gets list of App Services with Dynatrace PaaS OneAgent enabled.

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

get_vm_host_payload

Returns the payload that needs to be passed in the request body for installing Dynatrace agent on a VM. Returns the payload that needs to be passed in the request body for installing Dynatrace agent on a VM.

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

get_metric_status

Get metric status.

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