Data Collection Rules - Get

Служба:

Monitor

Версия API:

2024-03-11

Возвращает указанное правило сбора данных.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dataCollectionRuleName}?api-version=2024-03-11

Параметры URI

Имя	В	Обязательно	Тип	Описание
dataCollectionRuleName	path	True	string	Имя правила сбора данных. Имя не зависит от регистра.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Имя группы ресурсов. Имя не зависит от регистра.
subscriptionId	path	True	string minLength: 1	Идентификатор целевой подписки.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

Ответы

Имя	Тип	Описание
200 OK	DataCollectionRuleResource	Запрос выполнен успешно
Other Status Codes	ErrorResponseCommonV2	Ошибка

Безопасность

azure_auth

Поток OAuth2 Azure Active Directory

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

Get data collection rule

Образец запроса

HTTP

GET https://management.azure.com/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule?api-version=2024-03-11

Пример ответа

Код состояния:

200

{
  "id": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.Insights/dataCollectionRules/myCollectionRule",
  "name": "myCollectionRule",
  "type": "Microsoft.Insights/dataCollectionRules",
  "location": "eastus",
  "tags": {
    "tag1": "A",
    "tag2": "B"
  },
  "properties": {
    "immutableId": "dcr-b74e0d383fc9415abaa584ec41adece3",
    "dataSources": {
      "performanceCounters": [
        {
          "name": "cloudTeamCoreCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 15,
          "counterSpecifiers": [
            "\\Processor(_Total)\\% Processor Time",
            "\\Memory\\Committed Bytes",
            "\\LogicalDisk(_Total)\\Free Megabytes",
            "\\PhysicalDisk(_Total)\\Avg. Disk Queue Length"
          ]
        },
        {
          "name": "appTeamExtraCounters",
          "streams": [
            "Microsoft-Perf"
          ],
          "samplingFrequencyInSeconds": 30,
          "counterSpecifiers": [
            "\\Process(_Total)\\Thread Count"
          ]
        }
      ],
      "windowsEventLogs": [
        {
          "name": "cloudSecurityTeamEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "Security!"
          ]
        },
        {
          "name": "appTeam1AppEvents",
          "streams": [
            "Microsoft-WindowsEvent"
          ],
          "xPathQueries": [
            "System![System[(Level = 1 or Level = 2 or Level = 3)]]",
            "Application!*[System[(Level = 1 or Level = 2 or Level = 3)]]"
          ]
        }
      ],
      "syslog": [
        {
          "name": "cronSyslog",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "cron"
          ],
          "logLevels": [
            "Debug",
            "Critical",
            "Emergency"
          ]
        },
        {
          "name": "syslogBase",
          "streams": [
            "Microsoft-Syslog"
          ],
          "facilityNames": [
            "syslog"
          ],
          "logLevels": [
            "Alert",
            "Critical",
            "Emergency"
          ]
        }
      ]
    },
    "destinations": {
      "logAnalytics": [
        {
          "workspaceResourceId": "/subscriptions/703362b3-f278-4e4b-9179-c76eaf41ffc2/resourceGroups/myResourceGroup/providers/Microsoft.OperationalInsights/workspaces/centralTeamWorkspace",
          "workspaceId": "9ba8bc53-bd36-4156-8667-e983e7ae0e4f",
          "name": "centralWorkspace"
        }
      ]
    },
    "dataFlows": [
      {
        "streams": [
          "Microsoft-Perf",
          "Microsoft-Syslog",
          "Microsoft-WindowsEvent"
        ],
        "destinations": [
          "centralWorkspace"
        ]
      }
    ]
  },
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2021-04-01T12:34:56.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2021-04-02T12:34:56.1234567Z"
  },
  "etag": "070057da-0000-0000-0000-5ba70d6c0000"
}

Определения

