Share via


Dynatrace.Observability 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 Dynatrace.Observability/monitors resource, add the following Bicep to your template.

resource symbolicname 'Dynatrace.Observability/monitors@2023-04-27' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {
        clientId: 'string'
        principalId: 'string'
      }
    }
  }
  location: 'string'
  name: 'string'
  properties: {
    dynatraceEnvironmentProperties: {
      accountInfo: {
        accountId: 'string'
        regionId: 'string'
      }
      environmentInfo: {
        environmentId: 'string'
        ingestionKey: 'string'
        landingURL: 'string'
        logsIngestionEndpoint: 'string'
      }
      singleSignOnProperties: {
        aadDomains: [
          'string'
        ]
        enterpriseAppId: 'string'
        singleSignOnState: 'string'
        singleSignOnUrl: 'string'
      }
      userId: 'string'
    }
    marketplaceSubscriptionStatus: 'string'
    monitoringStatus: 'string'
    planData: {
      billingCycle: 'string'
      effectiveDate: 'string'
      planDetails: 'string'
      usageType: 'string'
    }
    userInfo: {
      country: 'string'
      emailAddress: 'string'
      firstName: 'string'
      lastName: 'string'
      phoneNumber: 'string'
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

Property Values

Dynatrace.Observability/monitors

Name Description Value
identity The managed service identities assigned to this resource. IdentityProperties
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties The resource-specific properties for this resource. MonitorProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates

AccountInfo

Name Description Value
accountId Account Id of the account this environment is linked to string
regionId Region in which the account is created string

DynatraceEnvironmentProperties

Name Description Value
accountInfo Dynatrace Account Information AccountInfo
environmentInfo Dynatrace Environment Information EnvironmentInfo
singleSignOnProperties The details of a Dynatrace single sign-on. DynatraceSingleSignOnProperties
userId User id string

DynatraceSingleSignOnProperties

Name Description Value
aadDomains array of Aad(azure active directory) domains string[]
enterpriseAppId Version of the Dynatrace agent installed on the VM. string
singleSignOnState State of Single Sign On 'Disable'
'Enable'
'Existing'
'Initial'
singleSignOnUrl The login URL specific to this Dynatrace Environment string

EnvironmentInfo

Name Description Value
environmentId Id of the environment created string
ingestionKey Ingestion key of the environment string
landingURL Landing URL for Dynatrace environment string
logsIngestionEndpoint Ingestion endpoint used for sending logs string

IdentityProperties

Name Description Value
type The type of managed identity assigned to this resource. 'SystemAndUserAssigned'
'SystemAssigned'
'UserAssigned' (required)
userAssignedIdentities The identities assigned to this resource by the user. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Name Description Value

MonitorProperties

Name Description Value
dynatraceEnvironmentProperties Properties of the Dynatrace environment. DynatraceEnvironmentProperties
marketplaceSubscriptionStatus Marketplace subscription status. 'Active'
'Suspended'
monitoringStatus Status of the monitor. 'Disabled'
'Enabled'
planData Billing plan information. PlanData
userInfo User info. UserInfo

PlanData

Name Description Value
billingCycle different billing cycles like MONTHLY/WEEKLY. this could be enum string
effectiveDate date when plan was applied string
planDetails plan id as published by Dynatrace string
usageType different usage type like PAYG/COMMITTED. this could be enum string

TrackedResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value
clientId The active directory client identifier for this principal. string (required)
principalId The active directory identifier for this principal. string (required)

UserInfo

Name Description Value
country Country of the user string
emailAddress Email of the user used by Dynatrace for contacting them if needed string

Constraints:
Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$
firstName First Name of the user string
lastName Last Name of the user string
phoneNumber Phone number of the user used by Dynatrace for contacting them if needed string

Constraints:
Max length = 40

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 Dynatrace.Observability/monitors resource, add the following JSON to your template.

{
  "type": "Dynatrace.Observability/monitors",
  "apiVersion": "2023-04-27",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
        "clientId": "string",
        "principalId": "string"
      }
    }
  },
  "location": "string",
  "properties": {
    "dynatraceEnvironmentProperties": {
      "accountInfo": {
        "accountId": "string",
        "regionId": "string"
      },
      "environmentInfo": {
        "environmentId": "string",
        "ingestionKey": "string",
        "landingURL": "string",
        "logsIngestionEndpoint": "string"
      },
      "singleSignOnProperties": {
        "aadDomains": [ "string" ],
        "enterpriseAppId": "string",
        "singleSignOnState": "string",
        "singleSignOnUrl": "string"
      },
      "userId": "string"
    },
    "marketplaceSubscriptionStatus": "string",
    "monitoringStatus": "string",
    "planData": {
      "billingCycle": "string",
      "effectiveDate": "string",
      "planDetails": "string",
      "usageType": "string"
    },
    "userInfo": {
      "country": "string",
      "emailAddress": "string",
      "firstName": "string",
      "lastName": "string",
      "phoneNumber": "string"
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property Values

Dynatrace.Observability/monitors

Name Description Value
apiVersion The api version '2023-04-27'
identity The managed service identities assigned to this resource. IdentityProperties
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties The resource-specific properties for this resource. MonitorProperties (required)
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Dynatrace.Observability/monitors'

AccountInfo

Name Description Value
accountId Account Id of the account this environment is linked to string
regionId Region in which the account is created string

DynatraceEnvironmentProperties

Name Description Value
accountInfo Dynatrace Account Information AccountInfo
environmentInfo Dynatrace Environment Information EnvironmentInfo
singleSignOnProperties The details of a Dynatrace single sign-on. DynatraceSingleSignOnProperties
userId User id string

DynatraceSingleSignOnProperties

Name Description Value
aadDomains array of Aad(azure active directory) domains string[]
enterpriseAppId Version of the Dynatrace agent installed on the VM. string
singleSignOnState State of Single Sign On 'Disable'
'Enable'
'Existing'
'Initial'
singleSignOnUrl The login URL specific to this Dynatrace Environment string

EnvironmentInfo

Name Description Value
environmentId Id of the environment created string
ingestionKey Ingestion key of the environment string
landingURL Landing URL for Dynatrace environment string
logsIngestionEndpoint Ingestion endpoint used for sending logs string

IdentityProperties

Name Description Value
type The type of managed identity assigned to this resource. 'SystemAndUserAssigned'
'SystemAssigned'
'UserAssigned' (required)
userAssignedIdentities The identities assigned to this resource by the user. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Name Description Value

MonitorProperties

Name Description Value
dynatraceEnvironmentProperties Properties of the Dynatrace environment. DynatraceEnvironmentProperties
marketplaceSubscriptionStatus Marketplace subscription status. 'Active'
'Suspended'
monitoringStatus Status of the monitor. 'Disabled'
'Enabled'
planData Billing plan information. PlanData
userInfo User info. UserInfo

PlanData

Name Description Value
billingCycle different billing cycles like MONTHLY/WEEKLY. this could be enum string
effectiveDate date when plan was applied string
planDetails plan id as published by Dynatrace string
usageType different usage type like PAYG/COMMITTED. this could be enum string

TrackedResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value
clientId The active directory client identifier for this principal. string (required)
principalId The active directory identifier for this principal. string (required)

UserInfo

Name Description Value
country Country of the user string
emailAddress Email of the user used by Dynatrace for contacting them if needed string

Constraints:
Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$
firstName First Name of the user string
lastName Last Name of the user string
phoneNumber Phone number of the user used by Dynatrace for contacting them if needed string

Constraints:
Max length = 40

Usage Examples

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 Dynatrace.Observability/monitors resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Dynatrace.Observability/monitors@2023-04-27"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    properties = {
      dynatraceEnvironmentProperties = {
        accountInfo = {
          accountId = "string"
          regionId = "string"
        }
        environmentInfo = {
          environmentId = "string"
          ingestionKey = "string"
          landingURL = "string"
          logsIngestionEndpoint = "string"
        }
        singleSignOnProperties = {
          aadDomains = [
            "string"
          ]
          enterpriseAppId = "string"
          singleSignOnState = "string"
          singleSignOnUrl = "string"
        }
        userId = "string"
      }
      marketplaceSubscriptionStatus = "string"
      monitoringStatus = "string"
      planData = {
        billingCycle = "string"
        effectiveDate = "string"
        planDetails = "string"
        usageType = "string"
      }
      userInfo = {
        country = "string"
        emailAddress = "string"
        firstName = "string"
        lastName = "string"
        phoneNumber = "string"
      }
    }
  }
}

