你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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	目标订阅的 ID。
api-version	query	True	string minLength: 1	要用于此操作的 API 版本。

响应

名称	类型	说明
200 OK	DataCollectionRuleResource	Azure 运营顺利完成。
Other Status Codes	ErrorResponseCommonV2	意外的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 Flow.

类型: oauth2
流向: 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

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

定义

名称	说明
AdxDestination	Azure Data Explorer （Adx） destination.
AgentSetting	用于控制主机上代理行为的设置
ApplicationInsights
ColumnDefinition	自定义数据列的定义。
createdByType	创建资源的标识的类型。
DataCollectionRuleAgentSettings	用于修改给定主机上的代理行为的代理设置
DataCollectionRuleDataSources	数据源的规范。此属性是可选的，如果规则旨在通过对预配的终结点的直接调用使用，则可以省略此属性。
DataCollectionRuleDestinations	目标的规范。
DataCollectionRuleDirectDataSources	直接数据源的规范。此属性是可选的，可以省略。
DataCollectionRuleEndpoints	定义了通过该规则发送数据的摄取端点。
DataCollectionRuleIngestionQuotas	摄入限制的规范
DataCollectionRuleMetadata	关于资源的元数据
DataCollectionRuleReferences	定义可在 DCR 的其他部分使用的所有引用
DataCollectionRuleResource	ARM 跟踪顶级资源的定义。
DataCollectionRuleResourceIdentity	资源的托管服务标识。
DataCollectionRuleResourceSku	资源的 SKU。
DataFlow	定义哪些流被发送到哪些目的地。
DataImportSourcesEventHub	事件中心配置的定义。
DataSourcesSpecDataImports	基于拉取的数据源的规范
DestinationsSpecAzureMonitorMetrics	Azure Monitor 指标目标。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponseCommonV2	所有 Azure Resource Manager API 的通用错误响应，用于返回失败操作的错误细节。（这也遵循 OData 错误响应格式）。
EtwProviderDataSource	通过该数据收集规则，可以收集ETW提供者日志。
EventHubDestination
EventHubDirectDestination
ExtensionDataSource	定义哪些数据将从与Azure Monitor Agent集成的独立虚拟机扩展中收集。数据来源于Windows和Linux机器，具体取决于定义的扩展。
IisLogsDataSource	使得通过该数据收集规则能够收集 IIS 日志。
IngestionQuotasLogs
KnownAgentSettingName	设置的名称。必须是受支持设置列表的一部分
KnownColumnDefinitionType	列数据的类型。
KnownDataCollectionRuleProvisioningState	资源预配状态。
KnownDataCollectionRuleResourceKind	资源的种类。
KnownDataFlowStreams
KnownEtwProviderDataSourceLogLevel	要记录的最低细节级别
KnownEtwProviderType	提供程序类型规范：按清单 GUID 或事件源名称
KnownExtensionDataSourceStreams
KnownLogFilesDataSourceFormat	日志文件的数据格式
KnownLogFileTextSettingsRecordStartTimestampFormat	支持的时间戳格式之一
KnownOtelLogsDataSourceStreams
KnownOtelLogsDirectDataSourceStreams
KnownOtelTracesDataSourceStreams
KnownOtelTracesDirectDataSourceStreams
KnownPerfCounterDataSourceStreams
KnownPerformanceCountersOTelDataSourceStreams
KnownPrometheusForwarderDataSourceStreams
KnownStorageBlobLookupType	要对 Blob 执行的查找类型
KnownSyslogDataSourceFacilityNames
KnownSyslogDataSourceLogLevels
KnownSyslogDataSourceStreams
KnownWindowsEventLogDataSourceStreams
KnownWindowsFirewallLogsDataSourceProfileFilter
LogAnalyticsDestination	日志分析目的地。
LogFilesDataSource	定义该数据收集规则将收集哪些自定义日志文件
LogFilesDataSourceSettings	日志文件特定设置。
LogFileSettingsText	文本设置
ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
MicrosoftFabricDestination	Microsoft Fabric destination （non-Azure）.
MonitoringAccountDestination	监控账户目的地。
OtelLogsDataSource	使得通过该数据收集规则能够收集Otel日志。
OtelLogsDataSourceResourceAttributeRouting	根据OTLP负载资源属性指定路由策略，根据匹配的资源属性路由负载的子集。
OtelLogsDirectDataSource
OtelMetricsDataSource	OTel度量配置的定义。
OtelMetricsDataSourceResourceAttributeRouting	根据OTLP负载资源属性指定路由策略，根据匹配的资源属性路由负载的子集。
OtelMetricsDirectDataSource	OTel度量配置的定义。
OtelTracesDataSource	使得Otel Traces能够通过该数据收集规则进行收集。
OtelTracesDataSourceResourceAttributeRouting	根据OTLP负载资源属性指定路由策略，根据匹配的资源属性路由负载的子集。
OtelTracesDirectDataSource	使得Otel Traces能够通过该数据收集规则进行收集。
PerfCounterDataSource	本数据收集规则定义了将收集哪些绩效计数器以及如何收集。从有计数器的Windows和Linux机器中收集。
PerformanceCountersOTelDataSource	定义了将收集哪些开放遥测性能计数器及其如何被收集。从有计数器的Windows和Linux机器中收集。
PlatformTelemetryDataSource	平台遥测数据源配置的定义
PrometheusForwarderDataSource	Prometheus 指标转发配置的定义。
ReferencesSpecEnrichmentData	数据流中引用的所有扩充数据源
SkuTier	如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。
StorageBlob
StorageBlobDestination
StorageTableDestination
StreamDeclaration	自定义流的声明。
SyslogDataSource	定义将收集哪些系统日志数据以及如何收集。只收集自Linux机器。
systemData	与创建和上次修改资源相关的元数据。
UserAssignedIdentity	用户分配的标识属性
WindowsEventLogDataSource	定义哪些 Windows 事件日志事件将被收集以及如何收集。只收集Windows机器上的。
WindowsFirewallLogsDataSource	通过该数据收集规则，使防火墙日志能够被收集。

