Monitors - Create

Service:: Datadog

API Version:: 2023-10-20

Create a monitor resource.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Datadog/monitors/{monitorName}?api-version=2023-10-20

URI Parameters

Name	In	Required	Type	Description
monitorName	path	True	string	Monitor resource name
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Request Body

Name	Required	Type	Description
location	True	string
identity		IdentityProperties
properties		MonitorProperties	Properties specific to the monitor resource.
sku		ResourceSku
tags		object

Responses

Name	Type	Description
200 OK	DatadogMonitorResource	Success
201 Created	DatadogMonitorResource	Success
Other Status Codes	ErrorResponse	Default error response.

Examples

Monitors_Create

Sample request

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Datadog/monitors/myMonitor?api-version=2023-10-20

{
  "sku": {
    "name": "free_Monthly"
  },
  "properties": {
    "monitoringStatus": "Enabled",
    "datadogOrganizationProperties": {
      "name": "myOrg",
      "id": "myOrg123",
      "linkingAuthCode": "someAuthCode",
      "linkingClientId": "00000000-0000-0000-0000-000000000000",
      "enterpriseAppId": "00000000-0000-0000-0000-000000000000",
      "cspm": false
    },
    "userInfo": {
      "name": "Alice",
      "emailAddress": "alice@microsoft.com",
      "phoneNumber": "123-456-7890"
    }
  },
  "tags": {
    "Environment": "Dev"
  },
  "location": "West US"
}

Sample response

Status code:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor",
  "name": "myMonitor",
  "type": "Microsoft.Datadog/monitors",
  "sku": {
    "name": "free_Monthly"
  },
  "properties": {
    "provisioningState": "Succeeded",
    "monitoringStatus": "Enabled",
    "datadogOrganizationProperties": {
      "name": "myOrg",
      "id": "myOrg123",
      "linkingAuthCode": null,
      "linkingClientId": null,
      "enterpriseAppId": null
    },
    "liftrResourceCategory": "MonitorLogs",
    "liftrResourcePreference": 1
  },
  "tags": {
    "Environment": "Dev"
  },
  "location": "West US"
}

Status code:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor",
  "name": "myMonitor",
  "type": "Microsoft.Datadog/monitors",
  "sku": {
    "name": "free_Monthly"
  },
  "properties": {
    "provisioningState": "Accepted",
    "monitoringStatus": "Enabled",
    "datadogOrganizationProperties": {
      "name": "myOrg",
      "id": "myOrg123"
    },
    "liftrResourceCategory": "MonitorLogs",
    "liftrResourcePreference": 1
  },
  "tags": {
    "Environment": "Dev"
  },
  "location": "West US"
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DatadogMonitorResource
DatadogOrganizationProperties	Specify the Datadog organization name. In the case of linking to existing organizations, Id, ApiKey, and Applicationkey is required as well.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
IdentityProperties
LiftrResourceCategories
ManagedIdentityTypes	Specifies the identity type of the Datadog Monitor. At this time the only allowed value is 'SystemAssigned'.
MarketplaceSubscriptionStatus	Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.
MonitoringStatus	Flag specifying if the resource monitoring is enabled or disabled.
MonitorProperties	Properties specific to the monitor resource.
ProvisioningState
ResourceSku
systemData	Metadata pertaining to creation and last modification of the resource.
UserInfo	Includes name, email and optionally, phone number. User Information can't be null.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DatadogMonitorResource

Object

Name	Type	Description
id	string	ARM id of the monitor resource.
identity	IdentityProperties
location	string
name	string	Name of the monitor resource.
properties	MonitorProperties	Properties specific to the monitor resource.
sku	ResourceSku
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
tags	object
type	string	The type 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.

Name	Type	Description
apiKey	string	Api key associated to the Datadog organization.
applicationKey	string	Application key associated to the Datadog organization.
cspm	boolean	The configuration which describes the state of cloud security posture management. This collects configuration information for all resources in a subscription and track conformance to industry benchmarks.
enterpriseAppId	string	The Id of the Enterprise App used for Single sign on.
id	string	Id of the Datadog organization.
linkingAuthCode	string	The auth code used to linking to an existing Datadog organization.
linkingClientId	string	The client_id from an existing in exchange for an auth token to link organization.
name	string	Name of the Datadog organization.
redirectUri	string	The redirect URI for linking.

ErrorAdditionalInfo

Object

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

Object

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

IdentityProperties

Object

Name	Type	Description
principalId	string	The identity ID.
tenantId	string	The tenant ID of resource.
type	ManagedIdentityTypes	Specifies the identity type of the Datadog Monitor. At this time the only allowed value is 'SystemAssigned'.

LiftrResourceCategories

Enumeration

Value	Description
Unknown
MonitorLogs

ManagedIdentityTypes

Enumeration

Specifies the identity type of the Datadog Monitor. At this time the only allowed value is 'SystemAssigned'.

Value	Description
SystemAssigned
UserAssigned

MarketplaceSubscriptionStatus

Enumeration

Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.

Value	Description
Provisioning
Active
Suspended
Unsubscribed

MonitoringStatus

Enumeration

Flag specifying if the resource monitoring is enabled or disabled.

Value	Description
Enabled
Disabled

MonitorProperties

Object

Properties specific to the monitor resource.

Name	Type	Default value	Description
datadogOrganizationProperties	DatadogOrganizationProperties		Specify the Datadog organization name. In the case of linking to existing organizations, Id, ApiKey, and Applicationkey is required as well.
liftrResourceCategory	LiftrResourceCategories
liftrResourcePreference	integer (int32)		The priority of the resource.
marketplaceSubscriptionStatus	MarketplaceSubscriptionStatus		Flag specifying the Marketplace Subscription Status of the resource. If payment is not made in time, the resource will go in Suspended state.
monitoringStatus	MonitoringStatus	Enabled	Flag specifying if the resource monitoring is enabled or disabled.
provisioningState	ProvisioningState
userInfo	UserInfo		Includes name, email and optionally, phone number. User Information can't be null.

ProvisioningState

Enumeration

Value	Description
Accepted
Creating
Updating
Deleting
Succeeded
Failed
Canceled
Deleted
NotSpecified

ResourceSku

Object

Name	Type	Description
name	string	Name of the SKU in {PlanId} format. For Terraform, the only allowed value is 'Linked'.

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

UserInfo

Object

Includes name, email and optionally, phone number. User Information can't be null.

Name	Type	Description
emailAddress	string pattern: ^[A-Za-z0-9._%+-]+@(?:[A-Za-z0-9-]+\.)+[A-Za-z]{2,}$	Email of the user used by Datadog for contacting them if needed
name	string maxLength: 50	Name of the user
phoneNumber	string maxLength: 40	Phone number of the user used by Datadog for contacting them if needed

Share via

Monitors - Create

URI Parameters

Request Body

Responses

Examples

Monitors_Create

Sample request

Sample response

Definitions

createdByType

DatadogMonitorResource

DatadogOrganizationProperties

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

IdentityProperties

LiftrResourceCategories

ManagedIdentityTypes

MarketplaceSubscriptionStatus

MonitoringStatus

MonitorProperties

ProvisioningState

ResourceSku

systemData

UserInfo