Microsoft.Insights dataCollectionRules 2021-09-01-preview
- nejnovější
- 11. 3. 2023
-
2022-06-01 - z 9. 9. 2021 ve verzi Preview
-
2021-04-01 -
11. 11. 2019
Definice prostředku Bicep
Typ prostředku dataCollectionRules je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Insights/dataCollectionRules, přidejte do šablony následující bicep.
resource symbolicname 'Microsoft.Insights/dataCollectionRules@2021-09-01-preview' = {
name: 'string'
location: 'string'
tags: {
tagName1: 'tagValue1'
tagName2: 'tagValue2'
}
kind: 'string'
properties: {
dataCollectionEndpointId: 'string'
dataFlows: [
{
destinations: [
'string'
]
outputStream: 'string'
streams: [
'string'
]
transformKql: 'string'
}
]
dataSources: {
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'
]
}
]
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'
}
]
}
streamDeclarations: {
{customized property}: {
columns: [
{
name: 'string'
type: 'string'
}
]
}
}
}
}
Hodnoty vlastností
dataCollectionRules
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Název prostředku | string (povinné) |
umístění | Geografické umístění, ve kterém se nachází zdroj. | string (povinné) |
visačky | Značky prostředků | Slovník názvů a hodnot značek Viz Značky v šablonách |
laskavý | Druh prostředku. | Linux Windows |
vlastnosti | Vlastnosti prostředku. | DataCollectionRuleResourceProperties |
DataCollectionRuleResourceProperties
Jméno | Popis | Hodnota |
---|---|---|
dataCollectionEndpointId | ID prostředku koncového bodu shromažďování dat, se kterým se toto pravidlo dá použít. | řetězec |
toky dat | Specifikace toků dat. | toku dat[] |
zdroje dat | Specifikace zdrojů dat. Tato vlastnost je volitelná a je možné ji vynechat, pokud je pravidlo určené k použití prostřednictvím přímých volání zřízeného koncového bodu. |
DataCollectionRuleDataSources |
popis | Popis pravidla shromažďování dat | řetězec |
místa určení | Specifikace cílů. | DataCollectionRuleDestinations |
streamDeclarations | Deklarace vlastních datových proudů používaných v tomto pravidle | DataCollectionRuleStreamDeclarations |
Dataflow
Jméno | Popis | Hodnota |
---|---|---|
místa určení | Seznam cílů pro tento tok dat | string[] |
outputStream | Výstupní datový proud transformace. Vyžaduje se pouze v případě, že transformace změní data na jiný datový proud. | řetězec |
proudy | Seznam datových proudů pro tento tok dat | Řetězcové pole obsahující některou z těchto možností: Microsoft-Event Microsoft-InsightsMetrics Microsoft-Perf Microsoft-Syslog Microsoft-WindowsEvent |
transformKql | Dotaz KQL pro transformaci dat datového proudu. | řetězec |
DataCollectionRuleDataSources
Jméno | Popis | Hodnota |
---|---|---|
rozšíření | Seznam konfigurací zdrojů dat rozšíření virtuálního počítače Azure | ExtensionDataSource[] |
iisLogs | Seznam zdrojových konfigurací protokolů služby IIS. | IisLogsDataSource[] |
logFiles | Seznam zdrojových konfigurací souborů protokolu. | LogFilesDataSource[] |
performanceCounters | Seznam konfigurací zdrojů dat čítače výkonu. | PerfCounterDataSource[] |
Syslog | Seznam konfigurací zdrojů dat Syslog. | SyslogDataSource[] |
windowsEventLogs | Seznam konfigurací zdrojů dat protokolu událostí systému Windows. | WindowsEventLogDataSource[] |
ExtensionDataSource
Jméno | Popis | Hodnota |
---|---|---|
extensionName | Název rozšíření virtuálního počítače | string (povinné) |
extensionSettings | Nastavení rozšíření. Formát je specifický pro konkrétní rozšíření. | Pro Bicep můžete použít funkci any(). |
inputDataSources | Seznam zdrojů dat, ze které toto rozšíření potřebuje data. | string[] |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají. |
Řetězcové pole obsahující některou z těchto možností: Microsoft-Event Microsoft-InsightsMetrics Microsoft-Perf Microsoft-Syslog Microsoft-WindowsEvent |
IisLogsDataSource
Jméno | Popis | Hodnota |
---|---|---|
logDirectories | Absolutní umístění souboru cest | string[] |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
proudy | Streamy služby IIS | string[] (povinné) |
LogFilesDataSource
Jméno | Popis | Hodnota |
---|---|---|
FilePatterns | Vzory souborů, ve kterých se nacházejí soubory protokolu | string[] (povinné) |
formát | Formát dat souborů protokolu | Text (povinné) |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
nastavení | Nastavení specifické pro soubory protokolu. | LogFilesDataSourceSettings |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, jaké schéma se použije pro tento zdroj dat. |
string[] (povinné) |
LogFilesDataSourceSettings
Jméno | Popis | Hodnota |
---|---|---|
Text | Nastavení textu | LogFileSettingsText |
LogFileSettingsText
Jméno | Popis | Hodnota |
---|---|---|
recordStartTimestampFormat | Jeden z podporovaných formátů časového razítka | "ISO 8601" "M/D/YYYY HH: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' (povinné) |
PerfCounterDataSource
Jméno | Popis | Hodnota |
---|---|---|
counterSpecifiers | Seznam názvů specifikátorů čítačů výkonu, které chcete shromáždit. K shromáždění čítače pro všechny instance použijte zástupný znak (*). Pokud chcete získat seznam čítačů výkonu ve Windows, spusťte příkaz typeperf. |
string[] |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
samplingFrequencyInSeconds | Počet sekund mezi po sobě jdoucími měřeními čítače (vzorky). | Int |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají. |
Řetězcové pole obsahující některou z těchto možností: Microsoft-InsightsMetrics Microsoft-Perf |
SyslogDataSource
Jméno | Popis | Hodnota |
---|---|---|
facilityNames | Seznam názvů zařízení. | Řetězcové pole obsahující některou z těchto možností: '*' Ověřování authpriv "cron" Démon "Kern" Local0 Local1 Local2 Local3 Local4 Local5 Local6 Local7 "lpr" "pošta" "mark" 'novinky' Syslog Uživatel 'uucp' |
logLevels | Úrovně protokolů, které se mají shromažďovat. | Řetězcové pole obsahující některou z těchto možností: '*' Výstraha Kritické Ladění "Tísňové volání" Chyba Informace "Oznámení" "Upozornění" |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají. |
Řetězcové pole obsahující některou z těchto možností: Microsoft-Syslog |
WindowsEventLogDataSource
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají. |
Řetězcové pole obsahující některou z těchto možností: Microsoft-Event Microsoft-WindowsEvent |
xPathQueries | Seznam dotazů protokolu událostí systému Windows ve formátu XPATH. | string[] |
DataCollectionRuleDestinations
Jméno | Popis | Hodnota |
---|---|---|
azureMonitorMetrics | Cíl metrik služby Azure Monitor. | DestinationsSpecAzureMonitorMetrics |
LogAnalytics | Seznam cílů Log Analytics | LogAnalyticsDestination[] |
DestinationsSpecAzureMonitorMetrics
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat. |
řetězec |
LogAnalyticsDestination
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat. |
řetězec |
workspaceResourceId | ID prostředku pracovního prostoru služby Log Analytics. | řetězec |
DataCollectionRuleStreamDeclarations
Jméno | Popis | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | StreamDeclaration |
StreamDeclaration
Jméno | Popis | Hodnota |
---|---|---|
sloupce | Seznam sloupců používaných daty v tomto datovém proudu | ColumnDefinition[] |
ColumnDefinition
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Název sloupce. | řetězec |
typ | Typ dat sloupce. | "logická hodnota" Datetime Dynamická "int" "long" "skutečný" Řetězec |
Šablony pro rychlý start
Následující šablony pro rychlý start nasazují tento typ prostředku.
Šablona | Popis |
---|---|
nasazení automatického škálování tmavých tras vSensors nasazení |
Tato šablona umožňuje nasadit automaticky škálovat nasazení darktrace vSensors. |
Pravidlo shromažďování dat pro Syslog nasazení |
Tato šablona vytvoří pravidlo shromažďování dat definující zdroj dat (Syslog) a cílový pracovní prostor. |
Definice prostředku šablony ARM
Typ prostředku dataCollectionRules je možné nasadit s operacemi, které cílí:
- skupiny prostředků – viz příkazy nasazení skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Insights/dataCollectionRules, přidejte do šablony následující JSON.
{
"type": "Microsoft.Insights/dataCollectionRules",
"apiVersion": "2021-09-01-preview",
"name": "string",
"location": "string",
"tags": {
"tagName1": "tagValue1",
"tagName2": "tagValue2"
},
"kind": "string",
"properties": {
"dataCollectionEndpointId": "string",
"dataFlows": [
{
"destinations": [ "string" ],
"outputStream": "string",
"streams": [ "string" ],
"transformKql": "string"
}
],
"dataSources": {
"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" ]
}
],
"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"
}
]
},
"streamDeclarations": {
"{customized property}": {
"columns": [
{
"name": "string",
"type": "string"
}
]
}
}
}
}
Hodnoty vlastností
dataCollectionRules
Jméno | Popis | Hodnota |
---|---|---|
typ | Typ prostředku | Microsoft.Insights/dataCollectionRules |
apiVersion | Verze rozhraní API prostředku | 2021-09-01-preview |
Jméno | Název prostředku | string (povinné) |
umístění | Geografické umístění, ve kterém se nachází zdroj. | string (povinné) |
visačky | Značky prostředků | Slovník názvů a hodnot značek Viz Značky v šablonách |
laskavý | Druh prostředku. | Linux Windows |
vlastnosti | Vlastnosti prostředku. | DataCollectionRuleResourceProperties |
DataCollectionRuleResourceProperties
Jméno | Popis | Hodnota |
---|---|---|
dataCollectionEndpointId | ID prostředku koncového bodu shromažďování dat, se kterým se toto pravidlo dá použít. | řetězec |
toky dat | Specifikace toků dat. | toku dat[] |
zdroje dat | Specifikace zdrojů dat. Tato vlastnost je volitelná a je možné ji vynechat, pokud je pravidlo určené k použití prostřednictvím přímých volání zřízeného koncového bodu. |
DataCollectionRuleDataSources |
popis | Popis pravidla shromažďování dat | řetězec |
místa určení | Specifikace cílů. | DataCollectionRuleDestinations |
streamDeclarations | Deklarace vlastních datových proudů používaných v tomto pravidle | DataCollectionRuleStreamDeclarations |
Dataflow
Jméno | Popis | Hodnota |
---|---|---|
místa určení | Seznam cílů pro tento tok dat | string[] |
outputStream | Výstupní datový proud transformace. Vyžaduje se pouze v případě, že transformace změní data na jiný datový proud. | řetězec |
proudy | Seznam datových proudů pro tento tok dat | Řetězcové pole obsahující některou z těchto možností: Microsoft-Event Microsoft-InsightsMetrics Microsoft-Perf Microsoft-Syslog Microsoft-WindowsEvent |
transformKql | Dotaz KQL pro transformaci dat datového proudu. | řetězec |
DataCollectionRuleDataSources
Jméno | Popis | Hodnota |
---|---|---|
rozšíření | Seznam konfigurací zdrojů dat rozšíření virtuálního počítače Azure | ExtensionDataSource[] |
iisLogs | Seznam zdrojových konfigurací protokolů služby IIS. | IisLogsDataSource[] |
logFiles | Seznam zdrojových konfigurací souborů protokolu. | LogFilesDataSource[] |
performanceCounters | Seznam konfigurací zdrojů dat čítače výkonu. | PerfCounterDataSource[] |
Syslog | Seznam konfigurací zdrojů dat Syslog. | SyslogDataSource[] |
windowsEventLogs | Seznam konfigurací zdrojů dat protokolu událostí systému Windows. | WindowsEventLogDataSource[] |
ExtensionDataSource
Jméno | Popis | Hodnota |
---|---|---|
extensionName | Název rozšíření virtuálního počítače | string (povinné) |
extensionSettings | Nastavení rozšíření. Formát je specifický pro konkrétní rozšíření. | |
inputDataSources | Seznam zdrojů dat, ze které toto rozšíření potřebuje data. | string[] |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají. |
Řetězcové pole obsahující některou z těchto možností: Microsoft-Event Microsoft-InsightsMetrics Microsoft-Perf Microsoft-Syslog Microsoft-WindowsEvent |
IisLogsDataSource
Jméno | Popis | Hodnota |
---|---|---|
logDirectories | Absolutní umístění souboru cest | string[] |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
proudy | Streamy služby IIS | string[] (povinné) |
LogFilesDataSource
Jméno | Popis | Hodnota |
---|---|---|
FilePatterns | Vzory souborů, ve kterých se nacházejí soubory protokolu | string[] (povinné) |
formát | Formát dat souborů protokolu | Text (povinné) |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
nastavení | Nastavení specifické pro soubory protokolu. | LogFilesDataSourceSettings |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, jaké schéma se použije pro tento zdroj dat. |
string[] (povinné) |
LogFilesDataSourceSettings
Jméno | Popis | Hodnota |
---|---|---|
Text | Nastavení textu | LogFileSettingsText |
LogFileSettingsText
Jméno | Popis | Hodnota |
---|---|---|
recordStartTimestampFormat | Jeden z podporovaných formátů časového razítka | "ISO 8601" "M/D/YYYY HH: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' (povinné) |
PerfCounterDataSource
Jméno | Popis | Hodnota |
---|---|---|
counterSpecifiers | Seznam názvů specifikátorů čítačů výkonu, které chcete shromáždit. K shromáždění čítače pro všechny instance použijte zástupný znak (*). Pokud chcete získat seznam čítačů výkonu ve Windows, spusťte příkaz typeperf. |
string[] |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
samplingFrequencyInSeconds | Počet sekund mezi po sobě jdoucími měřeními čítače (vzorky). | Int |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají. |
Řetězcové pole obsahující některou z těchto možností: Microsoft-InsightsMetrics Microsoft-Perf |
SyslogDataSource
Jméno | Popis | Hodnota |
---|---|---|
facilityNames | Seznam názvů zařízení. | Řetězcové pole obsahující některou z těchto možností: '*' Ověřování authpriv "cron" Démon "Kern" Local0 Local1 Local2 Local3 Local4 Local5 Local6 Local7 "lpr" "pošta" "mark" 'novinky' Syslog Uživatel 'uucp' |
logLevels | Úrovně protokolů, které se mají shromažďovat. | Řetězcové pole obsahující některou z těchto možností: '*' Výstraha Kritické Ladění "Tísňové volání" Chyba Informace "Oznámení" "Upozornění" |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají. |
Řetězcové pole obsahující některou z těchto možností: Microsoft-Syslog |
WindowsEventLogDataSource
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají. |
Řetězcové pole obsahující některou z těchto možností: Microsoft-Event Microsoft-WindowsEvent |
xPathQueries | Seznam dotazů protokolu událostí systému Windows ve formátu XPATH. | string[] |
DataCollectionRuleDestinations
Jméno | Popis | Hodnota |
---|---|---|
azureMonitorMetrics | Cíl metrik služby Azure Monitor. | DestinationsSpecAzureMonitorMetrics |
LogAnalytics | Seznam cílů Log Analytics | LogAnalyticsDestination[] |
DestinationsSpecAzureMonitorMetrics
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat. |
řetězec |
LogAnalyticsDestination
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat. |
řetězec |
workspaceResourceId | ID prostředku pracovního prostoru služby Log Analytics. | řetězec |
DataCollectionRuleStreamDeclarations
Jméno | Popis | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | StreamDeclaration |
StreamDeclaration
Jméno | Popis | Hodnota |
---|---|---|
sloupce | Seznam sloupců používaných daty v tomto datovém proudu | ColumnDefinition[] |
ColumnDefinition
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Název sloupce. | řetězec |
typ | Typ dat sloupce. | "logická hodnota" Datetime Dynamická "int" "long" "skutečný" Řetězec |
Šablony pro rychlý start
Následující šablony pro rychlý start nasazují tento typ prostředku.
Šablona | Popis |
---|---|
nasazení automatického škálování tmavých tras vSensors nasazení |
Tato šablona umožňuje nasadit automaticky škálovat nasazení darktrace vSensors. |
Pravidlo shromažďování dat pro Syslog nasazení |
Tato šablona vytvoří pravidlo shromažďování dat definující zdroj dat (Syslog) a cílový pracovní prostor. |
Definice prostředku Terraformu (poskytovatel AzAPI)
Typ prostředku dataCollectionRules je možné nasadit s operacemi, které cílí:
- skupiny prostředků
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.
Formát prostředku
Pokud chcete vytvořit prostředek Microsoft.Insights/dataCollectionRules, přidejte do šablony následující Terraform.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Insights/dataCollectionRules@2021-09-01-preview"
name = "string"
location = "string"
parent_id = "string"
tags = {
tagName1 = "tagValue1"
tagName2 = "tagValue2"
}
body = jsonencode({
properties = {
dataCollectionEndpointId = "string"
dataFlows = [
{
destinations = [
"string"
]
outputStream = "string"
streams = [
"string"
]
transformKql = "string"
}
]
dataSources = {
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"
]
}
]
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"
}
]
}
streamDeclarations = {
{customized property} = {
columns = [
{
name = "string"
type = "string"
}
]
}
}
}
kind = "string"
})
}
Hodnoty vlastností
dataCollectionRules
Jméno | Popis | Hodnota |
---|---|---|
typ | Typ prostředku | Microsoft.Insights/dataCollectionRules@2021-09-01-preview |
Jméno | Název prostředku | string (povinné) |
umístění | Geografické umístění, ve kterém se nachází zdroj. | string (povinné) |
parent_id | K nasazení do skupiny prostředků použijte ID této skupiny prostředků. | string (povinné) |
visačky | Značky prostředků | Slovník názvů a hodnot značek |
laskavý | Druh prostředku. | "Linux" "Windows" |
vlastnosti | Vlastnosti prostředku. | DataCollectionRuleResourceProperties |
DataCollectionRuleResourceProperties
Jméno | Popis | Hodnota |
---|---|---|
dataCollectionEndpointId | ID prostředku koncového bodu shromažďování dat, se kterým se toto pravidlo dá použít. | řetězec |
toky dat | Specifikace toků dat. | toku dat[] |
zdroje dat | Specifikace zdrojů dat. Tato vlastnost je volitelná a je možné ji vynechat, pokud je pravidlo určené k použití prostřednictvím přímých volání zřízeného koncového bodu. |
DataCollectionRuleDataSources |
popis | Popis pravidla shromažďování dat | řetězec |
místa určení | Specifikace cílů. | DataCollectionRuleDestinations |
streamDeclarations | Deklarace vlastních datových proudů používaných v tomto pravidle | DataCollectionRuleStreamDeclarations |
Dataflow
Jméno | Popis | Hodnota |
---|---|---|
místa určení | Seznam cílů pro tento tok dat | string[] |
outputStream | Výstupní datový proud transformace. Vyžaduje se pouze v případě, že transformace změní data na jiný datový proud. | řetězec |
proudy | Seznam datových proudů pro tento tok dat | Řetězcové pole obsahující některou z těchto možností: "Microsoft-Event" Microsoft-InsightsMetrics "Microsoft-Perf" "Microsoft-Syslog" "Microsoft-WindowsEvent" |
transformKql | Dotaz KQL pro transformaci dat datového proudu. | řetězec |
DataCollectionRuleDataSources
Jméno | Popis | Hodnota |
---|---|---|
rozšíření | Seznam konfigurací zdrojů dat rozšíření virtuálního počítače Azure | ExtensionDataSource[] |
iisLogs | Seznam zdrojových konfigurací protokolů služby IIS. | IisLogsDataSource[] |
logFiles | Seznam zdrojových konfigurací souborů protokolu. | LogFilesDataSource[] |
performanceCounters | Seznam konfigurací zdrojů dat čítače výkonu. | PerfCounterDataSource[] |
Syslog | Seznam konfigurací zdrojů dat Syslog. | SyslogDataSource[] |
windowsEventLogs | Seznam konfigurací zdrojů dat protokolu událostí systému Windows. | WindowsEventLogDataSource[] |
ExtensionDataSource
Jméno | Popis | Hodnota |
---|---|---|
extensionName | Název rozšíření virtuálního počítače | string (povinné) |
extensionSettings | Nastavení rozšíření. Formát je specifický pro konkrétní rozšíření. | |
inputDataSources | Seznam zdrojů dat, ze které toto rozšíření potřebuje data. | string[] |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají. |
Řetězcové pole obsahující některou z těchto možností: "Microsoft-Event" Microsoft-InsightsMetrics "Microsoft-Perf" "Microsoft-Syslog" "Microsoft-WindowsEvent" |
IisLogsDataSource
Jméno | Popis | Hodnota |
---|---|---|
logDirectories | Absolutní umístění souboru cest | string[] |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
proudy | Streamy služby IIS | string[] (povinné) |
LogFilesDataSource
Jméno | Popis | Hodnota |
---|---|---|
FilePatterns | Vzory souborů, ve kterých se nacházejí soubory protokolu | string[] (povinné) |
formát | Formát dat souborů protokolu | "text" (povinné) |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
nastavení | Nastavení specifické pro soubory protokolu. | LogFilesDataSourceSettings |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, jaké schéma se použije pro tento zdroj dat. |
string[] (povinné) |
LogFilesDataSourceSettings
Jméno | Popis | Hodnota |
---|---|---|
Text | Nastavení textu | LogFileSettingsText |
LogFileSettingsText
Jméno | Popis | Hodnota |
---|---|---|
recordStartTimestampFormat | Jeden z podporovaných formátů časového razítka | "ISO 8601" "M/D/YYYY HH: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" "yyMMDdD HH:mm:ss" "yyyy-MM-ddTHH:mm:ssK" (povinné) |
PerfCounterDataSource
Jméno | Popis | Hodnota |
---|---|---|
counterSpecifiers | Seznam názvů specifikátorů čítačů výkonu, které chcete shromáždit. K shromáždění čítače pro všechny instance použijte zástupný znak (*). Pokud chcete získat seznam čítačů výkonu ve Windows, spusťte příkaz typeperf. |
string[] |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
samplingFrequencyInSeconds | Počet sekund mezi po sobě jdoucími měřeními čítače (vzorky). | Int |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají. |
Řetězcové pole obsahující některou z těchto možností: Microsoft-InsightsMetrics "Microsoft-Perf" |
SyslogDataSource
Jméno | Popis | Hodnota |
---|---|---|
facilityNames | Seznam názvů zařízení. | Řetězcové pole obsahující některou z těchto možností: "*" "ověřování" "authpriv" "cron" "démon" "kern" "local0" "local1" "local2" "local3" "local4" "local5" "local6" "local7" "lpr" "pošta" "mark" "novinky" "syslog" "uživatel" "uucp" |
logLevels | Úrovně protokolů, které se mají shromažďovat. | Řetězcové pole obsahující některou z těchto možností: "*" "Výstraha" "Kritické" "Ladit" "Tísňové volání" "Chyba" "Informace" "Oznámení" "Upozornění" |
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají. |
Řetězcové pole obsahující některou z těchto možností: "Microsoft-Syslog" |
WindowsEventLogDataSource
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Popisný název zdroje dat Tento název by měl být jedinečný pro všechny zdroje dat (bez ohledu na typ) v pravidle shromažďování dat. |
řetězec |
proudy | Seznam datových proudů, na které bude tento zdroj dat odeslán. Datový proud označuje, do jakého schématu se pro tato data použije a do jaké tabulky se data v Log Analytics posílají. |
Řetězcové pole obsahující některou z těchto možností: "Microsoft-Event" "Microsoft-WindowsEvent" |
xPathQueries | Seznam dotazů protokolu událostí systému Windows ve formátu XPATH. | string[] |
DataCollectionRuleDestinations
Jméno | Popis | Hodnota |
---|---|---|
azureMonitorMetrics | Cíl metrik služby Azure Monitor. | DestinationsSpecAzureMonitorMetrics |
LogAnalytics | Seznam cílů Log Analytics | LogAnalyticsDestination[] |
DestinationsSpecAzureMonitorMetrics
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat. |
řetězec |
LogAnalyticsDestination
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Popisný název cíle. Tento název by měl být jedinečný pro všechny cíle (bez ohledu na typ) v rámci pravidla shromažďování dat. |
řetězec |
workspaceResourceId | ID prostředku pracovního prostoru služby Log Analytics. | řetězec |
DataCollectionRuleStreamDeclarations
Jméno | Popis | Hodnota |
---|---|---|
{přizpůsobená vlastnost} | StreamDeclaration |
StreamDeclaration
Jméno | Popis | Hodnota |
---|---|---|
sloupce | Seznam sloupců používaných daty v tomto datovém proudu | ColumnDefinition[] |
ColumnDefinition
Jméno | Popis | Hodnota |
---|---|---|
Jméno | Název sloupce. | řetězec |
typ | Typ dat sloupce. | "boolean" "datetime" "dynamická" "int" "long" "skutečný" "string" |