AdxDestination

对象

Azure Data Explorer （Adx） destination.

名称	类型	说明
databaseName	string	将数据引入到的数据库的名称。
ingestionUri	string	Adx资源的摄取uri。
name	string	目标的友好名称。此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。
resourceId	string	Adx 资源的 ARM 资源 ID。

AgentSetting

对象

用于控制主机上代理行为的设置

名称	类型	说明
name	KnownAgentSettingName	设置的名称。必须是受支持设置列表的一部分
value	string	设置的值

ApplicationInsights

对象

名称	类型	说明
name	string	在 Otel 数据源中引用此 Application Insights 时用作别名的引用的名称
resourceId	string (arm-id)	Application Insights 资源的 ID

ColumnDefinition

对象

自定义数据列的定义。

名称	类型	说明
name	string	列的名称。
type	KnownColumnDefinitionType	列数据的类型。

createdByType

枚举

创建资源的标识的类型。

值	说明
User
Application
ManagedIdentity
Key

DataCollectionRuleAgentSettings

对象

用于修改给定主机上的代理行为的代理设置

名称	类型	说明
logs	AgentSetting[]	适用于日志代理的所有设置（AMA）

DataCollectionRuleDataSources

对象

数据源的规范。此属性是可选的，如果规则旨在通过对预配的终结点的直接调用使用，则可以省略此属性。

名称	类型	说明
dataImports	DataSourcesSpecDataImports	基于拉取的数据源的规范
etwProviders	EtwProviderDataSource[]	ETW 提供程序数据源配置的列表。
extensions	ExtensionDataSource[]	Azure VM 扩展数据源配置的列表。
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[]	Syslog 数据源配置的列表。
windowsEventLogs	WindowsEventLogDataSource[]	Windows 事件日志数据源配置的列表。
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	Windows 防火墙日志源配置的列表。

DataCollectionRuleDestinations

对象

目标的规范。

