Microsoft.Insights dataCollectionRules 2021-04-01
Bicep 資源定義
dataCollectionRules 資源類型可以使用目標作業來部署:
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Insights/dataCollectionRules 資源,請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.Insights/dataCollectionRules@2021-04-01' = {
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
名字 | 描述 | 價值 |
---|---|---|
名字 | 資源名稱 | 字串 (必要) |
位置 | 資源所在的地理位置。 | 字串 (必要) |
標籤 | 資源標籤。 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
類 | 資源的種類。 | '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 擴充功能的名稱。 | 字串 (必要) |
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 | 設施名稱的清單。 | 包含任何的字串數組: '*' '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' 'Notice' 'Warning' |
名字 | 數據源的易記名稱。 此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。 |
字串 |
流 | 此數據源將傳送至的數據流清單。 數據流會指出將針對此數據使用哪些架構,而且通常會在Log Analytics中將數據傳送至哪個數據表。 |
包含任何的字串數組: 'Microsoft-Syslog' |
WindowsEventLogDataSource
名字 | 描述 | 價值 |
---|---|---|
名字 | 數據源的易記名稱。 此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。 |
字串 |
流 | 此數據源將傳送至的數據流清單。 數據流會指出將針對此數據使用哪些架構,而且通常會在Log Analytics中將數據傳送至哪個數據表。 |
包含任何的字串數組: 'Microsoft-Event' 'Microsoft-WindowsEvent' |
xPathQueries | XPATH 格式的 Windows 事件記錄檔查詢清單。 | string[] |
DataCollectionRuleDestinations
名字 | 描述 | 價值 |
---|---|---|
azureMonitorMetrics | Azure 監視器計量目的地。 | DestinationsSpecAzureMonitorMetrics |
logAnalytics | Log Analytics 目的地清單。 | LogAnalyticsDestination[] |
DestinationsSpecAzureMonitorMetrics
名字 | 描述 | 價值 |
---|---|---|
名字 | 目的地的易記名稱。 此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。 |
字串 |
LogAnalyticsDestination
名字 | 描述 | 價值 |
---|---|---|
名字 | 目的地的易記名稱。 此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。 |
字串 |
workspaceResourceId | Log Analytics 工作區的資源標識碼。 | 字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
範本 | 描述 |
---|---|
部署深色追蹤自動調整 vSensors |
此範本可讓您部署 Darktrace vSensors 的自動自動調整部署 |
Syslog 的 |
此範本會建立定義數據來源 (Syslog) 和目的地工作區的數據收集規則。 |
ARM 樣本資源定義
dataCollectionRules 資源類型可以使用目標作業來部署:
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Insights/dataCollectionRules 資源,請將下列 JSON 新增至範本。
{
"type": "Microsoft.Insights/dataCollectionRules",
"apiVersion": "2021-04-01",
"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 版本 | '2021-04-01' |
名字 | 資源名稱 | 字串 (必要) |
位置 | 資源所在的地理位置。 | 字串 (必要) |
標籤 | 資源標籤。 | 標記名稱和值的字典。 請參閱範本中的 標籤 |
類 | 資源的種類。 | '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 擴充功能的名稱。 | 字串 (必要) |
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 | 設施名稱的清單。 | 包含任何的字串數組: '*' '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' 'Notice' 'Warning' |
名字 | 數據源的易記名稱。 此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。 |
字串 |
流 | 此數據源將傳送至的數據流清單。 數據流會指出將針對此數據使用哪些架構,而且通常會在Log Analytics中將數據傳送至哪個數據表。 |
包含任何的字串數組: 'Microsoft-Syslog' |
WindowsEventLogDataSource
名字 | 描述 | 價值 |
---|---|---|
名字 | 數據源的易記名稱。 此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。 |
字串 |
流 | 此數據源將傳送至的數據流清單。 數據流會指出將針對此數據使用哪些架構,而且通常會在Log Analytics中將數據傳送至哪個數據表。 |
包含任何的字串數組: 'Microsoft-Event' 'Microsoft-WindowsEvent' |
xPathQueries | XPATH 格式的 Windows 事件記錄檔查詢清單。 | string[] |
DataCollectionRuleDestinations
名字 | 描述 | 價值 |
---|---|---|
azureMonitorMetrics | Azure 監視器計量目的地。 | DestinationsSpecAzureMonitorMetrics |
logAnalytics | Log Analytics 目的地清單。 | LogAnalyticsDestination[] |
DestinationsSpecAzureMonitorMetrics
名字 | 描述 | 價值 |
---|---|---|
名字 | 目的地的易記名稱。 此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。 |
字串 |
LogAnalyticsDestination
名字 | 描述 | 價值 |
---|---|---|
名字 | 目的地的易記名稱。 此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。 |
字串 |
workspaceResourceId | Log Analytics 工作區的資源標識碼。 | 字串 |
快速入門範本
下列快速入門範本會部署此資源類型。
範本 | 描述 |
---|---|
部署深色追蹤自動調整 vSensors |
此範本可讓您部署 Darktrace vSensors 的自動自動調整部署 |
Syslog 的 |
此範本會建立定義數據來源 (Syslog) 和目的地工作區的數據收集規則。 |
Terraform (AzAPI 提供者) 資源定義
dataCollectionRules 資源類型可以使用目標作業來部署:
- 資源群組
如需每個 API 版本中已變更屬性的清單,請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.Insights/dataCollectionRules 資源,請將下列 Terraform 新增至範本。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Insights/dataCollectionRules@2021-04-01"
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@2021-04-01” |
名字 | 資源名稱 | 字串 (必要) |
位置 | 資源所在的地理位置。 | 字串 (必要) |
parent_id | 若要部署至資源群組,請使用該資源群組的標識碼。 | 字串 (必要) |
標籤 | 資源標籤。 | 標記名稱和值的字典。 |
類 | 資源的種類。 | “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 擴充功能的名稱。 | 字串 (必要) |
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 | 設施名稱的清單。 | 包含任何的字串數組: "*" “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” |
WindowsEventLogDataSource
名字 | 描述 | 價值 |
---|---|---|
名字 | 數據源的易記名稱。 此名稱在數據收集規則內的所有數據源中都應該是唯一的。不論類型為何。 |
字串 |
流 | 此數據源將傳送至的數據流清單。 數據流會指出將針對此數據使用哪些架構,而且通常會在Log Analytics中將數據傳送至哪個數據表。 |
包含任何的字串數組: “Microsoft-Event” “Microsoft-WindowsEvent” |
xPathQueries | XPATH 格式的 Windows 事件記錄檔查詢清單。 | string[] |
DataCollectionRuleDestinations
名字 | 描述 | 價值 |
---|---|---|
azureMonitorMetrics | Azure 監視器計量目的地。 | DestinationsSpecAzureMonitorMetrics |
logAnalytics | Log Analytics 目的地清單。 | LogAnalyticsDestination[] |
DestinationsSpecAzureMonitorMetrics
名字 | 描述 | 價值 |
---|---|---|
名字 | 目的地的易記名稱。 此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。 |
字串 |
LogAnalyticsDestination
名字 | 描述 | 價值 |
---|---|---|
名字 | 目的地的易記名稱。 此名稱在數據收集規則內的所有目的地中都應該是唯一的。不論類型為何。 |
字串 |
workspaceResourceId | Log Analytics 工作區的資源標識碼。 | 字串 |