Поделиться через

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

Имя Описание Ценность
имя Имя ресурса строка (обязательно)
местоположение Географическое расположение, в котором находится ресурс. строка (обязательно)
Теги Теги ресурсов. Словарь имен и значений тегов. См. теги в шаблонах
добрый Тип ресурса. Linux
"Windows"
свойства Свойства ресурса. DataCollectionRuleResourceProperties

DataCollectionRuleResourceProperties

Имя Описание Ценность
Потоки данных Спецификация потоков данных. DataFlow[]
dataSources Спецификация источников данных.
Это свойство является необязательным и может быть опущено, если правило предназначено для использования с помощью прямых вызовов подготовленной конечной точки.		 DataCollectionRuleDataSources
описание Описание правила сбора данных. струна
Направлений Спецификация назначений. DataCollectionRuleDestinations

Поток данных

Имя Описание Ценность
Направлений Список назначений для этого потока данных. string[]
Потоки Список потоков для этого потока данных. Массив строк, содержащий любой из:
"Microsoft-Event"
"Microsoft-InsightsMetrics"
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

DataCollectionRuleDataSources

Имя Описание Ценность
Расширения Список конфигураций источников данных расширения виртуальной машины Azure. ExtensionDataSource[]
performanceCounters Список конфигураций источников данных счетчика производительности. PerfCounterDataSource[]
системный журнал Список конфигураций источника данных системного журнала. SyslogDataSource[]
windowsEventLogs Список конфигураций источника данных журнала событий Windows. WindowsEventLogDataSource[]

ExtensionDataSource

Имя Описание Ценность
extensionName Имя расширения виртуальной машины. строка (обязательно)
extensionSettings Параметры расширения. Формат предназначен для конкретного расширения. Для Bicep можно использовать функцию any().
inputDataSources В списке источников данных этого расширения требуются данные. string[]
имя Понятное имя источника данных.
Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.		 струна
Потоки Список потоков, в которые будет отправлен этот источник данных.
Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
 Массив строк, содержащий любой из:
"Microsoft-Event"
"Microsoft-InsightsMetrics"
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

PerfCounterDataSource

Имя Описание Ценность
counterSpecifiers Список имен описатель счетчиков производительности, которые требуется собрать.
Используйте подстановочный знак (*) для сбора счетчика для всех экземпляров.
Чтобы получить список счетчиков производительности в Windows, выполните команду typeperf.		 string[]
имя Понятное имя источника данных.
Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.		 струна
выборкаFrequencyInSeconds Количество секунд между последовательными измерениями счетчиков (примерами). int
Потоки Список потоков, в которые будет отправлен этот источник данных.
Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
 Массив строк, содержащий любой из:
"Microsoft-InsightsMetrics"
Microsoft-Perf

SyslogDataSource

Имя Описание Ценность
facilityNames Список имен объектов. Массив строк, содержащий любой из:
'*'
"auth"
Authpriv
'cron'
"управляющая программа"
"kern"
Local0
"local1"
"local2"
"local3"
"local4"
Local5
Local6
"local7"
'lpr'
"почта"
"Mark"
"новости"
Syslog
"пользователь"
'uucp'
logLevels Уровни журнала для сбора. Массив строк, содержащий любой из:
'*'
"Оповещение"
"Критический"
"Отладка"
"Чрезвычайные ситуации"
"Ошибка"
"Info"
"Уведомление"
Предупреждение
имя Понятное имя источника данных.
Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.		 струна
Потоки Список потоков, в которые будет отправлен этот источник данных.
Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
 Массив строк, содержащий любой из:
Microsoft-Syslog

WindowsEventLogDataSource

Имя Описание Ценность
имя Понятное имя источника данных.
Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.		 струна
Потоки Список потоков, в которые будет отправлен этот источник данных.
Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.		 Массив строк, содержащий любой из:
"Microsoft-Event"
Microsoft-WindowsEvent
xPathQueries Список запросов журнала событий Windows в формате XPATH. string[]

DataCollectionRuleDestinations

Имя Описание Ценность
azureMonitorMetrics Назначение метрик Azure Monitor. DestinationsSpecAzureMonitorMetrics
LogAnalytics Список назначений Log Analytics. LogAnalyticsDestination[]

DestinationsSpecAzureMonitorMetrics

Имя Описание Ценность
имя Понятное имя назначения.
Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.
 струна

LogAnalyticsDestination

Имя Описание Ценность
имя Понятное имя назначения.
Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.		 струна
workspaceResourceId Идентификатор ресурса рабочей области Log Analytics. струна

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Развертывание vSensors autotrace autoscaling

развертывание в Azure		 Этот шаблон позволяет развертывать автоматическое развертывание vSensors Darktrace vSensors автоматически.
Правило сбора данных для системного журнала