名称	类型	说明
azureDataExplorer	AdxDestination[]	Azure 数据资源管理器目标列表。
azureMonitorMetrics	DestinationsSpecAzureMonitorMetrics	Azure Monitor 指标目标。
eventHubs	EventHubDestination[]	事件中心目标列表。
eventHubsDirect	EventHubDirectDestination[]	事件中心直接目标列表。
logAnalytics	LogAnalyticsDestination[]	Log Analytics 目标列表。
microsoftFabric	MicrosoftFabricDestination[]	Microsoft Fabric 目标的列表。
monitoringAccounts	MonitoringAccountDestination[]	监视帐户目标列表。
storageAccounts	StorageBlobDestination[]	存储帐户目标列表。
storageBlobsDirect	StorageBlobDestination[]	存储 Blob Direct 目标的列表。仅用于将数据直接从代理发送到存储。
storageTablesDirect	StorageTableDestination[]	存储表直接目标的列表。

DataCollectionRuleDirectDataSources

对象

直接数据源的规范。此属性是可选的，可以省略。

名称	类型	说明
otelLogs	OtelLogsDirectDataSource[]	OTel 日志数据源配置列表。
otelMetrics	OtelMetricsDirectDataSource[]	OTel 指标数据源配置列表。
otelTraces	OtelTracesDirectDataSource[]	OTel 跟踪数据源配置列表。

DataCollectionRuleEndpoints

对象

定义了通过该规则发送数据的摄取端点。

名称	类型	说明
logsIngestion	string	日志的摄取端点
metricsIngestion	string	指标的摄取终点

DataCollectionRuleIngestionQuotas

对象

摄入限制的规范

名称	类型	说明
logs	IngestionQuotasLogs

DataCollectionRuleMetadata

对象

关于资源的元数据

名称	类型	说明
provisionedBy	string	Azure 提供代表客户管理该资源的方案。
provisionedByImmutableId	string	Azure 的不可变 ID 代表客户管理该资源。
provisionedByResourceId	string	Azure 提供的资源 ID 代表客户管理该资源。

DataCollectionRuleReferences

对象

定义可在 DCR 的其他部分使用的所有引用

名称	类型	说明
applicationInsights	ApplicationInsights[]	用于 OTel 指标/日志扩充的 Application Insights 引用
enrichmentData	ReferencesSpecEnrichmentData	数据流中引用的所有扩充数据源

DataCollectionRuleResource

对象

ARM 跟踪顶级资源的定义。

名称	类型	说明
etag	string	资源实体标签（ETag）。
id	string	资源的完全限定的资源 ID。示例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
identity	DataCollectionRuleResourceIdentity	资源的托管服务标识。
kind	KnownDataCollectionRuleResourceKind	资源的种类。
location	string	资源所在的地理位置
name	string	资源的名称
properties.agentSettings	DataCollectionRuleAgentSettings	用于修改给定主机上的代理行为的代理设置
properties.dataCollectionEndpointId	string	此规则可用于的数据收集终结点的资源 ID。
properties.dataFlows	DataFlow[]	数据流的规范。
properties.dataSources	DataCollectionRuleDataSources	数据源的规范。此属性是可选的，如果规则旨在通过对预配的终结点的直接调用使用，则可以省略此属性。
properties.description	string	数据收集规则的说明。
properties.destinations	DataCollectionRuleDestinations	目标的规范。
properties.directDataSources	DataCollectionRuleDirectDataSources	直接数据源的规范。此属性是可选的，可以省略。
properties.endpoints	DataCollectionRuleEndpoints	定义了通过该规则发送数据的摄取端点。
properties.immutableId	string	这个数据收集规则的不可篡改身份。此属性为 READ-ONLY。
properties.ingestionQuotas	DataCollectionRuleIngestionQuotas	摄入限制的规范
properties.metadata	DataCollectionRuleMetadata	关于资源的元数据
properties.provisioningState	KnownDataCollectionRuleProvisioningState	资源预配状态。
properties.references	DataCollectionRuleReferences	定义可在 DCR 的其他部分使用的所有引用
properties.streamDeclarations	<string, StreamDeclaration>	此规则中使用的自定义流的声明。
sku	DataCollectionRuleResourceSku	资源的 SKU。
systemData	systemData	包含 createdBy 和 modifiedBy 信息的 Azure 资源管理器元数据。
tags	object	资源标记。
type	string	资源类型。例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