Property Values

Dynatrace.Observability/monitors

Name Description Value
identity The managed service identities assigned to this resource. IdentityProperties
location The geo-location where the resource lives string (required)
name The resource name string (required)
properties The resource-specific properties for this resource. MonitorProperties (required)
tags Resource tags Dictionary of tag names and values.
type The resource type "Dynatrace.Observability/monitors@2023-04-27"

AccountInfo

Name Description Value
accountId Account Id of the account this environment is linked to string
regionId Region in which the account is created string

DynatraceEnvironmentProperties

Name Description Value
accountInfo Dynatrace Account Information AccountInfo
environmentInfo Dynatrace Environment Information EnvironmentInfo
singleSignOnProperties The details of a Dynatrace single sign-on. DynatraceSingleSignOnProperties
userId User id string

DynatraceSingleSignOnProperties

Name Description Value
aadDomains array of Aad(azure active directory) domains string[]
enterpriseAppId Version of the Dynatrace agent installed on the VM. string
singleSignOnState State of Single Sign On 'Disable'
'Enable'
'Existing'
'Initial'
singleSignOnUrl The login URL specific to this Dynatrace Environment string

EnvironmentInfo

Name Description Value
environmentId Id of the environment created string
ingestionKey Ingestion key of the environment string
landingURL Landing URL for Dynatrace environment string
logsIngestionEndpoint Ingestion endpoint used for sending logs string

IdentityProperties

Name Description Value
type The type of managed identity assigned to this resource. 'SystemAndUserAssigned'
'SystemAssigned'
'UserAssigned' (required)
userAssignedIdentities The identities assigned to this resource by the user. IdentityPropertiesUserAssignedIdentities

IdentityPropertiesUserAssignedIdentities

Name Description Value

MonitorProperties

Name Description Value
dynatraceEnvironmentProperties Properties of the Dynatrace environment. DynatraceEnvironmentProperties
marketplaceSubscriptionStatus Marketplace subscription status. 'Active'
'Suspended'
monitoringStatus Status of the monitor. 'Disabled'
'Enabled'
planData Billing plan information. PlanData
userInfo User info. UserInfo

PlanData

Name Description Value
billingCycle different billing cycles like MONTHLY/WEEKLY. this could be enum string
effectiveDate date when plan was applied string
planDetails plan id as published by Dynatrace string
usageType different usage type like PAYG/COMMITTED. this could be enum string

TrackedResourceTags

Name Description Value

UserAssignedIdentity

Name Description Value
clientId The active directory client identifier for this principal. string (required)
principalId The active directory identifier for this principal. string (required)

UserInfo

Name Description Value
country Country of the user string
emailAddress Email of the user used by Dynatrace for contacting them if needed string

Constraints:
Pattern = ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$
firstName First Name of the user string
lastName Last Name of the user string
phoneNumber Phone number of the user used by Dynatrace for contacting them if needed string

Constraints:
Max length = 40