Azure Integration Manual Setup Guide

Cette page n'est pas encore disponible en français, sa traduction est en cours.
Si vous avez des questions ou des retours sur notre projet de traduction actuel, n'hésitez pas à nous contacter.

Overview

Use this guide to manually set up the Datadog Azure integration through an app registration with read permissions to the monitored subscriptions.

All sites: All Datadog sites can use the steps on this page to complete the app registration credential process for Azure metric collection and the Event Hub setup for sending Azure Platform Logs.

US3: If your organization is on the Datadog US3 site, you can use the Azure Native integration to streamline management and data collection for your Azure environment. Datadog recommends using this method when possible. Setup entails creating a Datadog resource in Azure to link your Azure subscriptions to your Datadog organization. This replaces the app registration credential process for metric collection and Event Hub setup for log forwarding. See the Azure Native manual setup guide for more information.

Setup

Integrating through the Azure CLI

To integrate Datadog with Azure using the Azure CLI, Datadog recommends using the Azure Cloud Shell.

First, log into the Azure account you want to integrate with Datadog:

az login

Create a service principal and configure its access to Azure resources:

az ad sp create-for-rbac

Display a list of subscriptions so that you can copy and paste the subscription_id:

az account list --output table

Create an application as a service principal using the format:

az ad sp create-for-rbac --role "Monitoring Reader" --scopes /subscriptions/{subscription_id}

Example Output:

{
  "appId": "4ce52v13k-39j6-98ea-b632-965b77d02f36",
  "displayName": "azure-cli-2025-02-23-04-27-19",
  "password": "fe-3T~bEcFxY23R7NHwVS_qP5AmxLuTwgap5Dea6",
  "tenant": "abc123de-12f1-82de-97bb-4b2cd023bd31"
}
  • This command grants the Service Principal the monitoring reader role for the subscription you would like to monitor.
  • The appID generated from this command must be entered in the Datadog Azure integration tile under Client ID.
  • Enter the generated Tenant ID value in the Datadog Azure integration tile under Tenant name/ID.
  • --scopes can support multiple values, and you can add multiple subscriptions or Management Groups at once. See the examples in the az ad sp documentation.
  • Add --name <CUSTOM_NAME> to use a hand-picked name, otherwise Azure generates a unique one. The name is not used in the setup process.
  • Add --password <CUSTOM_PASSWORD> to use a hand-picked password. Otherwise Azure generates a unique one. This password must be entered in the Datadog Azure integration tile under Client Secret.

Management Group is a valid and recommended option for scope. For example:

az account management-group entities list --query "[?inheritedPermissions!='noaccess' && permissions!='noaccess'].{Name:displayName,Id:id}" --output table
  • This command displays all the subscriptions and management groups a user has access to.
  • It joins the IDs together and creates the Service-Principal. You can run this one command to create a user and assign roles to every management-group/subscription

First, log in to the Azure account you want to integrate with Datadog:

azure login

Run the account show command:

az account show

Enter the generated Tenant ID value in the Datadog Azure integration tile under Tenant name/ID.

Create a name and password:

azure ad sp create -n <NAME> -p <PASSWORD>
  • The <NAME> is NOT used but is required as part of the setup process.
  • The <PASSWORD> you choose must be entered in the Datadog Azure integration tile under Client Secret.
  • The Object Id returned from this command is used in place of <OBJECT_ID> in the next command.

Create an application as a service principal using the format:

azure role assignment create --objectId <OBJECT_ID> -o "Monitoring Reader" -c /subscriptions/<SUBSCRIPTION_ID>/
  • This command grants the Service Principal the monitoring reader role for the subscription you would like to monitor.
  • The Service Principal Name generated from this command must be entered in the Datadog Azure integration tile under Client ID.
  • <SUBSCRIPTION_ID> is the Azure subscription you would like to monitor, and is listed as ID with azure account show or in the portal.

Integrating through the Azure portal

  1. In the Azure integration tile, select Configuration > New App Registration > Using Azure Portal.

  2. Select Management Group (Auto-Discover) or Individual Subscriptions.

    • If you select Management Group, Datadog automatically discovers and monitors any subscriptions within that selected scope, including any subscriptions created in the future. You must have the owner role in the Management Group selected.
    • If you select Individual Subscriptions, you must have the owner role in any subscriptions you want to monitor.
  3. Click Open Template.

The Azure tile in the Datadog integrations page with Using Azure Portal and Management Group selected
  1. Select the Region, Subscription, and Resource Group for the template to be deployed.

    Note: The selection of region, subscription, and resource group only defines where this template is deployed. It has no impact on which subscriptions are monitored by Datadog.

  2. Click Next.

  3. Select the Create new option in Service principal type.

  4. Click the Change selection link in Service principal. A form to create a new app registration is displayed:

The service principal page in the Azure ARM template with the option to Create New selected and the link to Change Selection highlighted
  1. Enter a name for the app registration, select the supported account types, and click Register.

  2. A page opens to create a client secret. Click + New client secret to add a client secret.

  3. Copy the value of the client secret, and click the close (X) button in the top-right corner of the screen.

  4. Paste the value of the client secret in the corresponding field on the template, and click Next.

  5. Provide a Datadog API key and Datadog Application key value in the corresponding fields. If you launched the template from the Azure integration page in Datadog, you can copy the keys provided there. Otherwise, you can find your API and App keys in the Access section of the Organization Settings.

    Note: If you’ve selected to monitor individual subscriptions rather than a management group, select the subscriptions to monitor from the Subscriptions to monitor dropdown.

  6. Select your Datadog site, as well as any other integration configuration options, such as host filters and whether to collect resources for Cloud Security Management.

  7. Click Review + create, then click Create.

  8. Once the deployment has completed, click Done in the Azure integration page in Datadog to refresh the list and review your newly added App Registration.

  1. Create an app registration in your Active Directory and pass the correct credentials to Datadog.
  2. Give the application read-access to any subscriptions you would like to monitor.

