Share via

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Microsoft.Insights dataCollectionRules 2019-11-01-preview

  • 项目

Bicep 资源定义

dataCollectionRules 资源类型可以使用面向以下对象的操作进行部署：

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Insights/dataCollectionRules 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.Insights/dataCollectionRules@2019-11-01-preview' = {
  name: 'string'
  location: 'string'
  tags: {
    tagName1: 'tagValue1'
    tagName2: 'tagValue2'
  }
  kind: 'string'
  properties: {
    dataFlows: [
      {
        destinations: [
          'string'
        ]
        streams: [
          'string'
        ]
      }
    ]
    dataSources: {
      extensions: [
        {
          extensionName: 'string'
          extensionSettings: any()
          inputDataSources: [
            'string'
          ]
          name: 'string'
          streams: [
            'string'
          ]
        }
      ]
      performanceCounters: [
        {
          counterSpecifiers: [
            'string'
          ]
          name: 'string'
          samplingFrequencyInSeconds: int
          streams: [
            'string'
          ]
        }
      ]
      syslog: [
        {
          facilityNames: [
            'string'
          ]
          logLevels: [
            'string'
          ]
          name: 'string'
          streams: 'Microsoft-Syslog'
        }
      ]
      windowsEventLogs: [
        {
          name: 'string'
          streams: [
            'string'
          ]
          xPathQueries: [
            'string'
          ]
        }
      ]
    }
    description: 'string'
    destinations: {
      azureMonitorMetrics: {
        name: 'string'
      }
      logAnalytics: [
        {
          name: 'string'
          workspaceResourceId: 'string'
        }
      ]
    }
  }
}

属性值

dataCollectionRules

名称 说明 值
name 资源名称 字符串 (必需)
location 资源所在的地理位置。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
kind 资源的种类。 “Linux”
“Windows”
properties 资源属性。 DataCollectionRuleResourceProperties

DataCollectionRuleResourceProperties

名称 说明 值
dataFlows 数据流的规范。 DataFlow[]
dataSources 数据源的规范。
此属性是可选的，如果规则旨在通过直接调用预配的终结点来使用，则可以省略此属性。		 DataCollectionRuleDataSources
description 数据收集规则的说明。 string
destinations 目标的规范。 DataCollectionRuleDestinations

数据流

名称 说明 值
destinations 此数据流的目标列表。 string[]
流 此数据流的流列表。 包含任意项的字符串数组：
“Microsoft-Event”
“Microsoft-InsightsMetrics”
“Microsoft-Perf”
“Microsoft-Syslog”
“Microsoft-WindowsEvent”

DataCollectionRuleDataSources

名称 说明 值
扩展 Azure VM 扩展数据源配置的列表。 ExtensionDataSource[]
performanceCounters 性能计数器数据源配置的列表。 PerfCounterDataSource[]
syslog Syslog 数据源配置的列表。 SyslogDataSource[]
windowsEventLogs Windows 事件日志数据源配置的列表。 WindowsEventLogDataSource[]

ExtensionDataSource