Имя	Описание
AdxDestination	Azure Data Explorer (Adx) destination.
AgentSetting	Настройка, используемая для управления поведением агента на компьютере-хосте
AgentSettings	Параметры агента, используемые для изменения поведения агента на определенном узле
ApplicationInsights
AzureMonitorMetrics	Назначение метрик Azure Monitor.
ColumnDefinition	Определение пользовательского столбца данных.
createdByType	Тип удостоверения, создавшего ресурс.
DataCollectionRuleResource	Определение ARM-отслеживаемого ресурса верхнего уровня.
DataFlow	Определение того, какие потоки отправляются в какие пункты назначения.
DataImports	Спецификации источников данных на основе извлечения
DataSources	Спецификация источников данных. Это свойство является необязательным и может быть опущено, если правило предназначено для использования с помощью прямых вызовов подготовленной конечной точки.
Destinations	Спецификация назначений.
DirectDataSources	Спецификация прямых источников данных. Это свойство является необязательным и может быть опущено.
Endpoints	Определяет конечные точки для передачи данных по этому правилу.
EnrichmentData	Все источники данных обогащения, на которые ссылается потоки данных
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponseCommonV2	Ответ на ошибку
EtwProviderDataSource	Позволяет собирать журналы провайдера ETW с помощью этого правила сбора данных.
EventHub	Определение конфигурации Концентратора событий.
EventHubDestination
EventHubDirectDestination
ExtensionDataSource	Определение, какие данные будут собираться из отдельного расширения виртуальной машины, интегрируемого с Azure Monitor Agent. Собрано с машин с Windows или Linux, в зависимости от определенного расширения.
Identity	Управляемое удостоверение службы ресурса.
IisLogsDataSource	Позволяет собирать журналы IIS с помощью этого правила сбора данных.
IngestionQuotas	Спецификация для ограничений на поглощение
KnownAgentSettingName	Имя параметра. Должен быть частью списка поддерживаемых параметров
KnownColumnDefinitionType	Тип данных столбца.
KnownDataCollectionRuleProvisioningState	Состояние подготовки ресурсов.
KnownDataCollectionRuleResourceKind	Тип ресурса.
KnownDataFlowStreams	Список потоков для этого потока данных.
KnownEtwProviderDataSourceLogLevel	Минимальный уровень детализации для ведения журнала
KnownEtwProviderType	Спецификация типа поставщика: по идентификатору GUID манифеста или по имени источника события
KnownExtensionDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
KnownLogFilesDataSourceFormat	Формат данных файлов журнала
KnownLogFileTextSettingsRecordStartTimestampFormat	Один из поддерживаемых форматов меток времени
KnownOtelLogsDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных.
KnownOtelLogsDirectDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных.
KnownOtelTracesDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
KnownOtelTracesDirectDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
KnownPerfCounterDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
KnownPerformanceCountersOTelDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
KnownPrometheusForwarderDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных.
KnownStorageBlobLookupType	Тип подстановки, выполняемой в большом двоичном объекте
KnownSyslogDataSourceFacilityNames	Список имен объектов.
KnownSyslogDataSourceLogLevels	Уровни журнала для сбора.
KnownSyslogDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
KnownWindowsEventLogDataSourceStreams	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
KnownWindowsFirewallLogsDataSourceProfileFilter	Фильтр профиля журналов брандмауэра
LogAnalyticsDestination	Destination Log Analytics.
LogFilesDataSource	Определение, какие пользовательские файлы журналов будут собираться с помощью этого правила сбора данных
Logs
ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
Metadata	Метаданные о ресурсе
MicrosoftFabricDestination	Microsoft Fabric destination (non-Azure).
MonitoringAccountDestination	Мониторинг назначения аккаунта.
OtelLogsDataSource	Позволяет собирать логи Otel с помощью этого правила сбора данных.
OtelLogsDirectDataSource
OtelMetricsDataSource	Определение конфигурации метрик OTel.
OtelMetricsDirectDataSource	Определение конфигурации метрик OTel.
OtelTracesDataSource	Позволяет собирать Otel Traces с помощью этого правила сбора данных.
OtelTracesDirectDataSource	Позволяет собирать Otel Traces с помощью этого правила сбора данных.
PerfCounterDataSource	Определение того, какие счётчики эффективности будут собираться и как они будут собираться по этому правилу сбора данных. Собран с машин с Windows и Linux, где есть счётчик.
PerformanceCountersOTelDataSource	Определение того, какие счётчики производительности Open Telemetry будут собираться и как они будут собираться по этому правилу сбора данных. Собран с машин с Windows и Linux, где есть счётчик.
PlatformTelemetryDataSource	Определение конфигурации источника данных телеметрии платформы
PrometheusForwarderDataSource	Определение конфигурации пересылки метрик Prometheus.
References	Определяет все ссылки, которые могут использоваться в других разделах DCR
ResourceAttributeRouting	Указывает политику маршрутизации на основе атрибутов ресурса полезной нагрузки OTLP для маршрутизации подмножества полезных данных в соответствии с соответствующими атрибутами ресурсов.
Settings	Определенные параметры файлов журнала.
Sku	Определение модели ресурсов, представляющее номер SKU
SkuTier	Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.
StorageBlob
StorageBlobDestination
StorageTableDestination
StreamDeclaration	Объявление пользовательского потока.
SyslogDataSource	Определение того, какие syslog-данные будут собираться и как они будут собираться. Собрано только с Linux-машин.
SystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
Text	Параметры текста
UserAssignedIdentity	Свойства назначаемого пользователем удостоверения
WindowsEventLogDataSource	Определение, какие события Журнала событий Windows будут собираться и как они будут собираться. Собрано только с машин с Windows.
WindowsFirewallLogsDataSource	Позволяет собирать логи файрвола с помощью этого правила сбора данных.

