Microsoft.Insights dataCollectionRules

  • [アーティクル]

Bicep リソース定義

dataCollectionRules リソースの種類は、次をターゲットとする操作でデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Insights/dataCollectionRules リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.Insights/dataCollectionRules@2022-06-01' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  identity: {
    type: 'string'
    userAssignedIdentities: {}
  }
  properties: {
    dataCollectionEndpointId: 'string'
    dataFlows: [
      {
        builtInTransform: 'string'
        destinations: [
          'string'
        ]
        outputStream: 'string'
        streams: [
          'string'
        ]
        transformKql: 'string'
      }
    ]
    dataSources: {
      dataImports: {
        eventHub: {
          consumerGroup: 'string'
          name: 'string'
          stream: 'string'
        }
      }
      extensions: [
        {
          extensionName: 'string'
          extensionSettings: any()
          inputDataSources: [
            'string'
          ]
          name: 'string'
          streams: [
            'string'
          ]
        }
      ]
      iisLogs: [
        {
          logDirectories: [
            'string'
          ]
          name: 'string'
          streams: [
            'string'
          ]
        }
      ]
      logFiles: [
        {
          filePatterns: [
            'string'
          ]
          format: 'text'
          name: 'string'
          settings: {
            text: {
              recordStartTimestampFormat: 'string'
            }
          }
          streams: [
            'string'
          ]
        }
      ]
      performanceCounters: [
        {
          counterSpecifiers: [
            'string'
          ]
          name: 'string'
          samplingFrequencyInSeconds: int
          streams: [
            'string'
          ]
        }
      ]
      platformTelemetry: [
        {
          name: 'string'
          streams: [
            'string'
          ]
        }
      ]
      prometheusForwarder: [
        {
          labelIncludeFilter: {}
          name: 'string'
          streams: 'Microsoft-PrometheusMetrics'
        }
      ]
      syslog: [
        {
          facilityNames: [
            'string'
          ]
          logLevels: [
            'string'
          ]
          name: 'string'
          streams: 'Microsoft-Syslog'
        }
      ]
      windowsEventLogs: [
        {
          name: 'string'
          streams: [
            'string'
          ]
          xPathQueries: [
            'string'
          ]
        }
      ]
      windowsFirewallLogs: [
        {
          name: 'string'
          streams: [
            'string'
          ]
        }
      ]
    }
    description: 'string'
    destinations: {
      azureMonitorMetrics: {
        name: 'string'
      }
      eventHubs: [
        {
          eventHubResourceId: 'string'
          name: 'string'
        }
      ]
      eventHubsDirect: [
        {
          eventHubResourceId: 'string'
          name: 'string'
        }
      ]
      logAnalytics: [
        {
          name: 'string'
          workspaceResourceId: 'string'
        }
      ]
      monitoringAccounts: [
        {
          accountResourceId: 'string'
          name: 'string'
        }
      ]
      storageAccounts: [
        {
          containerName: 'string'
          name: 'string'
          storageAccountResourceId: 'string'
        }
      ]
      storageBlobsDirect: [
        {
          containerName: 'string'
          name: 'string'
          storageAccountResourceId: 'string'
        }
      ]
      storageTablesDirect: [
        {
          name: 'string'
          storageAccountResourceId: 'string'
          tableName: 'string'
        }
      ]
    }
    streamDeclarations: {}
  }
}

プロパティ値

dataCollectionRules

名前 説明 値
name リソース名 string (必須)
location リソースが保存されている地理的な場所。 string (必須)
tags リソース タグ。 タグの名前と値のディクショナリ。 「テンプレート内のタグ」を参照してください
kind リソースの種類。 'Linux'
'Windows'
identity リソースのマネージド サービス ID。 DataCollectionRuleResourceIdentity
properties リソースのプロパティ。 DataCollectionRuleResourceProperties

DataCollectionRuleResourceIdentity

名前 説明 値
type マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (必須)
userAssignedIdentities リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求で空のオブジェクト ({}) にすることができます。 object

DataCollectionRuleResourceProperties

名前 説明 値
dataCollectionEndpointId このルールを使用できるデータ収集エンドポイントのリソース ID。 string
dataFlows データ フローの仕様。 DataFlow[]
dataSources データ ソースの仕様。
このプロパティは省略可能であり、規則がプロビジョニングされたエンドポイントへの直接呼び出しで使用されることを意図している場合は省略できます。		 DataCollectionRuleDataSources
description データ収集ルールの説明。 string
destinations 変換先の指定。 DataCollectionRuleDestinations
streamDeclarations この規則で使用されるカスタム ストリームの宣言。 object

データフロー

名前 説明 値
builtInTransform ストリーム データを変換するための builtIn 変換 string
destinations このデータ フローの宛先の一覧。 string[]
outputStream 変換の出力ストリーム。 変換によってデータが別のストリームに変更される場合にのみ必要です。 string
ストリーム このデータ フローのストリームの一覧。 次のいずれかを含む文字列配列:
'Microsoft-Event'
'Microsoft-InsightsMetrics'
'Microsoft-Perf'
'Microsoft-Syslog'
'Microsoft-WindowsEvent'
transformKql ストリーム データを変換する KQL クエリ。 string

