建立和編輯 Azure 監視器中的資料收集規則 (DCR)。

發行項
04/04/2024

在 Azure 監視器中建立資料收集規則 (DCR)的方法有很多種。在某些情況下，Azure 監視器會根據您在 Azure 入口網站中設定的設定來建立和管理 DCR。在其他情況下，您可能需要建立自己的 DCR 來自定義特定案例。

本文說明建立和編輯 DCR 的不同方法。如需 DCR 本身的內容，請參閱 Azure 監視器中資料收集規則的結構。

權限

您需要下列權限才能建立 DCR 與關聯：

內建角色	範圍	原因
監視參與者	訂閱和/或資源群組和/或現有的 DCR	建立或編輯 DCR、將規則指派給計算機、部署關聯。
虛擬機器參與者 Azure Connected Machine 資源管理員	虛擬機器、虛擬機器擴展集已啟用 Azure Arc 的伺服器 (英文)	在 VM 上部署代理程式擴充功能。
包含動作 Microsoft.Resources/deployments/* 的任何角色	訂閱和/或資源群組和/或現有的 DCR	部署 Azure Resource Manager 範本。

建立 DCR 的自動化方法

下表列出使用為您建立 DCR 的 Azure 入口網站來建立資料收集案例的方法。在這些情況下，您不需要直接與 DCR 本身互動。

案例	資源	描述
Azure 監視器代理程式	設定 Azure 監視器代理程式的資料收集	使用 Azure 入口網站建立 DCR，以指定要從具有 Azure 監視器代理程式的電腦收集的事件和性能計數器。然後將該規則與一或多個虛擬機產生關聯。 Azure 監視器代理程式將會安裝在目前尚未安裝的任何機器。
	啟用 VM 深入解析的概觀	當您在 VM 上啟用 VM 深入解析時，會安裝 Azure 監視器代理程式，並建立 DCR 來收集一組預先定義的性能計數器。您不應該修改此 DCR。
容器深入解析	啟用容器深入解析	當您在 Kubernetes 叢集上啟用容器深入解析時，會安裝 Azure 監視器代理程式的容器化版本，並根據您選取的組態來建立 DCR 來收集資料。您可能需要修改此 DCR 以新增轉換。
文字或 JSON 記錄	使用 Azure 監視器代理程式收集文字或 JSON 檔案中的記錄	使用 Azure 入口網站建立 DCR，以從具有 Azure 監視器代理程式之電腦上的文字記錄檔收集項目。

手動建立 DCR

若要手動建立 DCR，請使用您要設定之資料收集的適當組態來建立 JSON 檔案。從其中一個範例 DCR 開始，使用 Azure 監視器中資料收集規則結構中的資訊，修改 JSON 檔案以符合您的特定環境和需求。

建立 JSON 檔案之後，您可以使用下列任何方法來建立 DCR：

使用 az monitor data-collection rule create 命令，使用 Azure CLI 從 JSON 檔案建立 DCR，如下範例所示。

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'

使用 New-AzDataCollectionRule Cmdlet，使用 PowerShell 從 JSON 檔案建立 DCR，如下列範例所示。

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

使用 DCR 建立 API，從 JSON 檔案建立 DCR。您可以使用任何方法來呼叫 REST API，如下列範例所示。

$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

請參閱下列參考，以定義範本中的 DCR 和關聯。

使用下列範本，使用 Azure 監視器中資料收集規則的結構和 Azure 監視器中的範例資料收集規則（DCR）中的資訊來建立 DCR，以定義 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>"
            }
        }
    ]
}

DCR 關聯 -Azure VM

下列範例會建立 Azure 虛擬機器與資料收集規則之間的關聯。

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

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')]"
      }
    }
  ]
}

參數檔案

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

DCR 關聯 -已啟用 Arc 的伺服器

下列範例會建立 Azure 已啟用 Arc 的伺服器與資料收集規則之間的關聯。

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

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')]"
      }
    }
  ]
}

參數檔案

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

編輯 DCR

若要編輯 DCR，您可以使用上一節中所述的任何方法，使用修改過的 JSON 版本來建立 DCR。

如果您需要擷取現有 DCR 的 JSON，您可以從 Azure 入口網站中 DCR 的 JSON 檢視複製。您也可以使用 API 呼叫來擷取，如下列 PowerShell 範例所示。

$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

如需逐步解說擷取和編輯現有 DCR 程式的教學課程，請參閱教學課程：編輯資料收集規則 (DCR)。