развертывание в 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'
имя Имя ресурса строка (обязательно)
местоположение Географическое расположение, в котором находится ресурс. строка (обязательно)
Теги Теги ресурсов. Словарь имен и значений тегов. См. теги в шаблонах
добрый Тип ресурса. Linux
"Windows"
свойства Свойства ресурса. DataCollectionRuleResourceProperties

DataCollectionRuleResourceProperties

Имя Описание Ценность
Потоки данных Спецификация потоков данных. DataFlow[]
dataSources Спецификация источников данных.
Это свойство является необязательным и может быть опущено, если правило предназначено для использования с помощью прямых вызовов подготовленной конечной точки.		 DataCollectionRuleDataSources
описание Описание правила сбора данных. струна
Направлений Спецификация назначений. DataCollectionRuleDestinations

Поток данных

Имя Описание Ценность
Направлений Список назначений для этого потока данных. string[]
Потоки Список потоков для этого потока данных. Массив строк, содержащий любой из:
"Microsoft-Event"
"Microsoft-InsightsMetrics"
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

DataCollectionRuleDataSources

Имя Описание Ценность
Расширения Список конфигураций источников данных расширения виртуальной машины Azure. ExtensionDataSource[]
performanceCounters Список конфигураций источников данных счетчика производительности. PerfCounterDataSource[]
системный журнал Список конфигураций источника данных системного журнала. SyslogDataSource[]
windowsEventLogs Список конфигураций источника данных журнала событий Windows. WindowsEventLogDataSource[]

ExtensionDataSource

Имя Описание Ценность
extensionName Имя расширения виртуальной машины. строка (обязательно)
extensionSettings Параметры расширения. Формат предназначен для конкретного расширения.
inputDataSources В списке источников данных этого расширения требуются данные. string[]
имя Понятное имя источника данных.
Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.		 струна
Потоки Список потоков, в которые будет отправлен этот источник данных.
Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
 Массив строк, содержащий любой из:
"Microsoft-Event"
"Microsoft-InsightsMetrics"
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

PerfCounterDataSource

Имя Описание Ценность
counterSpecifiers Список имен описатель счетчиков производительности, которые требуется собрать.
Используйте подстановочный знак (*) для сбора счетчика для всех экземпляров.
Чтобы получить список счетчиков производительности в Windows, выполните команду typeperf.		 string[]
имя Понятное имя источника данных.
Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.		 струна
выборкаFrequencyInSeconds Количество секунд между последовательными измерениями счетчиков (примерами). int
Потоки Список потоков, в которые будет отправлен этот источник данных.
Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
 Массив строк, содержащий любой из:
"Microsoft-InsightsMetrics"
Microsoft-Perf

SyslogDataSource

Имя Описание Ценность
facilityNames Список имен объектов. Массив строк, содержащий любой из:
'*'
"auth"
Authpriv
'cron'
"управляющая программа"
"kern"
Local0
"local1"
"local2"
"local3"
"local4"
Local5
Local6
"local7"
'lpr'
"почта"
"Mark"
"новости"
Syslog
"пользователь"
'uucp'
logLevels Уровни журнала для сбора. Массив строк, содержащий любой из:
'*'
"Оповещение"
"Критический"
"Отладка"
"Чрезвычайные ситуации"
"Ошибка"
"Info"
"Уведомление"
Предупреждение
имя Понятное имя источника данных.
Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.		 струна
Потоки Список потоков, в которые будет отправлен этот источник данных.
Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
 Массив строк, содержащий любой из:
Microsoft-Syslog

WindowsEventLogDataSource

Имя Описание Ценность
имя Понятное имя источника данных.
Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.		 струна
Потоки Список потоков, в которые будет отправлен этот источник данных.
Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.		 Массив строк, содержащий любой из:
"Microsoft-Event"
Microsoft-WindowsEvent
xPathQueries Список запросов журнала событий Windows в формате XPATH. string[]

DataCollectionRuleDestinations

Имя Описание Ценность
azureMonitorMetrics Назначение метрик Azure Monitor. DestinationsSpecAzureMonitorMetrics
LogAnalytics Список назначений Log Analytics. LogAnalyticsDestination[]

DestinationsSpecAzureMonitorMetrics

Имя Описание Ценность
имя Понятное имя назначения.
Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.
 струна

LogAnalyticsDestination

Имя Описание Ценность
имя Понятное имя назначения.
Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.		 струна
workspaceResourceId Идентификатор ресурса рабочей области Log Analytics. струна

Шаблоны быстрого запуска

Следующие шаблоны быстрого запуска развертывают этот тип ресурса.

Шаблон Описание
Развертывание vSensors autotrace autoscaling

развертывание в Azure		 Этот шаблон позволяет развертывать автоматическое развертывание vSensors Darktrace vSensors автоматически.
Правило сбора данных для системного журнала