Creating the app registration

  1. Under Azure Active Directory, navigate to App Registrations and click New registration.

  2. Enter the following and click the Create button. The name and sign-on URL are not used but are required for the setup process.

    • Name: Datadog Auth
    • Supported Account Types: Accounts in this organizational directory only (Datadog)
    • Redirect URI:
Azure create app

Giving read permissions to the application

  1. To assign access at the individual subscription level, navigate to Subscriptions through the search box or the left sidebar.
Subscriptions icon

To assign access at the Management Group level, navigate to Management Groups and select the Management Group that contains the set of subscriptions you would like to monitor. Note: Assigning access at the Management Group level means that any new subscriptions added to the group are automatically discovered and monitored by Datadog.

Management groups icon

To configure monitoring for the entire tenant, assign access to the Tenant Root Group.

  1. Click on the subscription you would like to monitor.

  2. Select Access control (IAM) in the subscription menu and click Add > Add role assignment:

    Add Role Assignment
  3. For Role, select Monitoring Reader. Under Select, choose the name of the Application you just created:

  4. Click Save.

  5. Repeat this process for any additional subscriptions you want to monitor with Datadog. Note: Users of Azure Lighthouse can add subscriptions from customer tenants.

Note: Diagnostics must be enabled for ARM deployed VMs to collect metrics, see Enable diagnostics.

Completing the integration

  1. Under App Registrations, select the App you created, copy the Application ID and Tenant ID, and paste the values in the Datadog Azure integration tile under Client ID and Tenant ID.

  2. For the same app, go to Manage > Certificates and secrets.

  3. Add a new Client Secret called datadogClientSecret, select a timeframe for Expires, and click Add:

    Azure client secret
  4. When the key value is shown, copy and paste the value in the Datadog Azure integration tile under Client Secret and click Install Integration or Update Configuration.

Note: Your updates to the Azure configuration can take up to 20 minutes to be reflected in Datadog.

Configuration

To limit metric collection for Azure-based hosts, open the integration tile for Azure. Select the Configuration tab, then open App Registrations. Enter a list of tags in the text box under Metric Collection Filters.

This list of tags in <KEY>:<VALUE> form is separated by commas and defines a filter used while collecting metrics. Wildcards such as ? (for single characters) and * (for multiple characters) can also be used.

Only VMs that match one of the defined tags are imported into Datadog. The rest are ignored. VMs matching a given tag can also be excluded by adding ! before the tag. For example:

datadog:monitored,env:production,!env:staging,instance-type:c1.*

Monitor the integration status

Once the integration is configured, Datadog begins running a continuous series of calls to Azure APIs to collect critical monitoring data from your Azure environment. Sometimes these calls return errors (for example, if the provided credentials have expired). These errors can inhibit or block Datadog’s ability to collect monitoring data.

When critical errors are encountered, the Azure integration generates events in the Datadog Events Explorer, and republishes them every five minutes. You can configure an Event Monitor to trigger when these events are detected and notify the appropriate team.

Datadog provides a recommended monitor you can use as a template to get started. To use the recommended monitor:

  1. In Datadog, go to Monitors -> New Monitor and select the Recommended Monitors tab.
  2. Select the recommended monitor titled [Azure] Integration Errors.
  3. Make any desired modifications to the search query or alert conditions. By default, the monitor triggers whenever a new error is detected, and resolves when the error has not been detected for the past 15 minutes.
  4. Update the notification and re-notification messages as desired. Note that the events themselves contain pertinent information about the event and are included in the notification automatically. This includes detailed information about the scope, error response, and common steps to remediate.
  5. Configure notifications through your preferred channels (email, Slack, PagerDuty, or others) to make sure your team is alerted about issues affecting Azure data collection.

Metrics collection

After the integration tile is set up, metrics are collected by a crawler. To collect additional metrics, deploy the Datadog Agent to your VMs:

Agent installation

You can use the Azure extension to install the Datadog Agent on Windows VMs, Linux x64 VMs, and Linux ARM-based VMs. You can also use the AKS Cluster Extension to deploy the Agent to your AKS Clusters.

  1. In the Azure portal, select the appropriate VM.
  2. From the left sidebar, under Settings, select Extensions + applications.
  3. Click + Add.
  4. Search for and select the Datadog Agent extension.
  5. Click Next.
  6. Enter your Datadog API key and Datadog site, and click OK.

To install the Agent based on operating system or CI and CD tool, see the Datadog Agent installation instructions.

Note: Domain controllers are not supported when installing the Datadog Agent with the Azure extension.

The Datadog AKS Cluster Extension allows you to deploy the Datadog Agent natively within Azure AKS, avoiding the complexity of third-party management tools. To install the Datadog Agent with the AKS Cluster Extension:

  1. Go to your AKS cluster in the Azure portal.
  2. From the left sidebar of the AKS cluster, select Extensions + applications under Settings.
  3. Search for and select the Datadog AKS Cluster Extension.
  4. Click Create, and follow the instructions in the tile using your Datadog credentials and Datadog site.

Sending logs

See the Azure Logging guide to set up log forwarding from your Azure environment to Datadog.

PREVIEWING: safchain/fix-custom-agent