DataCollectionRuleResourceIdentity

对象

资源的托管服务标识。

名称	类型	说明
principalId	string (uuid)	系统分配标识的服务主体 ID。此属性仅针对系统分配的标识提供。
tenantId	string (uuid)	系统分配标识的租户 ID。此属性仅针对系统分配的标识提供。
type	ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
userAssignedIdentities	<string, UserAssignedIdentity>	User-Assigned 标识与资源关联的用户分配标识集。 userAssignedIdentities 字典密钥将为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。字典值可以是请求中的空对象（{}）。

DataCollectionRuleResourceSku

对象

资源的 SKU。

名称	类型	说明
capacity	integer (int32)	如果 SKU 支持横向扩展/缩减，则应包含容量整数。如果资源无法横向扩展/缩小，则可能会省略此范围。
family	string	如果服务具有不同代的硬件（对于同一 SKU，则可以在此处捕获）。
name	string	SKU 的名称。例 - P3。它通常是字母+数字代码
size	string	SKU 大小。当名称字段是层和其他一些值的组合时，这将是独立的代码。
tier	SkuTier	如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。

DataFlow

对象

定义哪些流被发送到哪些目的地。

名称	类型	说明
builtInTransform	string	用于转换流数据的 builtIn 转换
captureOverflow	boolean	用于在 LA 目标中启用溢出列的标志
destinations	string[]	此数据流的目标列表。
outputStream	string	转换的输出流。仅当转换将数据更改为其他流时，才是必需的。
streams	KnownDataFlowStreams[]	此数据流的流列表。
transformKql	string	用于转换流数据的 KQL 查询。

DataImportSourcesEventHub

对象

事件中心配置的定义。

名称	类型	说明
consumerGroup	string	事件中心使用者组名称
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
stream	string	要从 EventHub 收集的流

DataSourcesSpecDataImports

对象

基于拉取的数据源的规范

名称	类型	说明
eventHub	DataImportSourcesEventHub	事件中心配置的定义。

DestinationsSpecAzureMonitorMetrics

对象

Azure Monitor 指标目标。

名称	类型	说明
name	string	目标的友好名称。此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详细信息。

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ErrorResponseCommonV2

对象

所有 Azure Resource Manager API 的通用错误响应，用于返回失败操作的错误细节。（这也遵循 OData 错误响应格式）。

名称	类型	说明
error	ErrorDetail	错误对象。

EtwProviderDataSource

对象

通过该数据收集规则，可以收集ETW提供者日志。

名称	类型	说明
eventIds	string[]	要收集的事件 ID
keyword	string	活动在一组活动类别中的成员资格
logLevel	KnownEtwProviderDataSourceLogLevel	要记录的最低细节级别
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
provider	string	事件源的提供程序 GUID 或类名称
providerType	KnownEtwProviderType	提供程序类型规范：按清单 GUID 或事件源名称
streams	string[]	此数据源将发送到的流列表

EventHubDestination

对象

名称	类型	说明
eventHubResourceId	string	事件中心的资源 ID。
name	string	目标的友好名称。此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。

EventHubDirectDestination

对象

名称	类型	说明
eventHubResourceId	string	事件中心的资源 ID。
name	string	目标的友好名称。此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。

ExtensionDataSource

对象

定义哪些数据将从与Azure Monitor Agent集成的独立虚拟机扩展中收集。数据来源于Windows和Linux机器，具体取决于定义的扩展。

名称	类型	说明
extensionName	string	VM 扩展的名称。
extensionSettings		扩展设置。该格式特定于特定扩展。
inputDataSources	string[]	此扩展插件需要数据的数据源列表。
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
streams	KnownExtensionDataSourceStreams[]	此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。

IisLogsDataSource

对象

使得通过该数据收集规则能够收集 IIS 日志。