AdxDestination

Объект

Azure Data Explorer (Adx) destination.

Имя	Тип	Описание
databaseName	string	Имя базы данных, в которую будут приема данных.
ingestionUri	string	Погружение uri ресурса Adx.
name	string	Понятное имя назначения. Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.
resourceId	string	Идентификатор ресурса ARM ресурса Adx.

AgentSetting

Объект

Настройка, используемая для управления поведением агента на компьютере-хосте

Имя	Тип	Описание
name	KnownAgentSettingName	Имя параметра. Должен быть частью списка поддерживаемых параметров
value	string	Значение параметра

AgentSettings

Объект

Параметры агента, используемые для изменения поведения агента на определенном узле

Имя	Тип	Описание
logs	AgentSetting[]	Все параметры, применимые к агенту журналов (AMA)

ApplicationInsights

Объект

Имя	Тип	Описание
name	string	Имя ссылки, используемой в качестве псевдонима при ссылке на аналитику этого приложения в источниках данных Otel
resourceId	string (arm-id)	Идентификатор ресурса Application Insights

AzureMonitorMetrics

Объект

Назначение метрик Azure Monitor.

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

ColumnDefinition

Объект

Определение пользовательского столбца данных.

Имя	Тип	Описание
name	string	Имя столбца.
type	KnownColumnDefinitionType	Тип данных столбца.

createdByType

Перечисление

Тип удостоверения, создавшего ресурс.

Значение	Описание
User
Application
ManagedIdentity
Key

DataCollectionRuleResource

Объект

Определение ARM-отслеживаемого ресурса верхнего уровня.

Имя	Тип	Описание
etag	string	Тег сущности ресурса (ETag).
id	string	Полностью квалифицированное удостоверение личности ресурса.
identity	Identity	Управляемое удостоверение службы ресурса.
kind	KnownDataCollectionRuleResourceKind	Тип ресурса.
location	string	Географическое расположение, в котором находится ресурс.
name	string	Имя ресурса.
properties.agentSettings	AgentSettings	Параметры агента, используемые для изменения поведения агента на определенном узле
properties.dataCollectionEndpointId	string	Идентификатор ресурса конечной точки сбора данных, с которым можно использовать это правило.
properties.dataFlows	DataFlow[]	Спецификация потоков данных.
properties.dataSources	DataSources	Спецификация источников данных. Это свойство является необязательным и может быть опущено, если правило предназначено для использования с помощью прямых вызовов подготовленной конечной точки.
properties.description	string	Описание правила сбора данных.
properties.destinations	Destinations	Спецификация назначений.
properties.directDataSources	DirectDataSources	Спецификация прямых источников данных. Это свойство является необязательным и может быть опущено.
properties.endpoints	Endpoints	Определяет конечные точки для передачи данных по этому правилу.
properties.immutableId	string	Неизменный идентификатор этого правила сбора данных. Это свойство — READ-ONLY.
properties.ingestionQuotas	IngestionQuotas	Спецификация для ограничений на поглощение
properties.metadata	Metadata	Метаданные о ресурсе
properties.provisioningState	KnownDataCollectionRuleProvisioningState	Состояние подготовки ресурсов.
properties.references	References	Определяет все ссылки, которые могут использоваться в других разделах DCR
properties.streamDeclarations	<string,  StreamDeclaration>	Объявление пользовательских потоков, используемых в этом правиле.
sku	Sku	Номер SKU ресурса.
systemData	SystemData	Метаданные, относящиеся к созданию и последнему изменении ресурса.
tags	object	Теги ресурсов.
type	string	Тип ресурса.

DataFlow

Объект

Определение того, какие потоки отправляются в какие пункты назначения.

Имя	Тип	Описание
builtInTransform	string	Преобразование builtIn для преобразования потоковой передачи данных
captureOverflow	boolean	Флаг для включения столбца переполнения в местах назначения LA
destinations	string[]	Список назначений для этого потока данных.
outputStream	string	Выходной поток преобразования. Требуется только в том случае, если преобразование изменяет данные в другой поток.
streams	KnownDataFlowStreams[]	Список потоков для этого потока данных.
transformKql	string	Запрос KQL для преобразования потоковой передачи данных.

DataImports

Объект

Спецификации источников данных на основе извлечения

Имя	Тип	Описание
eventHub	EventHub	Определение конфигурации Концентратора событий.

DataSources

Объект

Спецификация источников данных. Это свойство является необязательным и может быть опущено, если правило предназначено для использования с помощью прямых вызовов подготовленной конечной точки.