DataCollectionRuleDataSources

名前 説明 値
dataImports プル ベースのデータ ソースの仕様 DataSourcesSpecDataImports
拡張機能 Azure VM 拡張機能のデータ ソース構成の一覧。 ExtensionDataSource[]
iisLogs IIS ログのソース構成の一覧。 IisLogsDataSource[]
logFiles ログ ファイルのソース構成の一覧。 LogFilesDataSource[]
performanceCounters パフォーマンス カウンター データ ソース構成の一覧。 PerfCounterDataSource[]
platformTelemetry プラットフォーム テレメトリ構成の一覧 PlatformTelemetryDataSource[]
prometheusForwarder Prometheus フォワーダー データ ソース構成の一覧。 PrometheusForwarderDataSource[]
syslog Syslog データ ソース構成の一覧。 SyslogDataSource[]
windowsEventLogs Windows イベント ログ データ ソースの構成の一覧。 WindowsEventLogDataSource[]
windowsFirewallLogs Windows ファイアウォールログのソース構成の一覧。 WindowsFirewallLogsDataSource[]

DataSourcesSpecDataImports

名前 説明 値
eventHub イベント ハブ構成の定義。 DataImportSourcesEventHub

DataImportSourcesEventHub

名前 説明 値
consumerGroup Event Hub コンシューマー グループ名 string
name データ ソースのフレンドリ名。
この名前は、データ収集ルール内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。		 string
ストリーム (stream) EventHub から収集するストリーム string

ExtensionDataSource

名前 説明 値
extensionName VM 拡張機能の名前。 string (必須)
extensionSettings 拡張機能の設定。 この形式は、特定の拡張機能に固有です。 Bicep の場合は、 any() 関数を使用できます。
inputDataSources この拡張機能に必要なデータ ソースの一覧。 string[]
name データ ソースのフレンドリ名。
この名前は、データ収集ルール内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。		 string
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics 内のテーブルを示します。
 次のいずれかを含む文字列配列:
'Microsoft-Event'
'Microsoft-InsightsMetrics'
'Microsoft-Perf'
'Microsoft-Syslog'
'Microsoft-WindowsEvent'

IisLogsDataSource

名前 説明 値
logDirectories 絶対パス ファイルの場所 string[]
name データ ソースのフレンドリ名。
この名前は、データ収集ルール内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。		 string
ストリーム IIS ストリーム string[] (必須)

LogFilesDataSource

名前 説明 値
filePatterns ログ ファイルが配置されているファイル パターン string[] (必須)
format ログ ファイルのデータ形式 'text' (必須)
name データ ソースのフレンドリ名。
この名前は、データ収集ルール内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。		 string
settings ログ ファイル固有の設定。 LogFilesDataSourceSettings
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータ ソースに使用されるスキーマを示します
 string[] (必須)

LogFilesDataSourceSettings

名前 説明 値
text テキストの設定 LogFileSettingsText

LogFileSettingsText

名前 説明 値
recordStartTimestampFormat MM:SS AM/PM' , 'MMM d hh:mm:ss' , 'Mon DD, YYYY HH:MM:SS' , 'YYYY-MM-DD HH:MM:SS' , 'dd/MMM/yyyy:HH:mm:ss zzz' , 'ddMMyy HH:mm:ss' , 'yyMMdd HH:mm:ss' , 'yyyy-MM-ddTHH:mm:ssK' , string (必須): サポートされているタイムスタンプ形式の 1 つ 'ISO 8601'
'M/D/YYYY HH (必須)

PerfCounterDataSource

名前 説明 値
counterSpecifiers 収集するパフォーマンス カウンターの指定子名の一覧。
ワイルドカード (*) を使用して、すべてのインスタンスのカウンターを収集します。
Windows でパフォーマンス カウンターの一覧を取得するには、コマンド 'typeperf' を実行します。		 string[]
name データ ソースのフレンドリ名。
この名前は、データ収集ルール内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。		 string
samplingFrequencyInSeconds 連続するカウンター測定 (サンプル) 間の秒数。 INT
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics 内のテーブルを示します。
 次のいずれかを含む文字列配列:
'Microsoft-InsightsMetrics'
'Microsoft-Perf'

PlatformTelemetryDataSource

名前 説明 値
name データ ソースのフレンドリ名。
この名前は、データ収集ルール内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。		 string
ストリーム 収集するプラットフォーム テレメトリ ストリームの一覧 string[] (必須)

PrometheusForwarderDataSource

名前 説明 値
labelIncludeFilter ラベル "name-value" ペアの形式のラベル包含フィルターの一覧。
現在、"microsoft_metrics_include_label" というラベルは 1 つだけサポートされています。
ラベルの値は大文字と小文字を区別せずに照合されます。		 object
name データ ソースのフレンドリ名。
この名前は、データ収集ルール内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。		 string
ストリーム このデータ ソースが送信されるストリームの一覧。 次のいずれかを含む文字列配列:
'Microsoft-PrometheusMetrics'

SyslogDataSource

