通过

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

Microsoft.Insights dataCollectionRules 2022-06-01

  • 项目

Bicep 资源定义

可以使用目标操作部署 dataCollectionRules 资源类型：

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

资源格式

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

resource symbolicname 'Microsoft.Insights/dataCollectionRules@2022-06-01' = {
  identity: {
    type: 'string'
    userAssignedIdentities: {
      {customized property}: {}
    }
  }
  kind: 'string'
  location: 'string'
  name: 'string'
  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(Azure.Bicep.Types.Concrete.AnyType)
          inputDataSources: [
            'string'
          ]
          name: 'string'
          streams: [
            'string'
          ]
        }
      ]
      iisLogs: [
        {
          logDirectories: [
            'string'
          ]
          name: 'string'
          streams: [
            'string'
          ]
        }
      ]
      logFiles: [
        {
          filePatterns: [
            'string'
          ]
          format: 'string'
          name: 'string'
          settings: {
            text: {
              recordStartTimestampFormat: 'string'
            }
          }
          streams: [
            'string'
          ]
        }
      ]
      performanceCounters: [
        {
          counterSpecifiers: [
            'string'
          ]
          name: 'string'
          samplingFrequencyInSeconds: int
          streams: [
            'string'
          ]
        }
      ]
      platformTelemetry: [
        {
          name: 'string'
          streams: [
            'string'
          ]
        }
      ]
      prometheusForwarder: [
        {
          labelIncludeFilter: {
            {customized property}: 'string'
          }
          name: 'string'
          streams: [
            'string'
          ]
        }
      ]
      syslog: [
        {
          facilityNames: [
            'string'
          ]
          logLevels: [
            'string'
          ]
          name: 'string'
          streams: [
            'string'
          ]
        }
      ]
      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: {
      {customized property}: {
        columns: [
          {
            name: 'string'
            type: 'string'
          }
        ]
      }
    }
  }
  tags: {
    {customized property}: 'string'
  }
}

属性值

ColumnDefinition

名字 描述 价值
名字 列的名称。 字符串
类型 列数据的类型。 “boolean”
“datetime”
“dynamic”
“int”
“long”
“real”
“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[]

DataCollectionRuleDestinations

名字 描述 价值
azureMonitorMetrics Azure Monitor 指标目标。 DestinationsSpecAzureMonitorMetrics
eventHubs 事件中心目标列表。 EventHubDestination[]
eventHubsDirect 事件中心直接目标列表。 EventHubDirectDestination[]
logAnalytics Log Analytics 目标列表。 LogAnalyticsDestination[]
monitoringAccounts 监视帐户目标列表。 MonitoringAccountDestination[]
storageAccounts 存储帐户目标列表。 StorageBlobDestination[]
storageBlobsDirect 存储 Blob Direct 目标的列表。 仅用于将数据直接从代理发送到存储。 StorageBlobDestination[]
storageTablesDirect 存储表直接目标的列表。 StorageTableDestination[]

DataCollectionRuleResourceIdentity

名字 描述 价值
类型 托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。 “None”
“SystemAssigned”
“SystemAssigned，UserAssigned”
“UserAssigned”（必需）
userAssignedIdentities 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象（{}）。 UserAssignedIdentities

DataCollectionRuleResourceProperties

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

DataCollectionRuleResourceTags

名字 描述 价值

DataCollectionRuleStreamDeclarations

名字 描述 价值

数据流

名字 描述 价值
builtInTransform 用于转换流数据的 builtIn 转换 字符串
目的地 此数据流的目标列表。 string[]
outputStream 转换的输出流。 仅当转换将数据更改为其他流时，才是必需的。 字符串
流 此数据流的流列表。 包含任一项的字符串数组：
“Microsoft-event”
“Microsoft-InsightsMetrics”
“Microsoft-Perf”
“Microsoft-Syslog”
“Microsoft-WindowsEvent”
transformKql 用于转换流数据的 KQL 查询。 字符串

DataImportSourcesEventHub

名字 描述 价值
consumerGroup 事件中心使用者组名称 字符串
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 要从 EventHub 收集的流 字符串

DataSourcesSpecDataImports

名字 描述 价值
eventHub 事件中心配置的定义。 DataImportSourcesEventHub

DestinationsSpecAzureMonitorMetrics

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

EventHubDestination

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

EventHubDirectDestination

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

ExtensionDataSource

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