Имя	Тип	Описание
dataImports	DataImports	Спецификации источников данных на основе извлечения
etwProviders	EtwProviderDataSource[]	Список конфигураций источников данных поставщиков трассировки событий Windows.
extensions	ExtensionDataSource[]	Список конфигураций источников данных расширения виртуальной машины Azure.
iisLogs	IisLogsDataSource[]	Список исходных конфигураций журналов IIS.
logFiles	LogFilesDataSource[]	Список исходных конфигураций файлов журнала.
otelLogs	OtelLogsDataSource[]	Список конфигураций источников данных Otel Logs.
otelMetrics	OtelMetricsDataSource[]	Список конфигураций источников данных метрик OTel.
otelTraces	OtelTracesDataSource[]	Список конфигураций источников данных трассировок Otel.
performanceCounters	PerfCounterDataSource[]	Список конфигураций источников данных счетчика производительности.
performanceCountersOTel	PerformanceCountersOTelDataSource[]	Список конфигураций источника данных счетчика производительности Open Telemetry.
platformTelemetry	PlatformTelemetryDataSource[]	Список конфигураций телеметрии платформы
prometheusForwarder	PrometheusForwarderDataSource[]	Список конфигураций источника данных пересылки Prometheus.
syslog	SyslogDataSource[]	Список конфигураций источника данных системного журнала.
windowsEventLogs	WindowsEventLogDataSource[]	Список конфигураций источника данных журнала событий Windows.
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	Список исходных конфигураций брандмауэра Windows.

Destinations

Объект

Спецификация назначений.

Имя	Тип	Описание
azureDataExplorer	AdxDestination[]	Список назначений Azure Data Explorer.
azureMonitorMetrics	AzureMonitorMetrics	Назначение метрик Azure Monitor.
eventHubs	EventHubDestination[]	Список назначений Центров событий.
eventHubsDirect	EventHubDirectDestination[]	Список назначений Центров событий Direct.
logAnalytics	LogAnalyticsDestination[]	Список назначений Log Analytics.
microsoftFabric	MicrosoftFabricDestination[]	Список назначений Microsoft Fabric.
monitoringAccounts	MonitoringAccountDestination[]	Список назначений учетной записи мониторинга.
storageAccounts	StorageBlobDestination[]	Список назначений учетных записей хранения.
storageBlobsDirect	StorageBlobDestination[]	Список целевых объектов BLOB-объектов хранилища. Использование только для отправки данных непосредственно в хранилище из агента.
storageTablesDirect	StorageTableDestination[]	Список назначений прямой таблицы хранилища.

DirectDataSources

Объект

Спецификация прямых источников данных. Это свойство является необязательным и может быть опущено.

Имя	Тип	Описание
otelLogs	OtelLogsDirectDataSource[]	Список конфигураций источников данных журналов OTel.
otelMetrics	OtelMetricsDirectDataSource[]	Список конфигураций источников данных метрик OTel.
otelTraces	OtelTracesDirectDataSource[]	Список конфигураций источников данных трассировок OTel.

Endpoints

Объект

Определяет конечные точки для передачи данных по этому правилу.

Имя	Тип	Описание
logsIngestion	string	Конечная точка погружения для логов
metricsIngestion	string	Конечная точка погружения для метрик

EnrichmentData

Объект

Все источники данных обогащения, на которые ссылается потоки данных

Имя	Тип	Описание
storageBlobs	StorageBlob[]	Все большие двоичные объекты хранилища, используемые в качестве источников данных обогащения

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя	Тип	Описание
info	object	Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

Сведения об ошибке.

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponseCommonV2

Объект

Ответ на ошибку

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

EtwProviderDataSource

Объект

Позволяет собирать журналы провайдера ETW с помощью этого правила сбора данных.

Имя	Тип	Описание
eventIds	string[]	Идентификаторы событий для сбора
keyword	string	Участие в мероприятии в наборе категорий событий
logLevel	KnownEtwProviderDataSourceLogLevel	Минимальный уровень детализации для ведения журнала
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
provider	string	GUID поставщика или имя класса для источника событий
providerType	KnownEtwProviderType	Спецификация типа поставщика: по идентификатору GUID манифеста или по имени источника события
streams	string[]	Список потоков, в которые будет отправляться данный источник данных

EventHub

Объект

Определение конфигурации Концентратора событий.

Имя	Тип	Описание
consumerGroup	string	Имя группы потребителей концентратора событий
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
stream	string	Поток для сбора из EventHub

EventHubDestination

Объект

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

EventHubDirectDestination

Объект

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

ExtensionDataSource

Объект

Определение, какие данные будут собираться из отдельного расширения виртуальной машины, интегрируемого с Azure Monitor Agent. Собрано с машин с Windows или Linux, в зависимости от определенного расширения.

Имя	Тип	Описание
extensionName	string	Имя расширения виртуальной машины.
extensionSettings	object	Параметры расширения. Формат предназначен для конкретного расширения.
inputDataSources	string[]	В списке источников данных этого расширения требуются данные.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
streams	KnownExtensionDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.

Identity

