Azure Monitor でデータ収集規則 (DCR) を作成および編集する

[アーティクル]
04/11/2024

Azure Monitor でデータ収集規則 (DCR) を作成するには、複数の方法があります。場合によっては、Azure Monitor によって、Azure portal で構成した設定に従って DCR が作成および管理されます。それ以外の場合は、特定のシナリオをカスタマイズするために独自の DCR を作成する必要があります。

この記事では、DCR を作成および編集するためのさまざまな方法について説明します。 DCR 自体の内容については、「Azure Monitor のデータ収集規則の構造」を参照してください。

アクセス許可

DCR と関連付けを作成するには、次のアクセス許可が必要です。

組み込みのロール	スコープ	理由
Monitoring Contributor	サブスクリプションおよび/またはリソースグループおよび/または既存の DCR	DCR を作成または編集し、マシンにルールを割り当て、関連付けをデプロイします。
Virtual Machine Contributor Azure Connected Machine のリソース管理者	仮想マシン、仮想マシンスケールセット Azure Arc 対応サーバー	エージェント拡張機能を VM にデプロイします。
アクション Microsoft.Resources/deployments/ を含む任意のロール*	サブスクリプションおよび/またはリソースグループおよび/または既存の DCR	Azure Resource Manager テンプレートをデプロイする。

DCR を作成するための自動化されたメソッド

次の表に、DCR が作成される Azure portal を使用してデータ収集シナリオを作成する方法を示します。このような場合は、DCR 自体と直接やり取りする必要はありません。

シナリオ	リソース	説明
Azure Monitor エージェント	Azure Monitor エージェント用のデータ収集の構成	Azure portal を使って、Azure Monitor エージェントでマシンから収集するイベントとパフォーマンスカウンターを指定する DCR を作成します。次に、その規則を 1 つ以上の仮想マシンに関連付けます。 Azure Monitor エージェントが、まだインストールされていないすべてのマシンにインストールされます。
	VM insights の有効化の概要	VM で VM 分析情報を有効にすると、Azure Monitor エージェントがインストールされ、定義済みのパフォーマンスカウンターのセットを収集する DCR が作成されます。この DCR は変更しないでください。
Container insights	コンテナー分析情報を有効にする	Kubernetes クラスターで Container Insights を有効にすると、コンテナー化されたバージョンの Azure Monitor エージェントがインストールされ、選択した構成に従ってデータを収集する DCR が作成されます。変換を追加するには、この DCR の変更が必要になる場合があります。
テキストまたは JSON ログ	Azure Monitor エージェントを使用してテキストまたは JSON ファイルからログを収集する	Azure portal を使用して DCR を作成し、Azure Monitor エージェントを使用してマシン上のテキストログからエントリを収集します。

DCR を手動で作成する

DCR を手動で作成するには、構成するデータ収集に適した構成を使用して JSON ファイルを作成します。サンプル DCR の 1 つから始めて、Azure Monitor のデータ収集規則の構造に関する情報を使用して、特定の環境と要件の 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 コマンドレットを使用して、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 create 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 Monitor でのデータ収集ルールの構造」と「Azure Monitor でのデータ収集ルール (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 portal の DCR の JSON ビューからコピーできます。次の PowerShell の例に示すように、API 呼び出しを使用して取得することもできます。

$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) を編集する」を参照してください。