名称 说明 值
extensionName VM 扩展的名称。 字符串 (必需)
extensionSettings 扩展设置。 格式特定于特定扩展。 对于 Bicep，可以使用 any () 函数。
inputDataSources 此扩展需要数据的数据源列表。 string[]
name 数据源的友好名称。
无论数据收集规则中的类型) ，此名称在 (的所有数据源中都应是唯一的。		 字符串
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及通常会将数据发送到 Log Analytics 中的表。
 包含任意项的字符串数组：
“Microsoft-Event”
“Microsoft-InsightsMetrics”
“Microsoft-Perf”
“Microsoft-Syslog”
“Microsoft-WindowsEvent”

PerfCounterDataSource

名称 说明 值
counterSpecifiers 要收集的性能计数器说明符名称的列表。
使用通配符 (*) 收集所有实例的计数器。
若要在 Windows 上获取性能计数器的列表，请运行命令“typeperf”。		 string[]
name 数据源的友好名称。
无论数据收集规则中的类型) ，此名称在 (的所有数据源中都应是唯一的。		 字符串
samplingFrequencyInSeconds 连续计数器度量 (样本) 之间的秒数。 int
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及通常会将数据发送到 Log Analytics 中的表。
 包含任意项的字符串数组：
“Microsoft-InsightsMetrics”
“Microsoft-Perf”

SyslogDataSource

名称 说明 值
facilityNames 设施名称的列表。 包含任意项的字符串数组：
'*'
“auth”
“authpriv”
“cron”
“守护程序”
“kern”
“local0”
“local1”
“local2”
“local3”
“local4”
“local5”
“local6”
“local7”
'lpr'
“mail”
“mark”
“新闻”
“syslog”
“user”
“uucp”
logLevels 要收集的日志级别。 包含任意项的字符串数组：
'*'
“警报”
“关键”
“Debug”
“紧急”
“错误”
“信息”
“通知”
“警告”
name 数据源的友好名称。
无论数据收集规则中的类型) ，此名称在 (的所有数据源中都应是唯一的。		 字符串
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及通常会将数据发送到 Log Analytics 中的表。
 包含任意项的字符串数组：
“Microsoft-Syslog”

WindowsEventLogDataSource

名称 说明 值
name 数据源的友好名称。
无论数据收集规则中的类型) ，此名称在 (的所有数据源中都应是唯一的。		 string
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及通常会将数据发送到 Log Analytics 中的表。		 包含任意项的字符串数组：
“Microsoft-Event”
“Microsoft-WindowsEvent”
xPathQueries XPATH 格式的 Windows 事件日志查询列表。 string[]

DataCollectionRuleDestinations

名称 说明 值
azureMonitorMetrics Azure Monitor 指标目标。 DestinationsSpecAzureMonitorMetrics
logAnalytics Log Analytics 目标列表。 LogAnalyticsDestination[]

DestinationsSpecAzureMonitorMetrics

名称 说明 值
name 目标的友好名称。
无论数据收集规则中的类型) ，此名称在 (的所有目标中都应是唯一的。
 字符串

LogAnalyticsDestination

名称 说明 值
name 目标的友好名称。
无论数据收集规则中的类型) ，此名称在 (的所有目标中都应是唯一的。		 string
workspaceResourceId Log Analytics 工作区的资源 ID。 字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
部署 Darktrace 自动缩放 vSensors

部署到 Azure		 此模板允许部署 Darktrace vSensors 的自动缩放部署
Syslog 的数据收集规则

部署到 Azure		 此模板创建一个数据收集规则，用于定义数据源 (Syslog) 和目标工作区。

ARM 模板资源定义

dataCollectionRules 资源类型可以使用面向以下对象的操作进行部署：

有关每个 API 版本中更改的属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Insights/dataCollectionRules 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.Insights/dataCollectionRules",
  "apiVersion": "2019-11-01-preview",
  "name": "string",
  "location": "string",
  "tags": {
    "tagName1": "tagValue1",
    "tagName2": "tagValue2"
  },
  "kind": "string",
  "properties": {
    "dataFlows": [
      {
        "destinations": [ "string" ],
        "streams": [ "string" ]
      }
    ],
    "dataSources": {
      "extensions": [
        {
          "extensionName": "string",
          "extensionSettings": {},
          "inputDataSources": [ "string" ],
          "name": "string",
          "streams": [ "string" ]
        }
      ],
      "performanceCounters": [
        {
          "counterSpecifiers": [ "string" ],
          "name": "string",
          "samplingFrequencyInSeconds": "int",
          "streams": [ "string" ]
        }
      ],
      "syslog": [
        {
          "facilityNames": [ "string" ],
          "logLevels": [ "string" ],
          "name": "string",
          "streams": "Microsoft-Syslog"
        }
      ],
      "windowsEventLogs": [
        {
          "name": "string",
          "streams": [ "string" ],
          "xPathQueries": [ "string" ]
        }
      ]
    },
    "description": "string",
    "destinations": {
      "azureMonitorMetrics": {
        "name": "string"
      },
      "logAnalytics": [
        {
          "name": "string",
          "workspaceResourceId": "string"
        }
      ]
    }
  }
}