名前 説明 値
facilityNames 施設名の一覧。 次のいずれかを含む文字列配列:
'*'
'auth'
'authpriv'
'cron'
'daemon'
'kern'
'local0'
'local1'
'local2'
'local3'
'local4'
'local5'
'local6'
'local7'
'lpr'
'mail'
'mark'
'news'
'syslog'
'user'
'uucp'
logLevels 収集するログ レベル。 次のいずれかを含む文字列配列:
'*'
'Alert'
'Critical'
'Debug'
'緊急'
'Error'
'Info'
'注意'
'警告'
name データ ソースのフレンドリ名。
この名前は、データ収集ルール内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。		 string
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics 内のテーブルを示します。
 次のいずれかを含む文字列配列:
'Microsoft-Syslog'

WindowsEventLogDataSource

名前 説明 値
name データ ソースのフレンドリ名。
この名前は、データ収集ルール内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。		 string
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics 内のテーブルを示します。		 次のいずれかを含む文字列配列:
'Microsoft-Event'
'Microsoft-WindowsEvent'
xPathQueries XPATH 形式の Windows イベント ログ クエリの一覧。 string[]

WindowsFirewallLogsDataSource

名前 説明 値
name データ ソースのフレンドリ名。
この名前は、データ収集ルール内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。		 string
ストリーム ファイアウォール ログ ストリーム string[] (必須)

DataCollectionRuleDestinations

名前 説明 値
azureMonitorMetrics Azure Monitor メトリックの宛先。 DestinationsSpecAzureMonitorMetrics
eventHubs Event Hubs の宛先の一覧。 EventHubDestination[]
eventHubsDirect Event Hubs Direct の宛先の一覧。 EventHubDirectDestination[]
logAnalytics Log Analytics の宛先の一覧。 LogAnalyticsDestination[]
monitoringAccounts 監視アカウントの宛先の一覧。 MonitoringAccountDestination[]
storageAccounts ストレージ アカウントの宛先の一覧。 StorageBlobDestination[]
storageBlobsDirect ストレージ BLOB ダイレクトの宛先の一覧。 エージェントから格納するデータを直接送信する場合にのみ使用します。 StorageBlobDestination[]
storageTablesDirect ストレージ テーブル ダイレクトの宛先の一覧。 StorageTableDestination[]

DestinationsSpecAzureMonitorMetrics

名前 説明 値
name 宛先のフレンドリ名。
この名前は、データ収集ルール内のすべての宛先 (種類に関係なく) で一意である必要があります。
 string

EventHubDestination

名前 説明 値
eventHubResourceId イベント ハブのリソース ID。 string
name 宛先のフレンドリ名。
この名前は、データ収集ルール内のすべての宛先 (種類に関係なく) で一意である必要があります。
 string

EventHubDirectDestination

名前 説明 値
eventHubResourceId イベント ハブのリソース ID。 string
name 宛先のフレンドリ名。
この名前は、データ収集ルール内のすべての宛先 (種類に関係なく) で一意である必要があります。
 string

LogAnalyticsDestination

名前 説明 値
name 宛先のフレンドリ名。
この名前は、データ収集ルール内のすべての宛先 (種類に関係なく) で一意である必要があります。		 string
workspaceResourceId Log Analytics ワークスペースのリソース ID。 string

MonitoringAccountDestination

名前 説明 値
accountResourceId 監視アカウントのリソース ID。 string
name 宛先のフレンドリ名。
この名前は、データ収集ルール内のすべての宛先 (種類に関係なく) で一意である必要があります。
 string

StorageBlobDestination

名前 説明 値
containerName ストレージ BLOB のコンテナー名。 string
name 宛先のフレンドリ名。
この名前は、データ収集ルール内のすべての宛先 (種類に関係なく) で一意である必要があります。		 string
storageAccountResourceId ストレージ アカウントのリソース ID。 string

StorageTableDestination

名前 説明 値
name 宛先のフレンドリ名。
この名前は、データ収集ルール内のすべての宛先 (種類に関係なく) で一意である必要があります。		 string
storageAccountResourceId ストレージ アカウントのリソース ID。 string
tableName ストレージ テーブルの名前。 string

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
Syslog のデータ収集規則

Azure にデプロイする		 このテンプレートでは、データ ソース (Syslog) と宛先ワークスペースを定義するデータ収集規則を作成します。

ARM テンプレート リソース定義

