通过

你当前正在访问 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

名字 描述 价值
名字 资源名称 string （必需）
位置 资源所在的地理位置。 string （必需）
标签 资源标记。 标记名称和值的字典。 请参阅模板 中的 标记
类 资源的种类。 “Linux”
“Windows”
性能 资源属性。 DataCollectionRuleResourceProperties

DataCollectionRuleResourceProperties

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

数据流

名字 描述 价值
目的地 此数据流的目标列表。 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 扩展的名称。 string （必需）
extensionSettings 扩展设置。 该格式特定于特定扩展。 对于 Bicep，可以使用 any（） 函数。
inputDataSources 此扩展插件需要数据的数据源列表。 string[]
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。
 包含任一项的字符串数组：
“Microsoft-event”
“Microsoft-InsightsMetrics”
“Microsoft-Perf”
“Microsoft-Syslog”
“Microsoft-WindowsEvent”

PerfCounterDataSource

名字 描述 价值
counterSpecifiers 要收集的性能计数器说明符名称的列表。
使用通配符 \ 为所有实例收集计数器。
若要获取 Windows 上的性能计数器列表，请运行命令“typeperf”。		 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”
“新闻”
“syslog”
“user”
“uucp”
logLevels 要收集的日志级别。 包含任一项的字符串数组：
'*'
“Alert”
“Critical”
“Debug”
“紧急”
“Error”
“Info”
“注意”
“Warning”
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。
 包含任一项的字符串数组：
“Microsoft-Syslog”

WindowsEventLogDataSource

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

DataCollectionRuleDestinations

名字 描述 价值
azureMonitorMetrics Azure Monitor 指标目标。 DestinationsSpecAzureMonitorMetrics
logAnalytics Log Analytics 目标列表。 LogAnalyticsDestination[]

DestinationsSpecAzureMonitorMetrics

名字 描述 价值
名字 目标的友好名称。
此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。
 字符串

LogAnalyticsDestination

名字 描述 价值
名字 目标的友好名称。
此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。		 字符串
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

名字 描述 价值
类型 资源类型 “Microsoft.Insights/dataCollectionRules”
apiVersion 资源 API 版本 '2019-11-01-preview'
名字 资源名称 string （必需）
位置 资源所在的地理位置。 string （必需）
标签 资源标记。 标记名称和值的字典。 请参阅模板 中的 标记
类 资源的种类。 “Linux”
“Windows”
性能 资源属性。 DataCollectionRuleResourceProperties

DataCollectionRuleResourceProperties

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

数据流

名字 描述 价值
目的地 此数据流的目标列表。 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 扩展的名称。 string （必需）
extensionSettings 扩展设置。 该格式特定于特定扩展。
inputDataSources 此扩展插件需要数据的数据源列表。 string[]
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。
 包含任一项的字符串数组：
“Microsoft-event”
“Microsoft-InsightsMetrics”
“Microsoft-Perf”
“Microsoft-Syslog”
“Microsoft-WindowsEvent”

PerfCounterDataSource

名字 描述 价值
counterSpecifiers 要收集的性能计数器说明符名称的列表。
使用通配符 \ 为所有实例收集计数器。
若要获取 Windows 上的性能计数器列表，请运行命令“typeperf”。		 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”
“新闻”
“syslog”
“user”
“uucp”
logLevels 要收集的日志级别。 包含任一项的字符串数组：
'*'
“Alert”
“Critical”
“Debug”
“紧急”
“Error”
“Info”
“注意”
“Warning”
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。
 包含任一项的字符串数组：
“Microsoft-Syslog”

WindowsEventLogDataSource

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

DataCollectionRuleDestinations

名字 描述 价值
azureMonitorMetrics Azure Monitor 指标目标。 DestinationsSpecAzureMonitorMetrics
logAnalytics Log Analytics 目标列表。 LogAnalyticsDestination[]

DestinationsSpecAzureMonitorMetrics

名字 描述 价值
名字 目标的友好名称。
此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。
 字符串

LogAnalyticsDestination

名字 描述 价值
名字 目标的友好名称。
此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。		 字符串
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

名字 描述 价值
类型 资源类型 “Microsoft.Insights/dataCollectionRules@2019-11-01-preview”
名字 资源名称 string （必需）
位置 资源所在的地理位置。 string （必需）
parent_id 若要部署到资源组，请使用该资源组的 ID。 string （必需）
标签 资源标记。 标记名称和值的字典。
类 资源的种类。 “Linux”
“Windows”
性能 资源属性。 DataCollectionRuleResourceProperties

DataCollectionRuleResourceProperties

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

数据流

名字 描述 价值
目的地 此数据流的目标列表。 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 扩展的名称。 string （必需）
extensionSettings 扩展设置。 该格式特定于特定扩展。
inputDataSources 此扩展插件需要数据的数据源列表。 string[]
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。
 包含任一项的字符串数组：
“Microsoft-Event”
“Microsoft-InsightsMetrics”
“Microsoft-Perf”
“Microsoft-Syslog”
“Microsoft-WindowsEvent”

PerfCounterDataSource

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

SyslogDataSource

名字 描述 价值
facilityNames 设施名称的列表。 包含任一项的字符串数组：
"*"
“身份验证”
“authpriv”
“cron”
“守护程序”
“kern”
“local0”
“local1”
“local2”
“local3”
“local4”
“local5”
“local6”
“local7”
“lpr”
“mail”
“mark”
“新闻”
“syslog”
“user”
“uucp”
logLevels 要收集的日志级别。 包含任一项的字符串数组：
"*"
“警报”
“Critical”
“调试”
“紧急”
“Error”
“信息”
“注意”
“Warning”
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 此数据源将发送到的流列表。
流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。
 包含任一项的字符串数组：
“Microsoft-Syslog”

WindowsEventLogDataSource

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

DataCollectionRuleDestinations

名字 描述 价值
azureMonitorMetrics Azure Monitor 指标目标。 DestinationsSpecAzureMonitorMetrics
logAnalytics Log Analytics 目标列表。 LogAnalyticsDestination[]

DestinationsSpecAzureMonitorMetrics

名字 描述 价值
名字 目标的友好名称。
此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。
 字符串

LogAnalyticsDestination

名字 描述 价值
名字 目标的友好名称。
此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。		 字符串
workspaceResourceId Log Analytics 工作区的资源 ID。 字符串