属性值

dataCollectionRules

名称 说明 Value
type 资源类型 “Microsoft.Insights/dataCollectionRules”
apiVersion 资源 API 版本 “2019-11-01-preview”
name 资源名称 字符串 (必需)
location 资源所在的地理位置。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。 请参阅 模板中的标记
kind 资源的种类。 “Linux”
“Windows”
properties 资源属性。 DataCollectionRuleResourceProperties

DataCollectionRuleResourceProperties

名称 说明 值
dataFlows 数据流的规范。 DataFlow[]
dataSources 数据源的规范。
此属性是可选的，如果规则旨在通过直接调用预配的终结点来使用，则可以省略此属性。		 DataCollectionRuleDataSources
description 数据收集规则的说明。 字符串
destinations 目标的规范。 DataCollectionRuleDestinations

数据流

名称 说明 值
destinations 此数据流的目标列表。 string[]
流 此数据流的流列表。 包含任意项的字符串数组：
“Microsoft-Event”
“Microsoft-InsightsMetrics”
“Microsoft-Perf”
“Microsoft-Syslog”
“Microsoft-WindowsEvent”

DataCollectionRuleDataSources

名称 说明 值
扩展 Azure VM 扩展数据源配置的列表。 ExtensionDataSource[]
performanceCounters 性能计数器数据源配置的列表。 PerfCounterDataSource[]
syslog Syslog 数据源配置的列表。 SyslogDataSource[]
windowsEventLogs Windows 事件日志数据源配置的列表。 WindowsEventLogDataSource[]

ExtensionDataSource