dataCollectionRules リソースの種類は、次を対象とする操作と共にデプロイできます。

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Insights/dataCollectionRules リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.Insights/dataCollectionRules",
  "apiVersion": "2022-06-01",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {}
  },
  "properties": {
    "dataCollectionEndpointId": "string",
    "dataFlows": [
      {
        "builtInTransform": "string",
        "destinations": [ "string" ],
        "outputStream": "string",
        "streams": [ "string" ],
        "transformKql": "string"
      }
    ],
    "dataSources": {
      "dataImports": {
        "eventHub": {
          "consumerGroup": "string",
          "name": "string",
          "stream": "string"
        }
      },
      "extensions": [
        {
          "extensionName": "string",
          "extensionSettings": {},
          "inputDataSources": [ "string" ],
          "name": "string",
          "streams": [ "string" ]
        }
      ],
      "iisLogs": [
        {
          "logDirectories": [ "string" ],
          "name": "string",
          "streams": [ "string" ]
        }
      ],
      "logFiles": [
        {
          "filePatterns": [ "string" ],
          "format": "text",
          "name": "string",
          "settings": {
            "text": {
              "recordStartTimestampFormat": "string"
            }
          },
          "streams": [ "string" ]
        }
      ],
      "performanceCounters": [
        {
          "counterSpecifiers": [ "string" ],
          "name": "string",
          "samplingFrequencyInSeconds": "int",
          "streams": [ "string" ]
        }
      ],
      "platformTelemetry": [
        {
          "name": "string",
          "streams": [ "string" ]
        }
      ],
      "prometheusForwarder": [
        {
          "labelIncludeFilter": {},
          "name": "string",
          "streams": "Microsoft-PrometheusMetrics"
        }
      ],
      "syslog": [
        {
          "facilityNames": [ "string" ],
          "logLevels": [ "string" ],
          "name": "string",
          "streams": "Microsoft-Syslog"
        }
      ],
      "windowsEventLogs": [
        {
          "name": "string",
          "streams": [ "string" ],
          "xPathQueries": [ "string" ]
        }
      ],
      "windowsFirewallLogs": [
        {
          "name": "string",
          "streams": [ "string" ]
        }
      ]
    },
    "description": "string",
    "destinations": {
      "azureMonitorMetrics": {
        "name": "string"
      },
      "eventHubs": [
        {
          "eventHubResourceId": "string",
          "name": "string"
        }
      ],
      "eventHubsDirect": [
        {
          "eventHubResourceId": "string",
          "name": "string"
        }
      ],
      "logAnalytics": [
        {
          "name": "string",
          "workspaceResourceId": "string"
        }
      ],
      "monitoringAccounts": [
        {
          "accountResourceId": "string",
          "name": "string"
        }
      ],
      "storageAccounts": [
        {
          "containerName": "string",
          "name": "string",
          "storageAccountResourceId": "string"
        }
      ],
      "storageBlobsDirect": [
        {
          "containerName": "string",
          "name": "string",
          "storageAccountResourceId": "string"
        }
      ],
      "storageTablesDirect": [
        {
          "name": "string",
          "storageAccountResourceId": "string",
          "tableName": "string"
        }
      ]
    },
    "streamDeclarations": {}
  }
}

プロパティ値

dataCollectionRules

名前 説明 値
type リソースの種類 'Microsoft.Insights/dataCollectionRules'
apiVersion リソース API のバージョン '2022-06-01'
name リソース名 string (必須)
location リソースが保存されている地理的な場所。 string (必須)
tags リソース タグ。 タグ名と値のディクショナリ。 「テンプレートのタグ」を参照してください
kind リソースの種類。 'Linux'
'Windows'
identity リソースのマネージド サービス ID。 DataCollectionRuleResourceIdentity
properties リソースのプロパティ。 DataCollectionRuleResourceProperties

DataCollectionRuleResourceIdentity

名前 説明 値
type マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 'None'
'SystemAssigned'
'SystemAssigned,UserAssigned'
'UserAssigned' (必須)
userAssignedIdentities リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値には、要求で空のオブジェクト ({}) を指定できます。 object

DataCollectionRuleResourceProperties

名前 説明 値
dataCollectionEndpointId この規則で使用できるデータ収集エンドポイントのリソース ID。 string
dataFlows データ フローの仕様。 DataFlow[]
dataSources データ ソースの仕様。
このプロパティは省略可能であり、規則がプロビジョニングされたエンドポイントへの直接呼び出しで使用されることを意図している場合は省略できます。		 DataCollectionRuleDataSources
description データ収集ルールの説明。 string
destinations 変換先の指定。 DataCollectionRuleDestinations
streamDeclarations この規則で使用されるカスタム ストリームの宣言。 object

データフロー

名前 説明 値
builtInTransform ストリーム データを変換するための builtIn 変換 string
destinations このデータ フローの宛先の一覧。 string[]
outputStream 変換の出力ストリーム。 変換によってデータが別のストリームに変更される場合にのみ必要です。 string
ストリーム このデータ フローのストリームの一覧。 次のいずれかを含む文字列配列:
'Microsoft-Event'
'Microsoft-InsightsMetrics'
'Microsoft-Perf'
'Microsoft-Syslog'
'Microsoft-WindowsEvent'
transformKql ストリーム データを変換する KQL クエリ。 string

DataCollectionRuleDataSources

名前 説明 値
dataImports プル ベースのデータ ソースの仕様 DataSourcesSpecDataImports
拡張機能 Azure VM 拡張機能のデータ ソース構成の一覧。 ExtensionDataSource[]
iisLogs IIS ログのソース構成の一覧。 IisLogsDataSource[]
logFiles ログ ファイルのソース構成の一覧。 LogFilesDataSource[]
performanceCounters パフォーマンス カウンター データ ソース構成の一覧。 PerfCounterDataSource[]
platformTelemetry プラットフォーム テレメトリ構成の一覧 PlatformTelemetryDataSource[]
prometheusForwarder Prometheus フォワーダー データ ソース構成の一覧。 PrometheusForwarderDataSource[]
syslog Syslog データ ソース構成の一覧。 SyslogDataSource[]
windowsEventLogs Windows イベント ログ データ ソース構成の一覧。 WindowsEventLogDataSource[]
windowsFirewallLogs Windows ファイアウォール ログのソース構成の一覧。 WindowsFirewallLogsDataSource[]