名称	类型	说明
logDirectories	string[]	绝对路径文件位置
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
streams	string[]	IIS 流
transformKql	string	用于转换数据源的 KQL 查询。这是一个已弃用的属性，将在将来的版本中删除。

IngestionQuotasLogs

对象

名称	类型	说明
maxRequestsPerMinute	string
maxSizePerMinuteInGB	string

KnownAgentSettingName

枚举

设置的名称。必须是受支持设置列表的一部分

值	说明
MaxDiskQuotaInMB	MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents	接收转发事件的时间
Tags	标记

KnownColumnDefinitionType

枚举

列数据的类型。

值	说明
string	字符串
int	int
long	long
real	real
boolean	布尔
datetime	日期/时间
dynamic	dynamic

KnownDataCollectionRuleProvisioningState

枚举

资源预配状态。

值	说明
Creating	创建
Updating	更新
Deleting	正在删除
Succeeded	成功
Canceled	已取消
Failed	Failed

KnownDataCollectionRuleResourceKind

枚举

资源的种类。

值	说明
Linux	Linux
Windows	Windows操作系统

KnownDataFlowStreams

枚举

值	说明
Microsoft-Event	Microsoft-Event
Microsoft-InsightsMetrics	Microsoft-InsightsMetrics
Microsoft-Perf	Microsoft-Perf
Microsoft-Syslog	Microsoft-Syslog
Microsoft-WindowsEvent	Microsoft-WindowsEvent

KnownEtwProviderDataSourceLogLevel

枚举

要记录的最低细节级别

值	说明
Critical	危急
Error	错误
Warning	Warning
Informational	信息
Verbose	详细

KnownEtwProviderType

枚举

提供程序类型规范：按清单 GUID 或事件源名称

值	说明
EventSource	事件源
Manifest	清单

KnownExtensionDataSourceStreams

枚举

值	说明
Microsoft-Event	Microsoft-Event
Microsoft-InsightsMetrics	Microsoft-InsightsMetrics
Microsoft-Perf	Microsoft-Perf
Microsoft-Syslog	Microsoft-Syslog
Microsoft-WindowsEvent	Microsoft-WindowsEvent

KnownLogFilesDataSourceFormat

枚举

日志文件的数据格式

值	说明
json	json
text	文本消息

KnownLogFileTextSettingsRecordStartTimestampFormat

枚举

支持的时间戳格式之一

值	说明
ISO 8601	ISO 8601
YYYY-MM-DD HH:MM:SS	YYYY-MM-DD HH：MM：SS
M/D/YYYY HH:MM:SS AM/PM	M/D/YYYY HH：MM：SS AM/PM
Mon DD, YYYY HH:MM:SS	Mon DD、YYYY HH：MM：SS
yyMMdd HH:mm:ss	yyMMdd HH：mm：ss
ddMMyy HH:mm:ss	ddMMyy HH：mm：ss
MMM d hh:mm:ss	MMM d hh：mm：ss
dd/MMM/yyyy:HH:mm:ss zzz	dd/MMM/yyyy：HH：mm：ss zzz
yyyy-MM-ddTHH:mm:ssK	yyyy-MM-ddTHH：mm：ssK

KnownOtelLogsDataSourceStreams

枚举

值	说明
Microsoft-OTel-Logs	Microsoft-OTel-Logs

KnownOtelLogsDirectDataSourceStreams

枚举

值	说明
Microsoft-OTel-Logs	Microsoft-OTel-Logs

KnownOtelTracesDataSourceStreams

枚举

值	说明
Microsoft-OTel-Traces-Spans	Microsoft-OTel-Traces-Spans
Microsoft-OTel-Traces-Events	Microsoft-OTel-Traces-Events
Microsoft-OTel-Traces-Resources	Microsoft-OTel-Traces-Resources

KnownOtelTracesDirectDataSourceStreams

枚举

值	说明
Microsoft-OTel-Traces-Spans	Microsoft-OTel-Traces-Spans
Microsoft-OTel-Traces-Events	Microsoft-OTel-Traces-Events
Microsoft-OTel-Traces-Resources	Microsoft-OTel-Traces-Resources