IisLogsDataSource

名字 描述 价值
logDirectories 绝对路径文件位置 string[]
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 IIS 流 string[] （必需）

LogAnalyticsDestination

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

LogFilesDataSource

名字 描述 价值
filePatterns 日志文件所在的文件模式 string[] （必需）
格式 日志文件的数据格式 “text”（必需）
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
设置 日志文件特定设置。 LogFilesDataSourceSettings
流 此数据源将发送到的流列表。
流指示将用于此数据源的架构		 string[] （必需）

LogFilesDataSourceSettings

名字 描述 价值
发短信 文本设置 LogFileSettingsText

LogFileSettingsText

名字 描述 价值
recordStartTimestampFormat 支持的时间戳格式之一 'dd/MMM/yyyy：HH：mm：ss zzz'
'ddMMyy HH：mm：ss'
“ISO 8601”
'M/D/YYYY HH：MM：SS AM/PM'
'MMM d hh：mm：ss'
“Mon DD， YYYY HH：MM：SS”
'yyMMdd HH：mm：ss'
“YYYY-MM-DD HH：MM：SS”
'yyyy-MM-ddTHH：mm：ssK' （必需）

Microsoft.Insights/dataCollectionRules

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

MonitoringAccountDestination

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

PerfCounterDataSource

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

PlatformTelemetryDataSource

名字 描述 价值
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 要收集的平台遥测流列表 string[] （必需）

PrometheusForwarderDataSource

名字 描述 价值
labelIncludeFilter 标签包含筛选器的列表，格式为标签“name-value”对。
目前仅支持一个标签：“microsoft_metrics_include_label”。
标签值不区分大小写。		 PrometheusForwarderDataSourceLabelIncludeFilter
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 此数据源将发送到的流列表。 包含任一项的字符串数组：
“Microsoft-PrometheusMetrics”

PrometheusForwarderDataSourceLabelIncludeFilter

名字 描述 价值

StorageBlobDestination

名字 描述 价值
containerName 存储 Blob 的容器名称。 字符串
名字 目标的友好名称。
此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。		 字符串
storageAccountResourceId 存储帐户的资源 ID。 字符串

StorageTableDestination

名字 描述 价值
名字 目标的友好名称。
此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。		 字符串
storageAccountResourceId 存储帐户的资源 ID。 字符串
tableName 存储表的名称。 字符串

StreamDeclaration

名字 描述 价值
列 此流中的数据使用的列列表。 ColumnDefinition[]

SyslogDataSource

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

UserAssignedIdentities

名字 描述 价值

UserAssignedIdentity

名字 描述 价值

WindowsEventLogDataSource

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

WindowsFirewallLogsDataSource

名字 描述 价值
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 防火墙日志流 string[] （必需）

快速入门示例

以下快速入门示例部署此资源类型。

Bicep 文件 描述
使用托管虚拟网络部署安全 Azure AI Studio 此模板创建一个安全的 Azure AI Studio 环境，其中包含可靠的网络和标识安全限制。

ARM 模板资源定义

可以使用目标操作部署 dataCollectionRules 资源类型：

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

资源格式

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

{
  "type": "Microsoft.Insights/dataCollectionRules",
  "apiVersion": "2022-06-01",
  "name": "string",
  "identity": {
    "type": "string",
    "userAssignedIdentities": {
      "{customized property}": {
      }
    }
  },
  "kind": "string",
  "location": "string",
  "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": "string",
          "name": "string",
          "settings": {
            "text": {
              "recordStartTimestampFormat": "string"
            }
          },
          "streams": [ "string" ]
        }
      ],
      "performanceCounters": [
        {
          "counterSpecifiers": [ "string" ],
          "name": "string",
          "samplingFrequencyInSeconds": "int",
          "streams": [ "string" ]
        }
      ],
      "platformTelemetry": [
        {
          "name": "string",
          "streams": [ "string" ]
        }
      ],
      "prometheusForwarder": [
        {
          "labelIncludeFilter": {
            "{customized property}": "string"
          },
          "name": "string",
          "streams": [ "string" ]
        }
      ],
      "syslog": [
        {
          "facilityNames": [ "string" ],
          "logLevels": [ "string" ],
          "name": "string",
          "streams": [ "string" ]
        }
      ],
      "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": {
      "{customized property}": {
        "columns": [
          {
            "name": "string",
            "type": "string"
          }
        ]
      }
    }
  },
  "tags": {
    "{customized property}": "string"
  }
}