DataSourcesSpecDataImports

名前 説明 値
eventHub イベント ハブ構成の定義。 DataImportSourcesEventHub

DataImportSourcesEventHub

名前 説明 値
consumerGroup Event Hub コンシューマー グループ名 string
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム (stream) EventHub から収集するストリーム string

ExtensionDataSource

名前 説明 値
extensionName VM 拡張機能の名前。 string (必須)
extensionSettings 拡張機能の設定。 この形式は、特定の拡張機能に固有です。
inputDataSources この拡張機能に必要なデータ ソースの一覧。 string[]
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。
 次のいずれかを含む文字列配列:
'Microsoft-Event'
'Microsoft-InsightsMetrics'
'Microsoft-Perf'
'Microsoft-Syslog'
'Microsoft-WindowsEvent'

IisLogsDataSource

名前 説明 値
logDirectories 絶対パス ファイルの場所 string[]
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム IIS ストリーム string[] (必須)

LogFilesDataSource

名前 説明 値
filePatterns ログ ファイルが配置されているファイル パターン string[] (必須)
format ログ ファイルのデータ形式 'text' (必須)
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
settings ログ ファイル固有の設定。 LogFilesDataSourceSettings
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータ ソースに使用されるスキーマを示します
 string[] (必須)

LogFilesDataSourceSettings

名前 説明 値
text テキストの設定 LogFileSettingsText

LogFileSettingsText

名前 説明 値
recordStartTimestampFormat MM:SS AM/PM' , 'MMM d hh:mm:ss' , 'Mon DD, YYYY HH:MM:SS' , 'YYYY-MM-DD HH:MM:SS' , 'dd/MMM/yyyy:HH:mm:ss zzz' , 'ddMMyy HH:mm:ss' , 'yyMMdd HH:mm:ss' , 'yyyy-MM-ddTHH:mm:ssK' , string (必須): サポートされているタイムスタンプ形式の 1 つ 'ISO 8601'
'M/D/YYYY HH (必須)

PerfCounterDataSource

名前 説明 値
counterSpecifiers 収集するパフォーマンス カウンターの指定子名の一覧。
ワイルドカード (*) を使用して、すべてのインスタンスのカウンターを収集します。
Windows でパフォーマンス カウンターの一覧を取得するには、コマンド 'typeperf' を実行します。		 string[]
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
samplingFrequencyInSeconds 連続するカウンター測定 (サンプル) の間の秒数。 INT
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。
 次のいずれかを含む文字列配列:
'Microsoft-InsightsMetrics'
'Microsoft-Perf'

PlatformTelemetryDataSource

名前 説明 値
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム 収集するプラットフォーム テレメトリ ストリームの一覧 string[] (必須)

PrometheusForwarderDataSource

名前 説明 値
labelIncludeFilter ラベル "name-value" ペアの形式のラベル包含フィルターの一覧。
現在サポートされているラベルは 1 つだけです:'microsoft_metrics_include_label'。
ラベルの値は大文字と小文字が区別されずに一致します。		 object
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム このデータ ソースが送信されるストリームの一覧。 次のいずれかを含む文字列配列:
'Microsoft-PrometheusMetrics'

SyslogDataSource

名前 説明 値
facilityNames 施設名の一覧。 次のいずれかを含む文字列配列:
'*'
'auth'
'authpriv'
'cron'
'daemon'
'kern'
'local0'
'local1'
'local2'
'local3'
'local4'
'local5'
'local6'
'local7'
'lpr'
'mail'
'mark'
'news'
'syslog'
'user'
'uucp'
logLevels 収集するログ レベル。 次のいずれかを含む文字列配列:
'*'
'Alert'
'Critical'
'Debug'
'緊急'
'Error'
'Info'
'Notice'
'警告'
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。
 次のいずれかを含む文字列配列:
'Microsoft-Syslog'

WindowsEventLogDataSource

名前 説明 値
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。		 次のいずれかを含む文字列配列:
'Microsoft-Event'
'Microsoft-WindowsEvent'
xPathQueries XPATH 形式の Windows イベント ログ クエリの一覧。 string[]

WindowsFirewallLogsDataSource

名前 説明 値
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム ファイアウォール ログ ストリーム string[] (必須)

DataCollectionRuleDestinations

名前 説明 値
azureMonitorMetrics Azure Monitor メトリックの宛先。 DestinationsSpecAzureMonitorMetrics
eventHubs Event Hubs の宛先の一覧。 EventHubDestination[]
eventHubsDirect Event Hubs Direct の宛先の一覧。 EventHubDirectDestination[]
logAnalytics Log Analytics の宛先の一覧。 LogAnalyticsDestination[]
monitoringAccounts 監視アカウントの宛先の一覧。 MonitoringAccountDestination[]
storageAccounts ストレージ アカウントの宛先の一覧。 StorageBlobDestination[]
storageBlobsDirect ストレージ BLOB ダイレクトの宛先の一覧。 エージェントから格納するデータを直接送信する場合にのみ使用されます。 StorageBlobDestination[]
storageTablesDirect ストレージ テーブル ダイレクトの宛先の一覧。 StorageTableDestination[]

