Microsoft.Insights dataCollectionПравила 2022-06-01

Определение ресурсов Bicep

Тип ресурса dataCollectionRules можно развернуть с помощью операций, предназначенных для следующих целей:

• группы ресурсов . См. команды развертывания группы ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Примеры использования

Примеры Bicep

Простой пример развертывания правила сбора данных.

param location string = 'westeurope'
param resourceName string = 'acctest0001'

resource dataCollectionRule 'Microsoft.Insights/dataCollectionRules@2022-06-01' = {
  name: resourceName
  location: location
  properties: {
    dataFlows: [
      {
        destinations: [
          'test-destination-metrics'
        ]
        streams: [
          'Microsoft-InsightsMetrics'
        ]
      }
    ]
    description: ''
    destinations: {
      azureMonitorMetrics: {
        name: 'test-destination-metrics'
      }
    }
  }
}

Проверенные модули Azure

Следующие проверенные модули Azure можно использовать для развертывания этого типа ресурсов.

Примеры быстрого запуска Azure

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

Формат ресурса

Чтобы создать ресурс 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(...)
          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'
  }
}

Значения свойств

Microsoft.Insights/dataCollectionRules (Правила Microsoft.Insights/dataCollection)

Определение столбца

DataCollectionRuleDataSources

НазначенияDataCollectionRuleDestinations

DataCollectionRuleResourceIdentity (Идентификация ресурса)

Свойства ресурса DataCollectionRuleResource

Теги ресурсовDataCollectionRuleResource

DataCollectionRuleStreamDeclarations (Объявления DataCollectionRuleStream)

Поток данных

DataImportSourcesEventHub (ИсточникиEventHub)

DataSourcesSpecDataImports

DestinationsSpecAzureMonitorMetrics

EventHubDestination (Место назначения)

EventHubDirectDestination (Событийный концентратор)

ExtensionDataSource (Источник данных)

Источник данных IisLogsDataSource

Назначение LogAnalytics

LogFilesDataSource

LogFilesDataSourceSettings (Файлы журналаDataSourceSettings)

LogFileSettingsText

MonitoringAccountDestination (Место назначения)

PerfCounterDataSource

ПлатформаТелеметрияИсточник данных

PrometheusForwarderDataSource

PrometheusForwarderDataSourceLabelIncludeFilter

StorageBlobDestination (StorageBlobDestination)

StorageTableDestination (Место назначения)

StreamDeclaration

SyslogDataSource (Источник системных данных)

UserAssignedIdentity (Пользовательские идентификаторы)

Пользовательская назначенная идентичность

WindowsEventLogDataSource

WindowsFirewallLogsDataSource

Определение ресурса шаблона ARM

Тип ресурса dataCollectionRules можно развернуть с помощью операций, предназначенных для следующих целей:

• Группы ресурсов — см. команды развертывания групп ресурсов Для списка изменённых свойств в каждой версии API см. журнал изменений.

Примеры использования

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

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

Шаблон	Описание
Правило сбора данных для системного журнала развертывание	Этот шаблон создает правило сбора данных, определяющее источник данных (Syslog) и целевую рабочую область.
Развертывание vSensors autotrace autoscaling развертывание	Этот шаблон позволяет развертывать автоматическое развертывание vSensors Darktrace vSensors автоматически.
Развертывание Secure AI Foundry с помощью управляемой виртуальной сети развертывание	Этот шаблон создает безопасную среду Azure AI Foundry с надежными ограничениями безопасности сети и удостоверений.

Формат ресурса

Чтобы создать ресурс 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"
  }
}

Значения свойств

Microsoft.Insights/dataCollectionRules (Правила Microsoft.Insights/dataCollection)

Определение столбца

DataCollectionRuleDataSources

НазначенияDataCollectionRuleDestinations

DataCollectionRuleResourceIdentity (Идентификация ресурса)

Свойства ресурса DataCollectionRuleResource

Теги ресурсовDataCollectionRuleResource

DataCollectionRuleStreamDeclarations (Объявления DataCollectionRuleStream)

Поток данных

DataImportSourcesEventHub (ИсточникиEventHub)

DataSourcesSpecDataImports

DestinationsSpecAzureMonitorMetrics

EventHubDestination (Место назначения)

EventHubDirectDestination (Событийный концентратор)

ExtensionDataSource (Источник данных)

Источник данных IisLogsDataSource

Назначение LogAnalytics

LogFilesDataSource

LogFilesDataSourceSettings (Файлы журналаDataSourceSettings)

LogFileSettingsText

MonitoringAccountDestination (Место назначения)

PerfCounterDataSource

ПлатформаТелеметрияИсточник данных

PrometheusForwarderDataSource

PrometheusForwarderDataSourceLabelIncludeFilter

StorageBlobDestination (StorageBlobDestination)

StorageTableDestination (Место назначения)

StreamDeclaration

SyslogDataSource (Источник системных данных)

UserAssignedIdentity (Пользовательские идентификаторы)

Пользовательская назначенная идентичность

WindowsEventLogDataSource

WindowsFirewallLogsDataSource

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса dataCollectionRules можно развернуть с помощью операций, предназначенных для следующих целей:

• Группы ресурсов Список изменённых свойств в каждой версии API см. журнал изменений.

Примеры использования

Примеры Terraform

Простой пример развертывания правила сбора данных.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "dataCollectionRule" {
  type      = "Microsoft.Insights/dataCollectionRules@2022-06-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      dataFlows = [
        {
          destinations = [
            "test-destination-metrics",
          ]
          streams = [
            "Microsoft-InsightsMetrics",
          ]
        },
      ]
      description = ""
      destinations = {
        azureMonitorMetrics = {
          name = "test-destination-metrics"
        }
      }
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

Формат ресурса

Чтобы создать ресурс Microsoft.Insights/dataCollectionRules, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Insights/dataCollectionRules@2022-06-01"
  name = "string"
  parent_id = "string"
  identity {
    type = "string"
    identity_ids = [
      "string"
    ]
  }
  location = "string"
  tags = {
    {customized property} = "string"
  }
  body = {
    kind = "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"
            }
          ]
        }
      }
    }
  }
}

Значения свойств

Microsoft.Insights/dataCollectionRules (Правила Microsoft.Insights/dataCollection)

Определение столбца

DataCollectionRuleDataSources

НазначенияDataCollectionRuleDestinations

DataCollectionRuleResourceIdentity (Идентификация ресурса)

Свойства ресурса DataCollectionRuleResource

Теги ресурсовDataCollectionRuleResource

DataCollectionRuleStreamDeclarations (Объявления DataCollectionRuleStream)

Поток данных

DataImportSourcesEventHub (ИсточникиEventHub)

DataSourcesSpecDataImports

DestinationsSpecAzureMonitorMetrics

EventHubDestination (Место назначения)

EventHubDirectDestination (Событийный концентратор)

ExtensionDataSource (Источник данных)

Источник данных IisLogsDataSource

Назначение LogAnalytics

LogFilesDataSource

LogFilesDataSourceSettings (Файлы журналаDataSourceSettings)

LogFileSettingsText

MonitoringAccountDestination (Место назначения)

PerfCounterDataSource

ПлатформаТелеметрияИсточник данных

PrometheusForwarderDataSource

PrometheusForwarderDataSourceLabelIncludeFilter

StorageBlobDestination (StorageBlobDestination)

StorageTableDestination (Место назначения)

StreamDeclaration

SyslogDataSource (Источник системных данных)

UserAssignedIdentity (Пользовательские идентификаторы)

Пользовательская назначенная идентичность

WindowsEventLogDataSource

WindowsFirewallLogsDataSource