KnownPerfCounterDataSourceStreams

枚举

值	说明
Microsoft-Perf	Microsoft-Perf
Microsoft-InsightsMetrics	Microsoft-InsightsMetrics

KnownPerformanceCountersOTelDataSourceStreams

枚举

值	说明
Microsoft-OtelPerfMetrics	Microsoft-OtelPerfMetrics

KnownPrometheusForwarderDataSourceStreams

枚举

值	说明
Microsoft-PrometheusMetrics	Microsoft-PrometheusMetrics

KnownStorageBlobLookupType

枚举

要对 Blob 执行的查找类型

值	说明
String	String
Cidr	Cidr

KnownSyslogDataSourceFacilityNames

枚举

值	说明
*
alert	警报
audit	审核
auth	auth
authpriv	authpriv
clock	时钟
cron	cron
daemon	守护程序
ftp	ftp
kern	科恩
local0	local0
local1	local1
local2	local2
local3	local3
local4	local4
local5	local5
local6	local6
local7	local7
lpr	lpr
mail	邮件
mark	mark
news	新闻
nopri	诺普里
ntp	NTP
syslog	系统日志 (syslog)
user	用户
uucp	uucp

KnownSyslogDataSourceLogLevels

枚举

值	说明
Debug	调试
Info	信息
Notice	通知
Warning	Warning
Error	错误
Critical	危急
Alert	Alert
Emergency	紧急情况
*

KnownSyslogDataSourceStreams

枚举

值	说明
Microsoft-Syslog	Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

枚举

值	说明
Microsoft-WindowsEvent	Microsoft-WindowsEvent
Microsoft-Event	Microsoft-Event

KnownWindowsFirewallLogsDataSourceProfileFilter

枚举

值	说明
Domain	域名
Private	专用
Public	Public

LogAnalyticsDestination

对象

日志分析目的地。

名称	类型	说明
name	string	目标的友好名称。此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。
workspaceId	string	Log Analytics 工作区的客户 ID。
workspaceResourceId	string	Log Analytics 工作区的资源 ID。

LogFilesDataSource

对象

定义该数据收集规则将收集哪些自定义日志文件

名称	类型	说明
filePatterns	string[]	日志文件所在的文件模式
format	KnownLogFilesDataSourceFormat	日志文件的数据格式
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
settings	LogFilesDataSourceSettings	日志文件特定设置。
streams	string[]	此数据源将发送到的流列表。流指示将用于此数据源的架构
transformKql	string	用于转换数据源的 KQL 查询。这是一个已弃用的属性，将在将来的版本中删除。

LogFilesDataSourceSettings

对象

日志文件特定设置。

名称	类型	说明
text	LogFileSettingsText	文本设置

LogFileSettingsText

对象

文本设置

名称	类型	说明
recordStartTimestampFormat	KnownLogFileTextSettingsRecordStartTimestampFormat	支持的时间戳格式之一

ManagedServiceIdentityType

枚举

托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。

值	说明
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

MicrosoftFabricDestination

对象

Microsoft Fabric destination （non-Azure）.

名称	类型	说明
artifactId	string	Microsoft Fabric 资源的项目 ID。
databaseName	string	将数据引入到的数据库的名称。
ingestionUri	string	Microsoft Fabric 资源的引入 URI。
name	string	目标的友好名称。此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。
tenantId	string	Microsoft Fabric 资源的租户 ID。

MonitoringAccountDestination

对象

监控账户目的地。

名称	类型	说明
accountId	string	账户的不可更改ID。
accountResourceId	string	监视帐户的资源 ID。
name	string	目标的友好名称。此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。

OtelLogsDataSource

对象

使得通过该数据收集规则能够收集Otel日志。