DestinationsSpecAzureMonitorMetrics

名前 説明 値
name 宛先のフレンドリ名。
この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。
 string

EventHubDestination

名前 説明 値
eventHubResourceId イベント ハブのリソース ID。 string
name 宛先のフレンドリ名。
この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。
 string

EventHubDirectDestination

名前 説明 値
eventHubResourceId イベント ハブのリソース ID。 string
name 宛先のフレンドリ名。
この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。
 string

LogAnalyticsDestination

名前 説明 値
name 宛先のフレンドリ名。
この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。		 string
workspaceResourceId Log Analytics ワークスペースのリソース ID。 string

MonitoringAccountDestination

名前 説明 値
accountResourceId 監視アカウントのリソース ID。 string
name 宛先のフレンドリ名。
この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。
 string

StorageBlobDestination

名前 説明 値
containerName ストレージ BLOB のコンテナー名。 string
name 宛先のフレンドリ名。
この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。		 string
storageAccountResourceId ストレージ アカウントのリソース ID。 string

StorageTableDestination

名前 説明 値
name 宛先のフレンドリ名。
この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。		 string
storageAccountResourceId ストレージ アカウントのリソース ID。 string
tableName ストレージ テーブルの名前。 string

クイック スタート テンプレート

次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。

Template 説明
Syslog のデータ収集規則

Azure にデプロイする		 このテンプレートは、データ ソース (Syslog) と宛先ワークスペースを定義するデータ収集規則を作成します。

Terraform (AzAPI プロバイダー) リソース定義

dataCollectionRules リソースの種類は、次をターゲットとする操作でデプロイできます。

  • リソース グループ

各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。

リソース形式

Microsoft.Insights/dataCollectionRules リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/dataCollectionRules@2022-06-01"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  identity {
    type = "string"
    identity_ids = []
  }
  body = jsonencode({
    properties = {
      dataCollectionEndpointId = "string"
      dataFlows = [
        {
          builtInTransform = "string"
          destinations = [
            "string"
          ]
          outputStream = "string"
          streams = [
            "string"
          ]
          transformKql = "string"
        }
      ]
      dataSources = {
        dataImports = {
          eventHub = {
            consumerGroup = "string"
            name = "string"
            stream = "string"
          }
        }
        extensions = [
          {
            extensionName = "string"
            inputDataSources = [
              "string"
            ]
            name = "string"
            streams = [
              "string"
            ]
          }
        ]
        iisLogs = [
          {
            logDirectories = [
              "string"
            ]
            name = "string"
            streams = [
              "string"
            ]
          }
        ]
        logFiles = [
          {
            filePatterns = [
              "string"
            ]
            format = "text"
            name = "string"
            settings = {
              text = {
                recordStartTimestampFormat = "string"
              }
            }
            streams = [
              "string"
            ]
          }
        ]
        performanceCounters = [
          {
            counterSpecifiers = [
              "string"
            ]
            name = "string"
            samplingFrequencyInSeconds = int
            streams = [
              "string"
            ]
          }
        ]
        platformTelemetry = [
          {
            name = "string"
            streams = [
              "string"
            ]
          }
        ]
        prometheusForwarder = [
          {
            labelIncludeFilter = {}
            name = "string"
            streams = "Microsoft-PrometheusMetrics"
          }
        ]
        syslog = [
          {
            facilityNames = [
              "string"
            ]
            logLevels = [
              "string"
            ]
            name = "string"
            streams = "Microsoft-Syslog"
          }
        ]
        windowsEventLogs = [
          {
            name = "string"
            streams = [
              "string"
            ]
            xPathQueries = [
              "string"
            ]
          }
        ]
        windowsFirewallLogs = [
          {
            name = "string"
            streams = [
              "string"
            ]
          }
        ]
      }
      description = "string"
      destinations = {
        azureMonitorMetrics = {
          name = "string"
        }
        eventHubs = [
          {
            eventHubResourceId = "string"
            name = "string"
          }
        ]
        eventHubsDirect = [
          {
            eventHubResourceId = "string"
            name = "string"
          }
        ]
        logAnalytics = [
          {
            name = "string"
            workspaceResourceId = "string"
          }
        ]
        monitoringAccounts = [
          {
            accountResourceId = "string"
            name = "string"
          }
        ]
        storageAccounts = [
          {
            containerName = "string"
            name = "string"
            storageAccountResourceId = "string"
          }
        ]
        storageBlobsDirect = [
          {
            containerName = "string"
            name = "string"
            storageAccountResourceId = "string"
          }
        ]
        storageTablesDirect = [
          {
            name = "string"
            storageAccountResourceId = "string"
            tableName = "string"
          }
        ]
      }
      streamDeclarations = {}
    }
    kind = "string"
  })
}

プロパティ値

dataCollectionRules