属性值

ColumnDefinition

名字 描述 价值
名字 列的名称。 字符串
类型 列数据的类型。 “boolean”
“datetime”
“dynamic”
“int”
“long”
“real”
“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[]

DataCollectionRuleDestinations

名字 描述 价值
azureMonitorMetrics Azure Monitor 指标目标。 DestinationsSpecAzureMonitorMetrics
eventHubs 事件中心目标列表。 EventHubDestination[]
eventHubsDirect 事件中心直接目标列表。 EventHubDirectDestination[]
logAnalytics Log Analytics 目标列表。 LogAnalyticsDestination[]
monitoringAccounts 监视帐户目标列表。 MonitoringAccountDestination[]
storageAccounts 存储帐户目标列表。 StorageBlobDestination[]
storageBlobsDirect 存储 Blob Direct 目标的列表。 仅用于将数据直接从代理发送到存储。 StorageBlobDestination[]
storageTablesDirect 存储表直接目标的列表。 StorageTableDestination[]

DataCollectionRuleResourceIdentity

名字 描述 价值
类型 托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。 “None”
“SystemAssigned”
“SystemAssigned，UserAssigned”
“UserAssigned”（必需）
userAssignedIdentities 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象（{}）。 UserAssignedIdentities

DataCollectionRuleResourceProperties

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

DataCollectionRuleResourceTags

名字 描述 价值

DataCollectionRuleStreamDeclarations

名字 描述 价值

数据流

名字 描述 价值
builtInTransform 用于转换流数据的 builtIn 转换 字符串
目的地 此数据流的目标列表。 string[]
outputStream 转换的输出流。 仅当转换将数据更改为其他流时，才是必需的。 字符串
流 此数据流的流列表。 包含任一项的字符串数组：
“Microsoft-event”
“Microsoft-InsightsMetrics”
“Microsoft-Perf”
“Microsoft-Syslog”
“Microsoft-WindowsEvent”
transformKql 用于转换流数据的 KQL 查询。 字符串

DataImportSourcesEventHub

名字 描述 价值
consumerGroup 事件中心使用者组名称 字符串
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 要从 EventHub 收集的流 字符串

DataSourcesSpecDataImports

名字 描述 价值
eventHub 事件中心配置的定义。 DataImportSourcesEventHub

DestinationsSpecAzureMonitorMetrics

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

EventHubDestination

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

EventHubDirectDestination

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

ExtensionDataSource

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

IisLogsDataSource

名字 描述 价值
logDirectories 绝对路径文件位置 string[]
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 IIS 流 string[] （必需）

LogAnalyticsDestination

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

LogFilesDataSource

名字 描述 价值
filePatterns 日志文件所在的文件模式 string[] （必需）
格式 日志文件的数据格式 “text”（必需）
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
设置 日志文件特定设置。 LogFilesDataSourceSettings
流 此数据源将发送到的流列表。
流指示将用于此数据源的架构		 string[] （必需）

LogFilesDataSourceSettings

名字 描述 价值
发短信 文本设置 LogFileSettingsText

LogFileSettingsText

名字 描述 价值
recordStartTimestampFormat 支持的时间戳格式之一 'dd/MMM/yyyy：HH：mm：ss zzz'
'ddMMyy HH：mm：ss'
“ISO 8601”
'M/D/YYYY HH：MM：SS AM/PM'
'MMM d hh：mm：ss'
“Mon DD， YYYY HH：MM：SS”
'yyMMdd HH：mm：ss'
“YYYY-MM-DD HH：MM：SS”
'yyyy-MM-ddTHH：mm：ssK' （必需）

Microsoft.Insights/dataCollectionRules

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

MonitoringAccountDestination

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

PerfCounterDataSource

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

PlatformTelemetryDataSource

名字 描述 价值
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 要收集的平台遥测流列表 string[] （必需）

PrometheusForwarderDataSource

名字 描述 价值
labelIncludeFilter 标签包含筛选器的列表，格式为标签“name-value”对。
目前仅支持一个标签：“microsoft_metrics_include_label”。
标签值不区分大小写。		 PrometheusForwarderDataSourceLabelIncludeFilter
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 此数据源将发送到的流列表。 包含任一项的字符串数组：
“Microsoft-PrometheusMetrics”

PrometheusForwarderDataSourceLabelIncludeFilter