名称 说明 值
extensionName VM 扩展的名称。 字符串 (必需)
extensionSettings 扩展设置。 格式特定于特定扩展。
inputDataSources 此扩展需要数据的数据源列表。 string[]
name 数据源的友好名称。
无论数据收集规则中的) 类型如何，此名称在 (的所有数据源中都应是唯一的。		 string
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及通常将数据发送到 Log Analytics 中的表。
 包含任何一项的字符串数组：
“Microsoft-Event”
“Microsoft-InsightsMetrics”
“Microsoft-Perf”
“Microsoft-Syslog”
“Microsoft-WindowsEvent”

PerfCounterDataSource

名称 说明 值
counterSpecifiers 要收集的性能计数器说明符名称的列表。
使用通配符 (*) 收集所有实例的计数器。
若要在 Windows 上获取性能计数器的列表，请运行命令“typeperf”。		 string[]
name 数据源的友好名称。
无论数据收集规则中的) 类型如何，此名称在 (的所有数据源中都应是唯一的。		 string
samplingFrequencyInSeconds 连续计数器测量 (样本) 之间的秒数。 int
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及通常将数据发送到 Log Analytics 中的表。
 包含任何一项的字符串数组：
“Microsoft-InsightsMetrics”
“Microsoft-Perf”

SyslogDataSource

名称 说明 值
facilityNames 设施名称的列表。 包含任何一项的字符串数组：
'*'
'auth'
“authpriv”
'cron'
“守护程序”
'kern'
'local0'
'local1'
'local2'
'local3'
'local4'
'local5'
'local6'
'local7'
'lpr'
'mail'
'mark'
'news'
'syslog'
'user'
'uucp'
logLevels 要收集的日志级别。 包含任何一项的字符串数组：
'*'
'Alert'
'Critical'
“调试”
'Emergency'
'Error'
'Info'
“通知”
'Warning'
name 数据源的友好名称。
无论数据收集规则中的) 类型如何，此名称在 (的所有数据源中都应是唯一的。		 字符串
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及通常将数据发送到 Log Analytics 中的表。
 包含任何一项的字符串数组：
“Microsoft-Syslog”

WindowsEventLogDataSource

名称 说明 值
name 数据源的友好名称。
无论数据收集规则中的) 类型如何，此名称在 (的所有数据源中都应是唯一的。		 字符串
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及通常将数据发送到 Log Analytics 中的表。		 包含任何一项的字符串数组：
“Microsoft-Event”
“Microsoft-WindowsEvent”
xPathQueries XPATH 格式的 Windows 事件日志查询列表。 string[]

DataCollectionRuleDestinations

名称 说明 值
azureMonitorMetrics Azure Monitor 指标目标。 DestinationsSpecAzureMonitorMetrics
logAnalytics Log Analytics 目标列表。 LogAnalyticsDestination[]

DestinationsSpecAzureMonitorMetrics

名称 说明 值
name 目标的友好名称。
无论数据收集规则中的) 类型如何，此名称在 (的所有目标中都应是唯一的。
 字符串

LogAnalyticsDestination

名称 说明 值
name 目标的友好名称。
无论数据收集规则中的) 类型如何，此名称在 (的所有目标中都应是唯一的。		 字符串
workspaceResourceId Log Analytics 工作区的资源 ID。 字符串

快速入门模板

以下快速入门模板部署此资源类型。

模板 说明
部署 Darktrace 自动缩放 vSensors

部署到 Azure		 此模板允许部署 Darktrace vSensors 的自动缩放部署
Syslog 的数据收集规则

部署到 Azure		 此模板创建一个数据收集规则，用于定义数据源 (Syslog) 和目标工作区。

Terraform (AzAPI 提供程序) 资源定义

dataCollectionRules 资源类型可以使用面向以下对象的操作进行部署：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.Insights/dataCollectionRules 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/dataCollectionRules@2019-11-01-preview"
  name = "string"
  location = "string"
  parent_id = "string"
  tags = {
    tagName1 = "tagValue1"
    tagName2 = "tagValue2"
  }
  body = jsonencode({
    properties = {
      dataFlows = [
        {
          destinations = [
            "string"
          ]
          streams = [
            "string"
          ]
        }
      ]
      dataSources = {
        extensions = [
          {
            extensionName = "string"
            inputDataSources = [
              "string"
            ]
            name = "string"
            streams = [
              "string"
            ]
          }
        ]
        performanceCounters = [
          {
            counterSpecifiers = [
              "string"
            ]
            name = "string"
            samplingFrequencyInSeconds = int
            streams = [
              "string"
            ]
          }
        ]
        syslog = [
          {
            facilityNames = [
              "string"
            ]
            logLevels = [
              "string"
            ]
            name = "string"
            streams = "Microsoft-Syslog"
          }
        ]
        windowsEventLogs = [
          {
            name = "string"
            streams = [
              "string"
            ]
            xPathQueries = [
              "string"
            ]
          }
        ]
      }
      description = "string"
      destinations = {
        azureMonitorMetrics = {
          name = "string"
        }
        logAnalytics = [
          {
            name = "string"
            workspaceResourceId = "string"
          }
        ]
      }
    }
    kind = "string"
  })
}

属性值

dataCollectionRules

名称 说明 Value
type 资源类型 “Microsoft.Insights/dataCollectionRules@2019-11-01-preview”
name 资源名称 字符串 (必需)
location 资源所在的地理位置。 字符串 (必需)
parent_id 若要部署到资源组，请使用该资源组的 ID。 字符串 (必需)
标记 资源标记。 标记名称和值的字典。
kind 资源的种类。 “Linux”
“Windows”
properties 资源属性。 DataCollectionRuleResourceProperties

DataCollectionRuleResourceProperties

名称 说明 值
dataFlows 数据流的规范。 DataFlow[]
dataSources 数据源的规范。
此属性是可选的，如果打算通过直接调用预配的终结点使用该规则，则可以省略此属性。		 DataCollectionRuleDataSources
description 数据收集规则的说明。 string
destinations 目标的规范。 DataCollectionRuleDestinations

数据流