名称	类型	说明
enrichWithReference	string	指定要扩充遥测信号的引用别名。
enrichWithResourceAttributes	string[]	指定需要作为标签/维度添加到遥测数据以进一步扩充的资源属性列表。
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
replaceResourceIdWithReference	boolean	指定是否将日志记录中的默认 resourceId 替换为用于扩充的引用资源的 resourceId。
resourceAttributeRouting	OtelLogsDataSourceResourceAttributeRouting	根据OTLP负载资源属性指定路由策略，根据匹配的资源属性路由负载的子集。
streams	KnownOtelLogsDataSourceStreams[]	此数据源将发送到的流列表。

OtelLogsDataSourceResourceAttributeRouting

对象

根据OTLP负载资源属性指定路由策略，根据匹配的资源属性路由负载的子集。

名称	类型	说明
attributeName	string	要匹配的资源属性的名称。
attributeValue	string	要匹配的资源属性的值。

OtelLogsDirectDataSource

对象

名称	类型	说明
enrichWithReference	string	指定要扩充遥测信号的引用。
enrichWithResourceAttributes	string[]	指定需要作为标签/维度添加到遥测数据以进一步扩充的资源属性列表。
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
replaceResourceIdWithReference	boolean	指定是否将日志记录中的默认 resourceId 替换为用于扩充的引用资源的 resourceId。
streams	KnownOtelLogsDirectDataSourceStreams[]	此数据源将发送到的流列表。

OtelMetricsDataSource

对象

OTel度量配置的定义。

名称	类型	说明
enrichWithReference	string	指定要扩充遥测信号的引用。
enrichWithResourceAttributes	string[]	指定需要作为标签/维度添加到遥测数据以进一步扩充的资源属性列表。
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
resourceAttributeRouting	OtelMetricsDataSourceResourceAttributeRouting	根据OTLP负载资源属性指定路由策略，根据匹配的资源属性路由负载的子集。
streams	string[]	此数据源将发送到的流列表。

OtelMetricsDataSourceResourceAttributeRouting

对象

根据OTLP负载资源属性指定路由策略，根据匹配的资源属性路由负载的子集。

名称	类型	说明
attributeName	string	要匹配的资源属性的名称。
attributeValue	string	要匹配的资源属性的值。

OtelMetricsDirectDataSource

对象

OTel度量配置的定义。

名称	类型	说明
enrichWithReference	string	指定要扩充遥测信号的引用。
enrichWithResourceAttributes	string[]	指定需要作为标签/维度添加到遥测数据以进一步扩充的资源属性列表。
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
streams	string[]	此数据源将发送到的流列表。

OtelTracesDataSource

对象

使得Otel Traces能够通过该数据收集规则进行收集。

名称	类型	说明
enrichWithReference	string	指定要扩充遥测信号的引用。
enrichWithResourceAttributes	string[]	指定需要作为标签/维度添加到遥测数据以进一步扩充的资源属性列表。
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
replaceResourceIdWithReference	boolean	指定是否将日志记录中的默认 resourceId 替换为用于扩充的引用资源的 resourceId。
resourceAttributeRouting	OtelTracesDataSourceResourceAttributeRouting	根据OTLP负载资源属性指定路由策略，根据匹配的资源属性路由负载的子集。
streams	KnownOtelTracesDataSourceStreams[]	此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。

OtelTracesDataSourceResourceAttributeRouting

对象

根据OTLP负载资源属性指定路由策略，根据匹配的资源属性路由负载的子集。

名称	类型	说明
attributeName	string	要匹配的资源属性的名称。
attributeValue	string	要匹配的资源属性的值。

OtelTracesDirectDataSource

对象

使得Otel Traces能够通过该数据收集规则进行收集。

名称	类型	说明
enrichWithReference	string	指定要扩充遥测信号的引用。
enrichWithResourceAttributes	string[]	指定需要作为标签/维度添加到遥测数据以进一步扩充的资源属性列表。
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
replaceResourceIdWithReference	boolean	指定是否将日志记录中的默认 resourceId 替换为用于扩充的引用资源的 resourceId。
streams	KnownOtelTracesDirectDataSourceStreams[]	此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。

PerfCounterDataSource

对象

本数据收集规则定义了将收集哪些绩效计数器以及如何收集。从有计数器的Windows和Linux机器中收集。