名字 描述 价值

StorageBlobDestination

名字 描述 价值
containerName 存储 Blob 的容器名称。 字符串
名字 目标的友好名称。
此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。		 字符串
storageAccountResourceId 存储帐户的资源 ID。 字符串

StorageTableDestination

名字 描述 价值
名字 目标的友好名称。
此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。		 字符串
storageAccountResourceId 存储帐户的资源 ID。 字符串
tableName 存储表的名称。 字符串

StreamDeclaration

名字 描述 价值
列 此流中的数据使用的列列表。 ColumnDefinition[]

SyslogDataSource

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

UserAssignedIdentities

名字 描述 价值

UserAssignedIdentity

名字 描述 价值

WindowsEventLogDataSource

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

WindowsFirewallLogsDataSource

名字 描述 价值
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 防火墙日志流 string[] （必需）

快速入门模板

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

模板 描述
Syslog 的 数据收集规则

部署到 Azure 		此模板创建定义数据源（Syslog）和目标工作区的数据收集规则。
部署 Darktrace 自动缩放 vSensors

部署到 Azure 		此模板允许你部署 Darktrace vSensors 的自动自动缩放部署
使用托管虚拟网络部署安全 Azure AI Studio

部署到 Azure 		此模板创建一个安全的 Azure AI Studio 环境，其中包含可靠的网络和标识安全限制。

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署 dataCollectionRules 资源类型：

  • 资源组

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

资源格式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/dataCollectionRules@2022-06-01"
  name = "string"
  identity = {
    type = "string"
    userAssignedIdentities = {
      {customized property} = {
      }
    }
  }
  kind = "string"
  location = "string"
  tags = {
    {customized property} = "string"
  }
  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"
            extensionSettings = ?
            inputDataSources = [
              "string"
            ]
            name = "string"
            streams = [
              "string"
            ]
          }
        ]
        iisLogs = [
          {
            logDirectories = [
              "string"
            ]
            name = "string"
            streams = [
              "string"
            ]
          }
        ]
        logFiles = [
          {
            filePatterns = [
              "string"
            ]
            format = "string"
            name = "string"
            settings = {
              text = {
                recordStartTimestampFormat = "string"
              }
            }
            streams = [
              "string"
            ]
          }
        ]
        performanceCounters = [
          {
            counterSpecifiers = [
              "string"
            ]
            name = "string"
            samplingFrequencyInSeconds = int
            streams = [
              "string"
            ]
          }
        ]
        platformTelemetry = [
          {
            name = "string"
            streams = [
              "string"
            ]
          }
        ]
        prometheusForwarder = [
          {
            labelIncludeFilter = {
              {customized property} = "string"
            }
            name = "string"
            streams = [
              "string"
            ]
          }
        ]
        syslog = [
          {
            facilityNames = [
              "string"
            ]
            logLevels = [
              "string"
            ]
            name = "string"
            streams = [
              "string"
            ]
          }
        ]
        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 = {
        {customized property} = {
          columns = [
            {
              name = "string"
              type = "string"
            }
          ]
        }
      }
    }
  })
}

属性值

ColumnDefinition

名字 描述 价值
名字 列的名称。 字符串
类型 列数据的类型。 “boolean”
“datetime”
“dynamic”
“int”
“long”
“real”
“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[]

DataCollectionRuleDestinations

名字 描述 价值
azureMonitorMetrics Azure Monitor 指标目标。 DestinationsSpecAzureMonitorMetrics
eventHubs 事件中心目标列表。 EventHubDestination[]
eventHubsDirect 事件中心直接目标列表。 EventHubDirectDestination[]
logAnalytics Log Analytics 目标列表。 LogAnalyticsDestination[]
monitoringAccounts 监视帐户目标列表。 MonitoringAccountDestination[]
storageAccounts 存储帐户目标列表。 StorageBlobDestination[]
storageBlobsDirect 存储 Blob Direct 目标的列表。 仅用于将数据直接从代理发送到存储。 StorageBlobDestination[]
storageTablesDirect 存储表直接目标的列表。 StorageTableDestination[]

DataCollectionRuleResourceIdentity

名字 描述 价值
类型 托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。 “None”
“SystemAssigned”
“SystemAssigned，UserAssigned”
“UserAssigned”（必需）
userAssignedIdentities 与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。 字典值可以是请求中的空对象（{}）。 UserAssignedIdentities