名称 说明 值
destinations 此数据流的目标列表。 string[]
流 此数据流的流列表。 包含任何一项的字符串数组：
“Microsoft-Event”
“Microsoft-InsightsMetrics”
“Microsoft-Perf”
“Microsoft-Syslog”
“Microsoft-WindowsEvent”

DataCollectionRuleDataSources

名称 说明 值
扩展 Azure VM 扩展数据源配置的列表。 ExtensionDataSource[]
performanceCounters 性能计数器数据源配置的列表。 PerfCounterDataSource[]
syslog Syslog 数据源配置的列表。 SyslogDataSource[]
windowsEventLogs Windows 事件日志数据源配置的列表。 WindowsEventLogDataSource[]

ExtensionDataSource

名称 说明 值
extensionName VM 扩展的名称。 字符串 (必需)
extensionSettings 扩展设置。 格式特定于特定扩展。
inputDataSources 此扩展需要数据的数据源列表。 string[]
name 数据源的友好名称。
无论数据收集规则中的) 类型如何，此名称在 (的所有数据源中都应是唯一的。		 字符串
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及通常将数据发送到 Log Analytics 中的表。
 包含任何一项的字符串数组：
“Microsoft-Event”
“Microsoft-InsightsMetrics”
“Microsoft-Perf”
“Microsoft-Syslog”
“Microsoft-WindowsEvent”

PerfCounterDataSource

名称 说明 值
counterSpecifiers 要收集的性能计数器说明符名称的列表。
使用通配符 (*) 收集所有实例的计数器。
若要在 Windows 上获取性能计数器的列表，请运行命令“typeperf”。		 string[]
name 数据源的友好名称。
无论数据收集规则中的) 类型如何，此名称在 (的所有数据源中都应是唯一的。		 字符串
samplingFrequencyInSeconds 连续计数器测量 (样本) 之间的秒数。 int
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及通常将数据发送到 Log Analytics 中的表。
 包含任何一项的字符串数组：
“Microsoft-InsightsMetrics”
“Microsoft-Perf”

SyslogDataSource

名称 说明 值
facilityNames 设施名称的列表。 包含任意项的字符串数组：
"*"
“auth”
“authpriv”
“cron”
“守护程序”
“kern”
“local0”
“local1”
“local2”
“local3”
“local4”
“local5”
“local6”
“local7”
“lpr”
“mail”
“mark”
“新闻”
“syslog”
"user"
“uucp”
logLevels 要收集的日志级别。 包含任意项的字符串数组：
"*"
“警报”
“严重”
“Debug”
“紧急”
“错误”
“信息”
“通知”
“警告”
name 数据源的友好名称。
无论数据收集规则中的类型) ，此名称在 (的所有数据源中都应是唯一的。		 string
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及通常会将数据发送到 Log Analytics 中的表。
 包含任意项的字符串数组：
“Microsoft-Syslog”

WindowsEventLogDataSource

名称 说明 值
name 数据源的友好名称。
无论数据收集规则中的类型) ，此名称在 (的所有数据源中都应是唯一的。		 string
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及通常会将数据发送到 Log Analytics 中的表。		 包含任意项的字符串数组：
“Microsoft-Event”
“Microsoft-WindowsEvent”
xPathQueries XPATH 格式的 Windows 事件日志查询列表。 string[]

DataCollectionRuleDestinations

名称 说明 值
azureMonitorMetrics Azure Monitor 指标目标。 DestinationsSpecAzureMonitorMetrics
logAnalytics Log Analytics 目标列表。 LogAnalyticsDestination[]

DestinationsSpecAzureMonitorMetrics

名称 说明 值
name 目标的友好名称。
无论数据收集规则中的类型) ，此名称在 (的所有目标中都应是唯一的。
 字符串

LogAnalyticsDestination

名称 说明 值
name 目标的友好名称。
无论数据收集规则中的类型) ，此名称在 (的所有目标中都应是唯一的。		 string
workspaceResourceId Log Analytics 工作区的资源 ID。 字符串