Объект

Управляемое удостоверение службы ресурса.

Имя	Тип	Описание
principalId	string (uuid)	Идентификатор субъекта-службы назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
tenantId	string (uuid)	Идентификатор клиента назначенного системой удостоверения. Это свойство будет предоставлено только для назначаемого системой удостоверения.
type	ManagedServiceIdentityType	Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).
userAssignedIdentities	<string,  UserAssignedIdentity>	удостоверения User-Assigned Набор назначенных пользователем удостоверений, связанных с ресурсом. Ключи словаря userAssignedIdentities будут идентификаторами ресурсов ARM в форме: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Значения словаря могут быть пустыми объектами ({}) в запросах.

IisLogsDataSource

Объект

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

Имя	Тип	Описание
logDirectories	string[]	Расположение файла абсолютных путей
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
streams	string[]	Потоки IIS
transformKql	string	Запрос KQL для преобразования источника данных. Это устаревшее свойство и будет удалено в будущих версиях.

IngestionQuotas

Объект

Спецификация для ограничений на поглощение

Имя	Тип	Описание
logs	Logs

KnownAgentSettingName

Перечисление

Имя параметра. Должен быть частью списка поддерживаемых параметров

Значение	Описание
MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents
Tags

KnownColumnDefinitionType

Перечисление

Тип данных столбца.

Значение	Описание
string
int
long
real
boolean
datetime
dynamic

KnownDataCollectionRuleProvisioningState

Перечисление

Состояние подготовки ресурсов.

Значение	Описание
Creating
Updating
Deleting
Succeeded
Canceled
Failed

KnownDataCollectionRuleResourceKind

Перечисление

Тип ресурса.

Значение	Описание
Linux
Windows

KnownDataFlowStreams

Перечисление

Список потоков для этого потока данных.

Значение	Описание
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownEtwProviderDataSourceLogLevel

Перечисление

Минимальный уровень детализации для ведения журнала

Значение	Описание
Critical
Error
Warning
Informational
Verbose

KnownEtwProviderType

Перечисление

Спецификация типа поставщика: по идентификатору GUID манифеста или по имени источника события

Значение	Описание
EventSource
Manifest

KnownExtensionDataSourceStreams

Перечисление

Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.

Значение	Описание
Microsoft-Event
Microsoft-InsightsMetrics
Microsoft-Perf
Microsoft-Syslog
Microsoft-WindowsEvent

KnownLogFilesDataSourceFormat

Перечисление

Формат данных файлов журнала

Значение	Описание
json
text

KnownLogFileTextSettingsRecordStartTimestampFormat

Перечисление

Один из поддерживаемых форматов меток времени

Значение	Описание
ISO 8601
YYYY-MM-DD HH:MM:SS
M/D/YYYY HH:MM:SS AM/PM
Mon DD, YYYY HH:MM:SS
yyMMdd HH:mm:ss
ddMMyy HH:mm:ss
MMM d hh:mm:ss
dd/MMM/yyyy:HH:mm:ss zzz
yyyy-MM-ddTHH:mm:ssK

KnownOtelLogsDataSourceStreams

Перечисление

Список потоков, в которые будет отправлен этот источник данных.

Значение	Описание
Microsoft-OTel-Logs

KnownOtelLogsDirectDataSourceStreams

Перечисление

Список потоков, в которые будет отправлен этот источник данных.

Значение	Описание
Microsoft-OTel-Logs

KnownOtelTracesDataSourceStreams

Перечисление

Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.

Значение	Описание
Microsoft-OTel-Traces-Spans
Microsoft-OTel-Traces-Events
Microsoft-OTel-Traces-Resources

KnownOtelTracesDirectDataSourceStreams

Перечисление

Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.

Значение	Описание
Microsoft-OTel-Traces-Spans
Microsoft-OTel-Traces-Events
Microsoft-OTel-Traces-Resources

KnownPerfCounterDataSourceStreams

Перечисление

Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.

Значение	Описание
Microsoft-Perf
Microsoft-InsightsMetrics

KnownPerformanceCountersOTelDataSourceStreams

Перечисление

Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.

Значение	Описание
Microsoft-OtelPerfMetrics

KnownPrometheusForwarderDataSourceStreams

Перечисление

Список потоков, в которые будет отправлен этот источник данных.

Значение	Описание
Microsoft-PrometheusMetrics

KnownStorageBlobLookupType

Перечисление

Тип подстановки, выполняемой в большом двоичном объекте

Значение	Описание
String
Cidr

KnownSyslogDataSourceFacilityNames

Перечисление

Список имен объектов.

Значение	Описание
*
alert
audit
auth
authpriv
clock
cron
daemon
ftp
kern
local0
local1
local2
local3
local4
local5
local6
local7
lpr
mail
mark
news
nopri
ntp
syslog
user
uucp