DataCollectionRuleResourceProperties

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

DataCollectionRuleResourceTags

名字 描述 价值

DataCollectionRuleStreamDeclarations

名字 描述 价值

数据流

名字 描述 价值
builtInTransform 用于转换流数据的 builtIn 转换 字符串
目的地 此数据流的目标列表。 string[]
outputStream 转换的输出流。 仅当转换将数据更改为其他流时，才是必需的。 字符串
流 此数据流的流列表。 包含任一项的字符串数组：
“Microsoft-event”
“Microsoft-InsightsMetrics”
“Microsoft-Perf”
“Microsoft-Syslog”
“Microsoft-WindowsEvent”
transformKql 用于转换流数据的 KQL 查询。 字符串

DataImportSourcesEventHub

名字 描述 价值
consumerGroup 事件中心使用者组名称 字符串
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 要从 EventHub 收集的流 字符串

DataSourcesSpecDataImports

名字 描述 价值
eventHub 事件中心配置的定义。 DataImportSourcesEventHub

DestinationsSpecAzureMonitorMetrics

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

EventHubDestination

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

EventHubDirectDestination

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

ExtensionDataSource

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

IisLogsDataSource

名字 描述 价值
logDirectories 绝对路径文件位置 string[]
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 IIS 流 string[] （必需）

LogAnalyticsDestination

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

LogFilesDataSource

名字 描述 价值
filePatterns 日志文件所在的文件模式 string[] （必需）
格式 日志文件的数据格式 “text”（必需）
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
设置 日志文件特定设置。 LogFilesDataSourceSettings
流 此数据源将发送到的流列表。
流指示将用于此数据源的架构		 string[] （必需）

LogFilesDataSourceSettings

名字 描述 价值
发短信 文本设置 LogFileSettingsText

LogFileSettingsText

名字 描述 价值
recordStartTimestampFormat 支持的时间戳格式之一 'dd/MMM/yyyy：HH：mm：ss zzz'
'ddMMyy HH：mm：ss'
“ISO 8601”
'M/D/YYYY HH：MM：SS AM/PM'
'MMM d hh：mm：ss'
“Mon DD， YYYY HH：MM：SS”
'yyMMdd HH：mm：ss'
“YYYY-MM-DD HH：MM：SS”
'yyyy-MM-ddTHH：mm：ssK' （必需）

Microsoft.Insights/dataCollectionRules

名字 描述 价值
身份 资源的托管服务标识。 DataCollectionRuleResourceIdentity
类 资源的种类。 “Linux”
“Windows”
位置 资源所在的地理位置。 string （必需）
名字 资源名称 string （必需）
性能 资源属性。 DataCollectionRuleResourceProperties
标签 资源标记 标记名称和值的字典。
类型 资源类型 “Microsoft.Insights/dataCollectionRules@2022-06-01”

MonitoringAccountDestination

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

PerfCounterDataSource

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

PlatformTelemetryDataSource

名字 描述 价值
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 要收集的平台遥测流列表 string[] （必需）

PrometheusForwarderDataSource

名字 描述 价值
labelIncludeFilter 标签包含筛选器的列表，格式为标签“name-value”对。
目前仅支持一个标签：“microsoft_metrics_include_label”。
标签值不区分大小写。		 PrometheusForwarderDataSourceLabelIncludeFilter
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 此数据源将发送到的流列表。 包含任一项的字符串数组：
“Microsoft-PrometheusMetrics”

PrometheusForwarderDataSourceLabelIncludeFilter

名字 描述 价值

StorageBlobDestination

名字 描述 价值
containerName 存储 Blob 的容器名称。 字符串
名字 目标的友好名称。
此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。		 字符串
storageAccountResourceId 存储帐户的资源 ID。 字符串

StorageTableDestination

名字 描述 价值
名字 目标的友好名称。
此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。		 字符串
storageAccountResourceId 存储帐户的资源 ID。 字符串
tableName 存储表的名称。 字符串

StreamDeclaration

名字 描述 价值
列 此流中的数据使用的列列表。 ColumnDefinition[]

SyslogDataSource

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

UserAssignedIdentities

名字 描述 价值

UserAssignedIdentity

名字 描述 价值

WindowsEventLogDataSource

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

WindowsFirewallLogsDataSource

名字 描述 价值
名字 数据源的友好名称。
此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。		 字符串
流 防火墙日志流 string[] （必需）