名前 説明 値
type リソースの種類 "Microsoft.Insights/dataCollectionRules@2022-06-01"
name リソース名 string (必須)
location リソースが保存されている地理的な場所。 string (必須)
parent_id リソース グループにデプロイするには、そのリソース グループの ID を使用します。 string (必須)
tags リソース タグ。 タグの名前と値のディクショナリ。
kind リソースの種類。 "Linux"
"Windows"
identity リソースのマネージド サービス ID。 DataCollectionRuleResourceIdentity
properties リソースのプロパティ。 DataCollectionRuleResourceProperties

DataCollectionRuleResourceIdentity

名前 説明 値
type マネージド サービス ID の種類 (SystemAssigned 型と UserAssigned 型の両方が許可されます)。 "SystemAssigned"
"SystemAssigned,UserAssigned"
"UserAssigned" (必須)
identity_ids リソースに関連付けられているユーザー割り当て ID のセット。 userAssignedIdentities ディクショナリ キーは、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName} という形式の ARM リソース ID になります。 ディクショナリ値は、要求で空のオブジェクト ({}) にすることができます。 ユーザー ID ID の配列。

DataCollectionRuleResourceProperties

名前 説明 値
dataCollectionEndpointId この規則で使用できるデータ収集エンドポイントのリソース ID。 string
dataFlows データ フローの仕様。 DataFlow[]
dataSources データ ソースの仕様。
このプロパティは省略可能であり、規則がプロビジョニングされたエンドポイントへの直接呼び出しで使用されることを意図している場合は省略できます。		 DataCollectionRuleDataSources
description データ収集ルールの説明。 string
destinations 変換先の指定。 DataCollectionRuleDestinations
streamDeclarations この規則で使用されるカスタム ストリームの宣言。 object

データフロー

名前 説明 値
builtInTransform ストリーム データを変換するための builtIn 変換 string
destinations このデータ フローの宛先の一覧。 string[]
outputStream 変換の出力ストリーム。 変換によってデータが別のストリームに変更される場合にのみ必要です。 string
ストリーム このデータ フローのストリームの一覧。 次のいずれかを含む文字列配列:
"Microsoft-Event"
"Microsoft-InsightsMetrics"
"Microsoft-Perf"
"Microsoft-Syslog"
"Microsoft-WindowsEvent"
transformKql ストリーム データを変換する KQL クエリ。 string

DataCollectionRuleDataSources

名前 説明 値
dataImports プル ベースのデータ ソースの仕様 DataSourcesSpecDataImports
拡張機能 Azure VM 拡張機能のデータ ソース構成の一覧。 ExtensionDataSource[]
iisLogs IIS ログのソース構成の一覧。 IisLogsDataSource[]
logFiles ログ ファイルのソース構成の一覧。 LogFilesDataSource[]
performanceCounters パフォーマンス カウンター データ ソース構成の一覧。 PerfCounterDataSource[]
platformTelemetry プラットフォーム テレメトリ構成の一覧 PlatformTelemetryDataSource[]
prometheusForwarder Prometheus フォワーダー データ ソース構成の一覧。 PrometheusForwarderDataSource[]
syslog Syslog データ ソース構成の一覧。 SyslogDataSource[]
windowsEventLogs Windows イベント ログ データ ソースの構成の一覧。 WindowsEventLogDataSource[]
windowsFirewallLogs Windows ファイアウォールログのソース構成の一覧。 WindowsFirewallLogsDataSource[]

DataSourcesSpecDataImports

名前 説明 値
eventHub イベント ハブ構成の定義。 DataImportSourcesEventHub

DataImportSourcesEventHub

名前 説明 値
consumerGroup Event Hub コンシューマー グループ名 string
name データ ソースのフレンドリ名。
この名前は、データ収集ルール内のすべてのデータ ソース (種類に関係なく) で一意である必要があります。		 string
ストリーム (stream) EventHub から収集するストリーム string

ExtensionDataSource

名前 説明 値
extensionName VM 拡張機能の名前。 string (必須)
extensionSettings 拡張機能の設定。 この形式は、特定の拡張機能に固有です。
inputDataSources この拡張機能に必要なデータ ソースの一覧。 string[]
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。
 次のいずれかを含む文字列配列:
"Microsoft-Event"
"Microsoft-InsightsMetrics"
"Microsoft-Perf"
"Microsoft-Syslog"
"Microsoft-WindowsEvent"

IisLogsDataSource

名前 説明 値
logDirectories 絶対パス ファイルの場所 string[]
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム IIS ストリーム string[] (必須)

LogFilesDataSource

名前 説明 値
filePatterns ログ ファイルが配置されているファイル パターン string[] (必須)
format ログ ファイルのデータ形式 "text" (必須)
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
settings ログ ファイル固有の設定。 LogFilesDataSourceSettings
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータ ソースに使用されるスキーマを示します
 string[] (必須)

LogFilesDataSourceSettings

名前 説明 値
text テキストの設定 LogFileSettingsText

LogFileSettingsText