KnownSyslogDataSourceLogLevels

Перечисление

Уровни журнала для сбора.

Значение	Описание
Debug
Info
Notice
Warning
Error
Critical
Alert
Emergency
*

KnownSyslogDataSourceStreams

Перечисление

Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.

Значение	Описание
Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

Перечисление

Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.

Значение	Описание
Microsoft-WindowsEvent
Microsoft-Event

KnownWindowsFirewallLogsDataSourceProfileFilter

Перечисление

Фильтр профиля журналов брандмауэра

Значение	Описание
Domain
Private
Public

LogAnalyticsDestination

Объект

Destination Log Analytics.

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

LogFilesDataSource

Объект

Определение, какие пользовательские файлы журналов будут собираться с помощью этого правила сбора данных

Имя	Тип	Описание
filePatterns	string[]	Шаблоны файлов, в которых находятся файлы журнала
format	KnownLogFilesDataSourceFormat	Формат данных файлов журнала
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
settings	Settings	Определенные параметры файлов журнала.
streams	string[]	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этого источника данных
transformKql	string	Запрос KQL для преобразования источника данных. Это устаревшее свойство и будет удалено в будущих версиях.

Logs

Объект

Имя	Тип	Описание
maxRequestsPerMinute	string
maxSizePerMinuteInGB	string

ManagedServiceIdentityType

Перечисление

Тип управляемого удостоверения службы (где разрешены типы SystemAssigned и UserAssigned).

Значение	Описание
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

Metadata

Объект

Метаданные о ресурсе

Имя	Тип	Описание
provisionedBy	string	Azure предлагает управление этим ресурсом от имени клиента.
provisionedByImmutableId	string	Immutable ID Azure предлагает управление этим ресурсом от имени клиента.
provisionedByResourceId	string	Идентификатор ресурса Azure предлагает управление этим ресурсом от имени клиента.

MicrosoftFabricDestination

Объект

Microsoft Fabric destination (non-Azure).

Имя	Тип	Описание
artifactId	string	Идентификатор артефакта ресурса Microsoft Fabric.
databaseName	string	Имя базы данных, в которую будут приема данных.
ingestionUri	string	URI приема ресурса Microsoft Fabric.
name	string	Понятное имя назначения. Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.
tenantId	string	Идентификатор клиента ресурса Microsoft Fabric.

MonitoringAccountDestination

Объект

Мониторинг назначения аккаунта.

Имя	Тип	Описание
accountId	string	Неизменяемый идентификатор аккаунта.
accountResourceId	string	Идентификатор ресурса учетной записи мониторинга.
name	string	Понятное имя назначения. Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.

OtelLogsDataSource

Объект

Позволяет собирать логи Otel с помощью этого правила сбора данных.

Имя	Тип	Описание
enrichWithReference	string	Указывает ссылочный псевдоним для обогащения сигнала телеметрии.
enrichWithResourceAttributes	string[]	Указывает список атрибутов ресурса, которые необходимо добавить в качестве меток или измерений в данные телеметрии для дальнейшего обогащения.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
replaceResourceIdWithReference	boolean	Указывает, следует ли заменять идентификатор ресурса по умолчанию в записи журнала на идентификатор ресурса, на который ссылается ресурс, используемый для обогащения.
resourceAttributeRouting	ResourceAttributeRouting	Указывает политику маршрутизации на основе атрибутов ресурса полезной нагрузки OTLP для маршрутизации подмножества полезных данных в соответствии с соответствующими атрибутами ресурсов.
streams	KnownOtelLogsDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных.

OtelLogsDirectDataSource

Объект

Имя	Тип	Описание
enrichWithReference	string	Указывает ссылку для обогащения сигнала телеметрии.
enrichWithResourceAttributes	string[]	Указывает список атрибутов ресурса, которые необходимо добавить в качестве меток или измерений в данные телеметрии для дальнейшего обогащения.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
replaceResourceIdWithReference	boolean	Указывает, следует ли заменять идентификатор ресурса по умолчанию в записи журнала на идентификатор ресурса, на который ссылается ресурс, используемый для обогащения.
streams	KnownOtelLogsDirectDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных.

OtelMetricsDataSource

Объект

Определение конфигурации метрик OTel.

Имя	Тип	Описание
enrichWithReference	string	Указывает ссылку для обогащения сигнала телеметрии.
enrichWithResourceAttributes	string[]	Указывает список атрибутов ресурса, которые необходимо добавить в качестве меток или измерений в данные телеметрии для дальнейшего обогащения.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
resourceAttributeRouting	ResourceAttributeRouting	Указывает политику маршрутизации на основе атрибутов ресурса полезной нагрузки OTLP для маршрутизации подмножества полезных данных в соответствии с соответствующими атрибутами ресурсов.
streams	string[]	Список потоков, в которые будет отправлен этот источник данных.