名称	类型	说明
counterSpecifiers	string[]	要收集的性能计数器说明符名称的列表。使用通配符 \ 为所有实例收集计数器。若要获取 Windows 上的性能计数器列表，请运行命令“typeperf”。
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
samplingFrequencyInSeconds	integer (int32)	连续计数器度量（样本）之间的秒数。
streams	KnownPerfCounterDataSourceStreams[]	此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。
transformKql	string	用于转换数据源的 KQL 查询。这是一个已弃用的属性，将在将来的版本中删除。

PerformanceCountersOTelDataSource

对象

定义了将收集哪些开放遥测性能计数器及其如何被收集。从有计数器的Windows和Linux机器中收集。

名称	类型	说明
counterSpecifiers	string[]	要收集的性能计数器说明符名称的列表。
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
samplingFrequencyInSeconds	integer (int32)	连续计数器度量（样本）之间的秒数。
streams	KnownPerformanceCountersOTelDataSourceStreams[]	此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。

PlatformTelemetryDataSource

对象

平台遥测数据源配置的定义

名称	类型	说明
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
streams	string[]	要收集的平台遥测流列表

PrometheusForwarderDataSource

对象

Prometheus 指标转发配置的定义。

名称	类型	说明
customVMScrapeConfig	CustomVMScrapeConfig[]	定义抓取作业的自定义 VM 抓取配置
labelIncludeFilter	object	标签包含筛选器的列表，格式为标签“name-value”对。目前仅支持一个标签：“microsoft_metrics_include_label”。标签值不区分大小写。
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
streams	KnownPrometheusForwarderDataSourceStreams[]	此数据源将发送到的流列表。

ReferencesSpecEnrichmentData

对象

数据流中引用的所有扩充数据源

名称	类型	说明
storageBlobs	StorageBlob[]	用作扩充数据源的所有存储 Blob

SkuTier

枚举

如果服务具有多个层，但在 PUT 上不需要，则需要资源提供程序实现此字段。

值	说明
Free
Basic
Standard
Premium

StorageBlob

对象

名称	类型	说明
blobUrl	string	存储 Blob 的 URL
lookupType	KnownStorageBlobLookupType	要对 Blob 执行的查找类型
name	string	在数据流中引用此数据源时用作别名的扩充数据源的名称
resourceId	string	托管 Blob 的存储帐户的资源 ID

StorageBlobDestination

对象

名称	类型	说明
containerName	string	存储 Blob 的容器名称。
name	string	目标的友好名称。此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。
storageAccountResourceId	string	存储账户的资源ID。

StorageTableDestination

对象

名称	类型	说明
name	string	目标的友好名称。此名称应在数据收集规则中的所有目标（无论类型是什么）中是唯一的。
storageAccountResourceId	string	存储账户的资源ID。
tableName	string	存储表的名称。

StreamDeclaration

对象

自定义流的声明。

名称	类型	说明
columns	ColumnDefinition[]	此流中的数据使用的列列表。

SyslogDataSource

对象

定义将收集哪些系统日志数据以及如何收集。只收集自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	上次修改资源的标识的类型。

UserAssignedIdentity

对象

用户分配的标识属性

名称	类型	说明
clientId	string (uuid)	分配的标识的客户端 ID。
principalId	string (uuid)	已分配标识的主体 ID。

WindowsEventLogDataSource

对象

定义哪些 Windows 事件日志事件将被收集以及如何收集。只收集Windows机器上的。

名称	类型	说明
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
streams	KnownWindowsEventLogDataSourceStreams[]	此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。
transformKql	string	用于转换数据源的 KQL 查询。这是一个已弃用的属性，将在将来的版本中删除。
xPathQueries	string[]	XPATH 格式的 Windows 事件日志查询列表。

WindowsFirewallLogsDataSource

对象

通过该数据收集规则，使防火墙日志能够被收集。

名称	类型	说明
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
profileFilter	KnownWindowsFirewallLogsDataSourceProfileFilter[]	防火墙日志配置文件筛选器
streams	string[]	防火墙日志流