名前 説明 値
recordStartTimestampFormat MM:SS AM/PM' , 'MMM d hh:mm:ss' , 'Mon DD, YYYY HH:MM:SS' , 'YYYY-MM-DD HH:MM:SS' , 'dd/MMM/yyyy:HH:mm:ss zzz' , 'ddMMyy HH:mm:ss' , 'yyMMdd HH:mm:ss' , 'yyyy-MM-ddTHH:mm:ssK' , string (必須): サポートされているタイムスタンプ形式の 1 つ "ISO 8601"
"M/D/YYYY HH (必須)

PerfCounterDataSource

名前 説明 値
counterSpecifiers 収集するパフォーマンス カウンターの指定子名の一覧。
ワイルドカード (*) を使用して、すべてのインスタンスのカウンターを収集します。
Windows でパフォーマンス カウンターの一覧を取得するには、コマンド 'typeperf' を実行します。		 string[]
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
samplingFrequencyInSeconds 連続するカウンター測定 (サンプル) の間の秒数。 INT
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。
 次のいずれかを含む文字列配列:
"Microsoft-InsightsMetrics"
"Microsoft-Perf"

PlatformTelemetryDataSource

名前 説明 値
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム 収集するプラットフォーム テレメトリ ストリームの一覧 string[] (必須)

PrometheusForwarderDataSource

名前 説明 値
labelIncludeFilter ラベル "name-value" ペアの形式のラベル包含フィルターの一覧。
現在サポートされているラベルは 1 つだけです:'microsoft_metrics_include_label'。
ラベルの値は大文字と小文字が区別されずに一致します。		 object
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム このデータ ソースが送信されるストリームの一覧。 次のいずれかを含む文字列配列:
"Microsoft-PrometheusMetrics"

SyslogDataSource

名前 説明 値
facilityNames 施設名の一覧。 次のいずれかを含む文字列配列:
"*"
"auth"
"authpriv"
"cron"
"daemon"
"kern"
"local0"
"local1"
"local2"
"local3"
"local4"
"local5"
"local6"
"local7"
"lpr"
"mail"
"mark"
"news"
"syslog"
"user"
"uucp"
logLevels 収集するログ レベル。 次のいずれかを含む文字列配列:
"*"
"アラート"
"Critical"
"デバッグ"
"緊急"
"エラー"
"Info"
"注意"
"Warning"
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。
 次のいずれかを含む文字列配列:
"Microsoft-Syslog"

WindowsEventLogDataSource

名前 説明 値
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム このデータ ソースが送信されるストリームの一覧。
ストリームは、このデータに使用されるスキーマと、通常、データの送信先となる Log Analytics のテーブルを示します。		 次のいずれかを含む文字列配列:
"Microsoft-Event"
"Microsoft-WindowsEvent"
xPathQueries XPATH 形式の Windows イベント ログ クエリの一覧。 string[]

WindowsFirewallLogsDataSource

名前 説明 値
name データ ソースのフレンドリ名。
この名前は、データ収集規則内のすべてのデータ ソース (型に関係なく) で一意である必要があります。		 string
ストリーム ファイアウォール ログ ストリーム string[] (必須)

DataCollectionRuleDestinations

名前 説明 値
azureMonitorMetrics Azure Monitor メトリックの宛先。 DestinationsSpecAzureMonitorMetrics
eventHubs Event Hubs の宛先の一覧。 EventHubDestination[]
eventHubsDirect Event Hubs Direct の宛先の一覧。 EventHubDirectDestination[]
logAnalytics Log Analytics の宛先の一覧。 LogAnalyticsDestination[]
monitoringAccounts 監視アカウントの宛先の一覧。 MonitoringAccountDestination[]
storageAccounts ストレージ アカウントの宛先の一覧。 StorageBlobDestination[]
storageBlobsDirect ストレージ BLOB ダイレクトの宛先の一覧。 エージェントから格納するデータを直接送信する場合にのみ使用されます。 StorageBlobDestination[]
storageTablesDirect ストレージ テーブル ダイレクトの宛先の一覧。 StorageTableDestination[]

DestinationsSpecAzureMonitorMetrics

名前 説明 値
name 宛先のフレンドリ名。
この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。
 string

EventHubDestination

名前 説明 値
eventHubResourceId イベント ハブのリソース ID。 string
name 宛先のフレンドリ名。
この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。
 string

EventHubDirectDestination

名前 説明 値
eventHubResourceId イベント ハブのリソース ID。 string
name 宛先のフレンドリ名。
この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。
 string

LogAnalyticsDestination

名前 説明 値
name 宛先のフレンドリ名。
この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。		 string
workspaceResourceId Log Analytics ワークスペースのリソース ID。 string

MonitoringAccountDestination

名前 説明 値
accountResourceId 監視アカウントのリソース ID。 string
name 宛先のフレンドリ名。
この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。
 string

StorageBlobDestination

名前 説明 値
containerName ストレージ BLOB のコンテナー名。 string
name 宛先のフレンドリ名。
この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。		 string
storageAccountResourceId ストレージ アカウントのリソース ID。 string

StorageTableDestination

名前 説明 値
name 宛先のフレンドリ名。
この名前は、データ収集規則内のすべての宛先 (種類に関係なく) で一意である必要があります。		 string
storageAccountResourceId ストレージ アカウントのリソース ID。 string
tableName ストレージ テーブルの名前。 string