OtelMetricsDirectDataSource

Объект

Определение конфигурации метрик OTel.

Имя	Тип	Описание
enrichWithReference	string	Указывает ссылку для обогащения сигнала телеметрии.
enrichWithResourceAttributes	string[]	Указывает список атрибутов ресурса, которые необходимо добавить в качестве меток или измерений в данные телеметрии для дальнейшего обогащения.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
streams	string[]	Список потоков, в которые будет отправлен этот источник данных.

OtelTracesDataSource

Объект

Позволяет собирать Otel Traces с помощью этого правила сбора данных.

Имя	Тип	Описание
enrichWithReference	string	Указывает ссылку для обогащения сигнала телеметрии.
enrichWithResourceAttributes	string[]	Указывает список атрибутов ресурса, которые необходимо добавить в качестве меток или измерений в данные телеметрии для дальнейшего обогащения.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
replaceResourceIdWithReference	boolean	Указывает, следует ли заменять идентификатор ресурса по умолчанию в записи журнала на идентификатор ресурса, на который ссылается ресурс, используемый для обогащения.
resourceAttributeRouting	ResourceAttributeRouting	Указывает политику маршрутизации на основе атрибутов ресурса полезной нагрузки OTLP для маршрутизации подмножества полезных данных в соответствии с соответствующими атрибутами ресурсов.
streams	KnownOtelTracesDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.

OtelTracesDirectDataSource

Объект

Позволяет собирать Otel Traces с помощью этого правила сбора данных.

Имя	Тип	Описание
enrichWithReference	string	Указывает ссылку для обогащения сигнала телеметрии.
enrichWithResourceAttributes	string[]	Указывает список атрибутов ресурса, которые необходимо добавить в качестве меток или измерений в данные телеметрии для дальнейшего обогащения.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
replaceResourceIdWithReference	boolean	Указывает, следует ли заменять идентификатор ресурса по умолчанию в записи журнала на идентификатор ресурса, на который ссылается ресурс, используемый для обогащения.
streams	KnownOtelTracesDirectDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.

PerfCounterDataSource

Объект

Определение того, какие счётчики эффективности будут собираться и как они будут собираться по этому правилу сбора данных. Собран с машин с Windows и Linux, где есть счётчик.

Имя	Тип	Описание
counterSpecifiers	string[]	Список имен описатель счетчиков производительности, которые требуется собрать. Используйте подстановочный знак (*) для сбора счетчика для всех экземпляров. Чтобы получить список счетчиков производительности в Windows, выполните команду typeperf.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
samplingFrequencyInSeconds	integer (int32)	Количество секунд между последовательными измерениями счетчиков (примерами).
streams	KnownPerfCounterDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
transformKql	string	Запрос KQL для преобразования источника данных. Это устаревшее свойство и будет удалено в будущих версиях.

PerformanceCountersOTelDataSource

Объект

Определение того, какие счётчики производительности Open Telemetry будут собираться и как они будут собираться по этому правилу сбора данных. Собран с машин с Windows и Linux, где есть счётчик.

Имя	Тип	Описание
counterSpecifiers	string[]	Список имен описатель счетчиков производительности, которые требуется собрать.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
samplingFrequencyInSeconds	integer (int32)	Количество секунд между последовательными измерениями счетчиков (примерами).
streams	KnownPerformanceCountersOTelDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.

PlatformTelemetryDataSource

Объект

Определение конфигурации источника данных телеметрии платформы

Имя	Тип	Описание
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
streams	string[]	Список потоков телеметрии платформы для сбора

PrometheusForwarderDataSource

Объект

Определение конфигурации пересылки метрик Prometheus.

Имя	Тип	Описание
customVMScrapeConfig	object[]	Пользовательская конфигурация очистки виртуальной машины, определяющая задания парсинга
labelIncludeFilter	object	Список фильтров включения меток в виде пар "name-value". В настоящее время поддерживается только одна метка: "microsoft_metrics_include_label". Значения меток совпадают без учета регистра.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
streams	KnownPrometheusForwarderDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных.

References

Объект

Определяет все ссылки, которые могут использоваться в других разделах DCR

Имя	Тип	Описание
applicationInsights	ApplicationInsights[]	Ссылки на Application Insights для использования при обогащении метрик и журналов OTel
enrichmentData	EnrichmentData	Все источники данных обогащения, на которые ссылается потоки данных

ResourceAttributeRouting

Объект

Указывает политику маршрутизации на основе атрибутов ресурса полезной нагрузки OTLP для маршрутизации подмножества полезных данных в соответствии с соответствующими атрибутами ресурсов.

Имя	Тип	Описание
attributeName	string	Имя соответствующего атрибута ресурса.
attributeValue	string	Значение атрибута resource для сопоставления.

Settings

Объект

Определенные параметры файлов журнала.