развертывание в 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"
имя Имя ресурса строка (обязательно)
местоположение Географическое расположение, в котором находится ресурс. строка (обязательно)
parent_id Чтобы развернуть в группе ресурсов, используйте идентификатор этой группы ресурсов. строка (обязательно)
Теги Теги ресурсов. Словарь имен и значений тегов.
добрый Тип ресурса. Linux
"Windows"
свойства Свойства ресурса. DataCollectionRuleResourceProperties

DataCollectionRuleResourceProperties

Имя Описание Ценность
Потоки данных Спецификация потоков данных. DataFlow[]
dataSources Спецификация источников данных.
Это свойство является необязательным и может быть опущено, если правило предназначено для использования с помощью прямых вызовов подготовленной конечной точки.		 DataCollectionRuleDataSources
описание Описание правила сбора данных. струна
Направлений Спецификация назначений. DataCollectionRuleDestinations

Поток данных

Имя Описание Ценность
Направлений Список назначений для этого потока данных. string[]
Потоки Список потоков для этого потока данных. Массив строк, содержащий любой из:
"Microsoft-Event"
"Microsoft-InsightsMetrics"
Microsoft-Perf
"Microsoft-Syslog"
Microsoft-WindowsEvent

DataCollectionRuleDataSources

Имя Описание Ценность
Расширения Список конфигураций источников данных расширения виртуальной машины Azure. ExtensionDataSource[]
performanceCounters Список конфигураций источников данных счетчика производительности. PerfCounterDataSource[]
системный журнал Список конфигураций источника данных системного журнала. SyslogDataSource[]
windowsEventLogs Список конфигураций источника данных журнала событий Windows. WindowsEventLogDataSource[]

ExtensionDataSource

Имя Описание Ценность
extensionName Имя расширения виртуальной машины. строка (обязательно)
extensionSettings Параметры расширения. Формат предназначен для конкретного расширения.
inputDataSources В списке источников данных этого расширения требуются данные. string[]
имя Понятное имя источника данных.
Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.		 струна
Потоки Список потоков, в которые будет отправлен этот источник данных.
Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
 Массив строк, содержащий любой из:
"Microsoft-Event"
"Microsoft-InsightsMetrics"
Microsoft-Perf
"Microsoft-Syslog"
Microsoft-WindowsEvent

PerfCounterDataSource

Имя Описание Ценность
counterSpecifiers Список имен описатель счетчиков производительности, которые требуется собрать.
Используйте подстановочный знак (*) для сбора счетчика для всех экземпляров.
Чтобы получить список счетчиков производительности в Windows, выполните команду typeperf.		 string[]
имя Понятное имя источника данных.
Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.		 струна
выборкаFrequencyInSeconds Количество секунд между последовательными измерениями счетчиков (примерами). int
Потоки Список потоков, в которые будет отправлен этот источник данных.
Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
 Массив строк, содержащий любой из:
"Microsoft-InsightsMetrics"
Microsoft-Perf

SyslogDataSource

Имя Описание Ценность
facilityNames Список имен объектов. Массив строк, содержащий любой из:
"*"
"auth"
Authpriv
"cron"
"управляющая программа"
"kern"
"local0"
"local1"
"local2"
"local3"
"local4"
"local5"
"local6"
"local7"
"lpr"
"почта"
"Mark"
"новости"
Syslog
"пользователь"
"uucp"
logLevels Уровни журнала для сбора. Массив строк, содержащий любой из:
"*"
"Оповещение"
"Критический"
"Отладка"
"Экстренное реагирование"
"Ошибка"
"Сведения"
"Уведомление"
"Предупреждение"
имя Понятное имя источника данных.
Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.		 струна
Потоки Список потоков, в которые будет отправлен этот источник данных.
Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
 Массив строк, содержащий любой из:
"Microsoft-Syslog"

WindowsEventLogDataSource

Имя Описание Ценность
имя Понятное имя источника данных.
Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.		 струна
Потоки Список потоков, в которые будет отправлен этот источник данных.
Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.		 Массив строк, содержащий любой из:
"Microsoft-Event"
Microsoft-WindowsEvent
xPathQueries Список запросов журнала событий Windows в формате XPATH. string[]

DataCollectionRuleDestinations

Имя Описание Ценность
azureMonitorMetrics Назначение метрик Azure Monitor. DestinationsSpecAzureMonitorMetrics
LogAnalytics Список назначений Log Analytics. LogAnalyticsDestination[]

DestinationsSpecAzureMonitorMetrics

Имя Описание Ценность
имя Понятное имя назначения.
Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.
 струна

LogAnalyticsDestination

Имя Описание Ценность
имя Понятное имя назначения.
Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.		 струна
workspaceResourceId Идентификатор ресурса рабочей области Log Analytics. струна