Monitors - List

Service:

Datadog

API Version:

2023-01-01

List all monitors under the specified subscription.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Datadog/monitors?api-version=2023-01-01

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	DatadogMonitorResourceListResponse	Success
Other Status Codes	ErrorResponse	Default error response.

Examples

Monitors_List

Sample Request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Datadog/monitors?api-version=2023-01-01

Java

/** Samples for Monitors List. */
public final class Main {
    /*
     * x-ms-original-file: specification/datadog/resource-manager/Microsoft.Datadog/stable/2023-01-01/examples/Monitors_List.json
     */
    /**
     * Sample code: Monitors_List.
     *
     * @param manager Entry point to MicrosoftDatadogManager.
     */
    public static void monitorsList(com.azure.resourcemanager.datadog.MicrosoftDatadogManager manager) {
        manager.monitors().list(com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.datadog import MicrosoftDatadogClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-datadog
# USAGE
    python monitors_list.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = MicrosoftDatadogClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.monitors.list()
    for item in response:
        print(item)


# x-ms-original-file: specification/datadog/resource-manager/Microsoft.Datadog/stable/2023-01-01/examples/Monitors_List.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armdatadog_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/datadog/armdatadog"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c280892951a9e45c059132c05aace25a9c752d48/specification/datadog/resource-manager/Microsoft.Datadog/stable/2023-01-01/examples/Monitors_List.json
func ExampleMonitorsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armdatadog.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewMonitorsClient().NewListPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.MonitorResourceListResponse = armdatadog.MonitorResourceListResponse{
		// 	Value: []*armdatadog.MonitorResource{
		// 		{
		// 			Name: to.Ptr("myMonitor"),
		// 			Type: to.Ptr("Microsoft.Datadog/monitors"),
		// 			ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/monitors/myMonitor"),
		// 			Location: to.Ptr("West US"),
		// 			Properties: &armdatadog.MonitorProperties{
		// 				DatadogOrganizationProperties: &armdatadog.OrganizationProperties{
		// 					Name: to.Ptr("myOrg"),
		// 					Cspm: to.Ptr(false),
		// 					ID: to.Ptr("myOrg123"),
		// 				},
		// 				LiftrResourceCategory: to.Ptr(armdatadog.LiftrResourceCategoriesMonitorLogs),
		// 				LiftrResourcePreference: to.Ptr[int32](1),
		// 				MonitoringStatus: to.Ptr(armdatadog.MonitoringStatusEnabled),
		// 				ProvisioningState: to.Ptr(armdatadog.ProvisioningStateSucceeded),
		// 			},
		// 			Tags: map[string]*string{
		// 				"Environment": to.Ptr("Dev"),
		// 			},
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { MicrosoftDatadogClient } = require("@azure/arm-datadog");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List all monitors under the specified subscription.
 *
 * @summary List all monitors under the specified subscription.
 * x-ms-original-file: specification/datadog/resource-manager/Microsoft.Datadog/stable/2023-01-01/examples/Monitors_List.json
 */
async function monitorsList() {
  const subscriptionId =
    process.env["DATADOG_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const credential = new DefaultAzureCredential();
  const client = new MicrosoftDatadogClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.monitors.list()) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

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

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DatadogMonitorResource
DatadogMonitorResourceListResponse	Response of a list operation.
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

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DatadogMonitorResource

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.

DatadogMonitorResourceListResponse

Response of a list operation.

Name	Type	Description
nextLink	string	Link to the next set of results, if any.
value	DatadogMonitorResource[]	Results of a list operation.

DatadogOrganizationProperties

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

The resource management error additional info.

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

ErrorDetail

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

Error response

Name	Type	Description
error	ErrorDetail	The error object.

IdentityProperties

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

Name	Type	Description
MonitorLogs	string
Unknown	string

ManagedIdentityTypes

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

Name	Type	Description
SystemAssigned	string
UserAssigned	string

MarketplaceSubscriptionStatus

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

Name	Type	Description
Active	string
Provisioning	string
Suspended	string
Unsubscribed	string

MonitoringStatus

Flag specifying if the resource monitoring is enabled or disabled.

Name	Type	Description
Disabled	string
Enabled	string

MonitorProperties

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		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

Name	Type	Description
Accepted	string
Canceled	string
Creating	string
Deleted	string
Deleting	string
Failed	string
NotSpecified	string
Succeeded	string
Updating	string

ResourceSku

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

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	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	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

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

Name	Type	Description
emailAddress	string	Email of the user used by Datadog for contacting them if needed
name	string	Name of the user
phoneNumber	string	Phone number of the user used by Datadog for contacting them if needed