Имя	Тип	Описание
text	Text	Параметры текста

Sku

Объект

Определение модели ресурсов, представляющее номер SKU

Имя	Тип	Описание
capacity	integer (int32)	Если номер SKU поддерживает горизонтальное масштабирование или в, то целое число емкости должно быть включено. Если горизонтальное масштабирование невозможно для ресурса, это может быть опущено.
family	string	Если служба имеет разные поколения оборудования для одного номера SKU, это можно записать здесь.
name	string	Имя номера SKU. Например, P3. Обычно это код буквы и числа
size	string	Размер номера SKU. Если поле имени является сочетанием уровня и другого значения, это будет автономный код.
tier	SkuTier	Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.

SkuTier

Перечисление

Это поле необходимо реализовать поставщиком ресурсов, если служба имеет несколько уровней, но не требуется для PUT.

Значение	Описание
Free
Basic
Standard
Premium

StorageBlob

Объект

Имя	Тип	Описание
blobUrl	string	URL-адрес большого двоичного объекта хранилища
lookupType	KnownStorageBlobLookupType	Тип подстановки, выполняемой в большом двоичном объекте
name	string	Имя источника данных обогащения, используемого в качестве псевдонима при ссылке на этот источник данных в потоках данных
resourceId	string	Идентификатор ресурса учетной записи хранения, на котором размещен большой двоичный объект

StorageBlobDestination

Объект

Имя	Тип	Описание
containerName	string	Имя контейнера BLOB-объекта хранилища.
name	string	Понятное имя назначения. Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.
storageAccountResourceId	string	Идентификатор ресурса учетной записи хранения.

StorageTableDestination

Объект

Имя	Тип	Описание
name	string	Понятное имя назначения. Это имя должно быть уникальным для всех назначений (независимо от типа) в правиле сбора данных.
storageAccountResourceId	string	Идентификатор ресурса учетной записи хранения.
tableName	string	Имя таблицы хранилища.

StreamDeclaration

Объект

Объявление пользовательского потока.

Имя	Тип	Описание
columns	ColumnDefinition[]	Список столбцов, используемых данными в этом потоке.

SyslogDataSource

Объект

Определение того, какие syslog-данные будут собираться и как они будут собираться. Собрано только с Linux-машин.

Имя	Тип	Описание
facilityNames	KnownSyslogDataSourceFacilityNames[]	Список имен объектов.
logLevels	KnownSyslogDataSourceLogLevels[]	Уровни журнала для сбора.
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
streams	KnownSyslogDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
transformKql	string	Запрос KQL для преобразования источника данных. Это устаревшее свойство и будет удалено в будущих версиях.

SystemData

Объект

Метаданные, относящиеся к созданию и последнему изменении ресурса.

Имя	Тип	Описание
createdAt	string (date-time)	Метка времени создания ресурса (UTC).
createdBy	string	Удостоверение, создающее ресурс.
createdByType	createdByType	Тип удостоверения, создавшего ресурс.
lastModifiedAt	string (date-time)	Временная метка последнего изменения ресурса (UTC)
lastModifiedBy	string	Идентификатор, который последний раз изменил ресурс.
lastModifiedByType	createdByType	Тип удостоверения, который последний раз изменил ресурс.

Text

Объект

Параметры текста

Имя	Тип	Описание
recordStartTimestampFormat	KnownLogFileTextSettingsRecordStartTimestampFormat	Один из поддерживаемых форматов меток времени

UserAssignedIdentity

Объект

Свойства назначаемого пользователем удостоверения

Имя	Тип	Описание
clientId	string (uuid)	Идентификатор клиента назначенного удостоверения.
principalId	string (uuid)	Основной идентификатор назначенного удостоверения.

WindowsEventLogDataSource

Объект

Определение, какие события Журнала событий Windows будут собираться и как они будут собираться. Собрано только с машин с Windows.

Имя	Тип	Описание
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
streams	KnownWindowsEventLogDataSourceStreams[]	Список потоков, в которые будет отправлен этот источник данных. Поток указывает, какая схема будет использоваться для этих данных и обычно какая таблица в Log Analytics будет отправлена.
transformKql	string	Запрос KQL для преобразования источника данных. Это устаревшее свойство и будет удалено в будущих версиях.
xPathQueries	string[]	Список запросов журнала событий Windows в формате XPATH.

WindowsFirewallLogsDataSource

Объект

Позволяет собирать логи файрвола с помощью этого правила сбора данных.

Имя	Тип	Описание
name	string	Понятное имя источника данных. Это имя должно быть уникальным для всех источников данных (независимо от типа) в правиле сбора данных.
profileFilter	KnownWindowsFirewallLogsDataSourceProfileFilter[]	Фильтр профиля журналов брандмауэра
streams	string[]	Потоки журналов брандмауэра