Criar e editar DCRs (regras de coleta de dados) no Azure Monitor

Há vários métodos para criar uma DCR (regra de coleta de dados) no Azure Monitor. Em alguns casos, o Azure Monitor irá criar e gerenciar a DCR de acordo com as configurações definidas no portal do Azure. Em outros casos, talvez seja necessário criar suas próprias DCRs para personalizar cenários específicos.

Este artigo descreve os diferentes métodos para criar e editar uma DCR. Para obter o conteúdo da própria DCR, consulte Estrutura de uma regra de coleta de dados no Azure Monitor.

Permissões

Você precisa das seguintes permissões para criar DCRs e associações:

Função interna	Escopos	Motivo
Colaborador de monitoramento	Assinatura e/ou Grupo de recursos e/ou Uma DCR existente	Crie ou edite DCRs, atribua regras ao computador, implante associações.
Colaborador de Máquina Virtual Administrador de recursos de Azure Connected Machine	Máquinas virtuais, conjuntos de dimensionamento de máquinas virtuais Servidores habilitados para Azure Arc	Implantar extensões de agente na VM.
Qualquer função que inclua a ação Microsoft.Resources/deployments/*	Assinatura e/ou Grupo de recursos e/ou Uma DCR existente	Implantar modelos do Azure Resource Manager.

Métodos automatizados para criar uma DCR

A tabela a seguir lista métodos para criar cenários de coleta de dados usando o portal do Azure em que a DCR é criada para você. Nesses casos, você não precisa interagir com a DCR.

Cenário	Recursos	Descrição
Agente do Azure Monitor	Configurar a coleta de dados para o Agente do Azure Monitor	Use o portal do Azure para criar uma DCR que especifica eventos e contadores de desempenho a serem coletados de um computador com o Agente do Azure Monitor. Em seguida, associe essa regra a uma ou mais máquinas virtuais. O Agente do Azure Monitor será instalado em qualquer máquina que não o tenha atualmente.
	Visão geral de habilitação de insights da VM	Quando você habilita insights de VM em uma VM, o agente do Azure Monitor é instalado e uma DCR que coleta um conjunto predefinido de contadores de desempenho é criada. Você não deve modificar essa DCR.
Insights do contêiner	Habilitar os Insights do contêiner	Quando você habilita insights de contêiner em um cluster do Kubernetes, uma versão em contêiner do agente do Azure Monitor é instalada e uma DCR que coleta dados de acordo com a configuração selecionada é criada. Talvez seja necessário modificar essa DCR para adicionar uma transformação.
Logs de texto ou JSON	Coletar logs de um arquivo JSON ou de texto com o Agente do Azure Monitor	Use o portal do Azure para criar uma DCR para coletar entradas de um log de texto em um computador com o Agente do Azure Monitor.

Criar uma DCR manualmente

Para criar uma DCR manualmente, crie um arquivo JSON usando a configuração apropriada para a coleta de dados que você está configurando. Comece com uma das DCRs de exemplo e use informações em Estrutura de uma regra de coleta de dados no Azure Monitor para modificar o arquivo JSON para seu ambiente e requisitos específicos.

Depois de criar o arquivo JSON, você pode usar qualquer um dos seguintes métodos para criar a DCR:

CLI

Use o comando az monitor data-collection rule create para criar uma DCR a partir do arquivo JSON usando a CLI do Azure, conforme mostrado no exemplo a seguir.

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'

PowerShell

Use o cmdlet New-AzDataCollectionRule para criar a DCR a partir do arquivo JSON usando o PowerShell, conforme mostrando no exemplo a seguir.

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

API

Use a API Criar DCR para criar a DCR a partir do arquivo JSON. Você pode usar qualquer método para chamar uma API REST, conforme mostrado nos exemplos a seguir.

$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

ARM

Consulte as referências a seguir para definir DCRs e associações em um modelo.

• Regras de coleta de dados
• Associações de regra de coleta de dados

Use o modelo a seguir para criar uma DCR usando informações da Estrutura de uma regra de coleta de dados no Azure Monitor e DCRs (regras de coleta de dados de exemplo) no Azure Monitor para definir o 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>"
            }
        }
    ]
}

Associação DCR -VM do Azure

O exemplo a seguir cria uma associação entre uma máquina virtual do Azure e uma regra de coleta de dados.

Arquivo de modelo 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
  }
}

Arquivo de modelo do 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')]"
      }
    }
  ]
}

Arquivo de parâmetros

{
  "$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"
    }
   }
}

Associação DCR - Servidor habilitado par Arc

O exemplo a seguir cria uma associação entre um servidor habilitado para o Azure Arc e uma regra de coleta de dados.

Arquivo de modelo 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
  }
}

Arquivo de modelo do 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')]"
      }
    }
  ]
}

Arquivo de parâmetros

{
  "$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"
    }
   }
}

Editar uma DCR

Para editar uma DCR, você usar qualquer um dos métodos descritos na seção anterior para criar uma DCR usando uma versão modificada do JSON.

Se você precisar recuperar o JSON para uma DCR existente, poderá copiá-lo da Exibição JSON para a DCR no portal do Azure. Você também pode recuperá-lo usando uma chamada à API, conforme mostrado no exemplo do PowerShell a seguir.

$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

Para obter um tutorial que explica o processo de recuperação e edição de uma DCR existente, consulte Tutorial: Editar uma DCR (regra de coleta de dados).

Próximas etapas

• Ler sobre a estrutura detalhada de uma regra de coleta de dados
• Obter detalhes sobre transformações em uma regra de coleta de dados