Créer et modifier des règles de collecte de données dans Azure Monitor

Article
04/08/2024

Plusieurs méthodes permettent de créer une règle de collecte des données (DCR) dans Azure Monitor. Dans certains cas, Azure Monitor crée et gère la DCR en fonction des paramètres que vous configurez dans le portail Azure. Dans d'autres cas, vous devrez peut-être créer vos propres DCR pour personnaliser des scénarios particuliers.

Cet article décrit les différentes méthodes de création et de modification d'une DCR. Pour le contenu de la DCR elle-même, reportez-vous à Structure d'une règle de collecte de données dans Azure Monitor.

Autorisations

Vous devez disposer des autorisations suivantes pour créer des DCR et des associations :

Rôle intégré	Étendues	Motif
Contributeur de surveillance	Abonnement et/ou Groupe de ressources et/ou Une règle de collecte de données existante	Créez ou modifiez des DCR, attribuez des règles à la machine, déployez des associations.
Contributeur de machine virtuelle Administrateur des ressources de la machine connectée à Azure	Machines virtuelles, groupes de machines virtuelles identiques Serveurs avec Azure Arc	Déployez des extensions d’agent sur la machine virtuelle.
Tout rôle avec l’action Microsoft.Resources/deployments/*	Abonnement et/ou Groupe de ressources et/ou Une règle de collecte de données existante	Déployer des modèles Azure Resource Manager.

Méthodes automatisées pour créer une DCR

Le tableau suivant répertorie les méthodes permettant de créer des scénarios de collecte de données à l'aide du portail Azure, où le DCR est créé pour vous. Dans ces cas, vous n'avez pas besoin d'interagir directement avec la DCR concernée.

Scénario	Ressources	Description
Agent Azure Monitor	Configurer la collecte de données pour l’agent Azure Monitor	Utilisez le portail Azure pour créer une règle de collecte de données qui spécifie les événements et les compteurs de performances à collecter à partir d’une machine avec l’agent Azure Monitor. Associez ensuite cette règle à une ou plusieurs machines virtuelles. L’agent Azure Monitor sera installé sur les machines sur lesquelles il n’est pas déjà installé.
	Activer la vue d’ensemble de VM Insights	Lorsque vous activez l'aperçu des machines virtuelles sur une machine virtuelle, l'agent Azure Monitor est installé et une DCR est créée pour collecter un ensemble prédéfini de compteurs de performances. Vous ne devez pas modifier cette DCR.
Container Insights	Activer Container Insights	Lorsque vous activez Container Insights sur un cluster Kubernetes, une version conteneurisée de l'agent Azure Monitor est installée et une DCR est créée pour collecter des données selon la configuration que vous avez sélectionnée. Vous devrez peut-être modifier cette DCR pour ajouter une transformation.
Journaux texte ou JSON	Collecter des journaux à partir d'un fichier texte ou JSON avec l'agent Azure Monitor	Utilisez le portail Azure pour créer une DCR afin de collecter les entrées d'un journal texte sur une machine avec l'agent Azure Monitor.

Créer manuellement une DCR

Pour créer manuellement une DCR, créez un fichier JSON à l'aide de la configuration appropriée pour la collecte de données que vous configurez. Utilisez d'abord l'un des échantillons de DCR et utilisez les informations de Structure d'une règle de collecte de données dans Azure Monitor pour modifier le fichier JSON en fonction de votre environnement et de vos besoins particuliers.

Une fois le fichier JSON créé, vous pouvez utiliser l'une des méthodes suivantes pour créer la DCR :

utilisez la commande az monitor data-collection rule create pour créer une DCR à partir de votre fichier JSON à l'aide d'Azure CLI, comme indiqué dans l'exemple suivant.

az monitor data-collection rule create --location 'eastus' --resource-group 'my-resource-group' --name 'myDCRName' --rule-file 'C:\MyNewDCR.json' --description 'This is my new DCR'

Utilisez la cmdlet New-AzDataCollectionRule pour créer la DCR à partir de votre fichier JSON en utilisant PowerShell comme indiqué dans l'exemple suivant.

New-AzDataCollectionRule -Location 'east-us' -ResourceGroupName 'my-resource-group' -RuleName 'myDCRName' -RuleFile 'C:\MyNewDCR.json' -Description 'This is my new DCR'

Utilisez la DCR create API pour créer la DCR à partir de votre fichier JSON. Vous pouvez utiliser toute méthode pour appeler une API REST, comme le présentent les exemples suivants.

$ResourceId = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.Insights/dataCollectionRules/my-dcr"
$FilePath = ".\my-dcr.json"
$DCRContent = Get-Content $FilePath -Raw 
Invoke-AzRestMethod -Path ("$ResourceId"+"?api-version=2022-06-01") -Method PUT -Payload $DCRContent

ResourceId="/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/Microsoft.Insights/dataCollectionRules/my-dcr"
FilePath="my-dcr.json"
az rest --method put --url $ResourceId"?api-version=2022-06-01" --body @$FilePath

Consultez les références suivantes pour définir des contrôleurs de domaine et des associations dans un modèle.

Utilisez le modèle suivant pour créer une DCR à l’aide d’informations à partir de la structure d’une règle de collecte de données dans Azure Monitor et des exemples de règles de collecte de données (DCR) dans Azure Monitor pour définir le dcr-properties.

{
    "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
    "contentVersion": "1.0.0.0",
    "parameters": {
        "dataCollectionRuleName": {
            "type": "string",
            "metadata": {
                "description": "Specifies the name of the Data Collection Rule to create."
            }
        },
        "location": {
            "type": "string",
            "metadata": {
                "description": "Specifies the location in which to create the Data Collection Rule."
            }
        }
    },
    "resources": [
        {
            "type": "Microsoft.Insights/dataCollectionRules",
            "name": "[parameters('dataCollectionRuleName')]",
            "location": "[parameters('location')]",
            "apiVersion": "2021-09-01-preview",
            "properties": {
                "<dcr-properties>"
            }
        }
    ]
}

Association DCR -Machine virtuelle Azure

L’exemple suivant crée une association entre une machine virtuelle Azure et une règle de collecte de données.

Fichier de modèle Bicep

@description('The name of the virtual machine.')
param vmName string

@description('The name of the association.')
param associationName string

@description('The resource ID of the data collection rule.')
param dataCollectionRuleId string

resource vm 'Microsoft.Compute/virtualMachines@2021-11-01' existing = {
  name: vmName
}

resource association 'Microsoft.Insights/dataCollectionRuleAssociations@2021-09-01-preview' = {
  name: associationName
  scope: vm
  properties: {
    description: 'Association of data collection rule. Deleting this association will break the data collection for this virtual machine.'
    dataCollectionRuleId: dataCollectionRuleId
  }
}

Fichier de modèle ARM

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vmName": {
      "type": "string",
      "metadata": {
        "description": "The name of the virtual machine."
      }
    },
    "associationName": {
      "type": "string",
      "metadata": {
        "description": "The name of the association."
      }
    },
    "dataCollectionRuleId": {
      "type": "string",
      "metadata": {
        "description": "The resource ID of the data collection rule."
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.Insights/dataCollectionRuleAssociations",
      "apiVersion": "2021-09-01-preview",
      "scope": "[format('Microsoft.Compute/virtualMachines/{0}', parameters('vmName'))]",
      "name": "[parameters('associationName')]",
      "properties": {
        "description": "Association of data collection rule. Deleting this association will break the data collection for this virtual machine.",
        "dataCollectionRuleId": "[parameters('dataCollectionRuleId')]"
      }
    }
  ]
}

Fichier de paramètres

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vmName": {
      "value": "my-azure-vm"
    },
    "associationName": {
      "value": "my-windows-vm-my-dcr"
    },
    "dataCollectionRuleId": {
      "value": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/microsoft.insights/datacollectionrules/my-dcr"
    }
   }
}

Association DCR -Serveur avec Arc

L’exemple suivant crée une association entre un serveur avec Azure Arc et une règle de collecte de données.

Fichier de modèle Bicep

@description('The name of the virtual machine.')
param vmName string

@description('The name of the association.')
param associationName string

@description('The resource ID of the data collection rule.')
param dataCollectionRuleId string

resource vm 'Microsoft.HybridCompute/machines@2021-11-01' existing = {
  name: vmName
}

resource association 'Microsoft.Insights/dataCollectionRuleAssociations@2021-09-01-preview' = {
  name: associationName
  scope: vm
  properties: {
    description: 'Association of data collection rule. Deleting this association will break the data collection for this Arc server.'
    dataCollectionRuleId: dataCollectionRuleId
  }
}

Fichier de modèle ARM

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentTemplate.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vmName": {
      "type": "string",
      "metadata": {
        "description": "The name of the virtual machine."
      }
    },
    "associationName": {
      "type": "string",
      "metadata": {
        "description": "The name of the association."
      }
    },
    "dataCollectionRuleId": {
      "type": "string",
      "metadata": {
        "description": "The resource ID of the data collection rule."
      }
    }
  },
  "resources": [
    {
      "type": "Microsoft.Insights/dataCollectionRuleAssociations",
      "apiVersion": "2021-09-01-preview",
      "scope": "[format('Microsoft.HybridCompute/machines/{0}', parameters('vmName'))]",
      "name": "[parameters('associationName')]",
      "properties": {
        "description": "Association of data collection rule. Deleting this association will break the data collection for this Arc server.",
        "dataCollectionRuleId": "[parameters('dataCollectionRuleId')]"
      }
    }
  ]
}

Fichier de paramètres

{
  "$schema": "https://schema.management.azure.com/schemas/2019-04-01/deploymentParameters.json#",
  "contentVersion": "1.0.0.0",
  "parameters": {
    "vmName": {
      "value": "my-hybrid-vm"
    },
    "associationName": {
      "value": "my-windows-vm-my-dcr"
    },
    "dataCollectionRuleId": {
      "value": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/microsoft.insights/datacollectionrules/my-dcr"
    }
   }
}

Modifier une DCR

Pour modifier une DCR, vous pouvez utiliser l'une des méthodes décrites dans la section précédente pour créer une DCR à l'aide d'une version modifiée du JSON.

Si vous avez besoin de récupérer le JSON pour une DCR existante, vous pouvez le copier à partir de la Vue JSON pour la DCR dans le portail Azure. Vous pouvez également la récupérer à l'aide d'un appel d'API, comme indiqué dans l'exemple PowerShell suivant.

$ResourceId = "<ResourceId>" # Resource ID of the DCR to edit
$FilePath = "<FilePath>" # Store DCR content in this file
$DCR = Invoke-AzRestMethod -Path ("$ResourceId"+"?api-version=2022-06-01") -Method GET
$DCR.Content | ConvertFrom-Json | ConvertTo-Json -Depth 20 | Out-File -FilePath $FilePath

Pour obtenir un tutoriel qui décrit le processus de récupération et de modification d'une DCR existante, reportez-vous à Tutoriel : Modifier une règle de collecte de données (DCR).