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

Data Collection Rules - Get

参考

服务:: Monitor

API 版本:: 2023-03-11

返回指定的数据收集规则。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Insights/dataCollectionRules/{dataCollectionRuleName}?api-version=2023-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	请求成功完成
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=2023-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 数据资源管理器（Adx）目标。
AgentSetting	用于控制主机上代理行为的设置
AgentSettings	用于修改给定主机上的代理行为的代理设置
AzureMonitorMetrics	Azure Monitor 指标目标。
ColumnDefinition	自定义数据列的定义。
createdByType	创建资源的标识的类型。
DataCollectionRuleResource	ARM 跟踪的顶级资源的定义。
DataFlow	将哪些流发送到目标的定义。
DataImports	基于拉取的数据源的规范
DataSources	数据源的规范。此属性是可选的，如果规则旨在通过对预配的终结点的直接调用使用，则可以省略此属性。
Destinations	目标的规范。
Endpoints	定义要通过此规则将数据发送到的引入终结点。
EnrichmentData	数据流中引用的所有扩充数据源
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详细信息。
ErrorResponseCommonV2	错误响应
EventHub	事件中心配置的定义。
EventHubDestination
EventHubDirectDestination
ExtensionDataSource	将从与 Azure Monitor 代理集成的单独 VM 扩展中收集哪些数据的定义。根据定义的扩展，从任一 Windows 和 Linux 计算机收集。
Identity	资源的托管服务标识。
IisLogsDataSource	启用此数据收集规则收集 IIS 日志。
KnownAgentSettingName	设置的名称。必须是受支持设置列表的一部分
KnownColumnDefinitionType	列数据的类型。
KnownDataCollectionRuleProvisioningState	资源预配状态。
KnownDataCollectionRuleResourceKind	资源的种类。
KnownDataFlowStreams	此数据流的流列表。
KnownExtensionDataSourceStreams	此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。
KnownLogFilesDataSourceFormat	日志文件的数据格式
KnownLogFileTextSettingsRecordStartTimestampFormat	支持的时间戳格式之一
KnownPerfCounterDataSourceStreams	此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。
KnownPrometheusForwarderDataSourceStreams	此数据源将发送到的流列表。
KnownStorageBlobLookupType	要对 Blob 执行的查找类型
KnownSyslogDataSourceFacilityNames	设施名称的列表。
KnownSyslogDataSourceLogLevels	要收集的日志级别。
KnownSyslogDataSourceStreams	此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。
KnownWindowsEventLogDataSourceStreams	此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。
KnownWindowsFirewallLogsDataSourceProfileFilter	防火墙日志配置文件筛选器
LogAnalyticsDestination	Log Analytics 目标。
LogFilesDataSource	此数据收集规则将收集哪些自定义日志文件的定义
ManagedServiceIdentityType	托管服务标识的类型（其中允许 SystemAssigned 和 UserAssigned 类型）。
Metadata	有关资源的元数据
MicrosoftFabricDestination	Microsoft Fabric 目标（非 Azure）。
MonitoringAccountDestination	监视帐户目标。
PerfCounterDataSource	定义将收集哪些性能计数器以及如何通过此数据收集规则收集它们。从计数器所在的 Windows 和 Linux 计算机收集。
PlatformTelemetryDataSource	平台遥测数据源配置的定义
PrometheusForwarderDataSource	Prometheus 指标转发配置的定义。
References	定义可在 DCR 的其他部分使用的所有引用
Settings	日志文件特定设置。
StorageBlob
StorageBlobDestination
StorageTableDestination
StreamDeclaration	自定义流的声明。
SyslogDataSource	将收集哪些 syslog 数据及其收集方式的定义。仅从 Linux 计算机收集。
SystemData	与创建和上次修改资源相关的元数据。
Text	文本设置
UserAssignedIdentity	用户分配的标识属性
WindowsEventLogDataSource	定义将收集哪些 Windows 事件日志事件及其收集方式。仅从 Windows 计算机收集。
WindowsFirewallLogsDataSource	启用此数据收集规则收集防火墙日志。

AdxDestination

Object

Azure 数据资源管理器（Adx）目标。

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

AgentSetting

Object

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

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

AgentSettings

Object

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

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

AzureMonitorMetrics

Object

Azure Monitor 指标目标。

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

ColumnDefinition

Object

自定义数据列的定义。

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

createdByType

枚举

创建资源的标识的类型。

值	说明
Application
Key
ManagedIdentity
User

DataCollectionRuleResource

Object

ARM 跟踪的顶级资源的定义。

名称	类型	说明
etag	string	资源实体标记（ETag）。
id	string	资源的完全限定 ID。
identity	Identity	资源的托管服务标识。
kind	KnownDataCollectionRuleResourceKind	资源的种类。
location	string	资源所在的地理位置。
name	string	资源的名称。
properties.agentSettings	AgentSettings	用于修改给定主机上的代理行为的代理设置
properties.dataCollectionEndpointId	string	此规则可用于的数据收集终结点的资源 ID。
properties.dataFlows	DataFlow[]	数据流的规范。
properties.dataSources	DataSources	数据源的规范。此属性是可选的，如果规则旨在通过对预配的终结点的直接调用使用，则可以省略此属性。
properties.description	string	数据收集规则的说明。
properties.destinations	Destinations	目标的规范。
properties.endpoints	Endpoints	定义要通过此规则将数据发送到的引入终结点。
properties.immutableId	string	此数据收集规则的不可变 ID。此属性为 READ-ONLY。
properties.metadata	Metadata	有关资源的元数据
properties.provisioningState	KnownDataCollectionRuleProvisioningState	资源预配状态。
properties.references	References	定义可在 DCR 的其他部分使用的所有引用
properties.streamDeclarations	<string, StreamDeclaration>	此规则中使用的自定义流的声明。
systemData	SystemData	与创建和上次修改资源相关的元数据。
tags	object	资源标记。
type	string	资源的类型。

DataFlow

Object

将哪些流发送到目标的定义。

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

DataImports

Object

基于拉取的数据源的规范

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

DataSources

Object

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

名称	类型	说明
dataImports	DataImports	基于拉取的数据源的规范
extensions	ExtensionDataSource[]	Azure VM 扩展数据源配置的列表。
iisLogs	IisLogsDataSource[]	IIS 日志源配置的列表。
logFiles	LogFilesDataSource[]	日志文件源配置的列表。
performanceCounters	PerfCounterDataSource[]	性能计数器数据源配置的列表。
platformTelemetry	PlatformTelemetryDataSource[]	平台遥测配置列表
prometheusForwarder	PrometheusForwarderDataSource[]	Prometheus 转发器数据源配置的列表。
syslog	SyslogDataSource[]	Syslog 数据源配置的列表。
windowsEventLogs	WindowsEventLogDataSource[]	Windows 事件日志数据源配置的列表。
windowsFirewallLogs	WindowsFirewallLogsDataSource[]	Windows 防火墙日志源配置的列表。

Destinations

Object

目标的规范。

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

Endpoints

Object

定义要通过此规则将数据发送到的引入终结点。

名称	类型	说明
logsIngestion	string	日志的引入终结点
metricsIngestion	string	指标的引入终结点

EnrichmentData

Object

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

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

ErrorAdditionalInfo

Object

资源管理错误附加信息。

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

ErrorDetail

Object

错误详细信息。

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

ErrorResponseCommonV2

Object

错误响应

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

EventHub

Object

事件中心配置的定义。

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

EventHubDestination

Object

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

EventHubDirectDestination

Object

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

ExtensionDataSource

Object

将从与 Azure Monitor 代理集成的单独 VM 扩展中收集哪些数据的定义。根据定义的扩展，从任一 Windows 和 Linux 计算机收集。

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

Identity

Object

资源的托管服务标识。

名称	类型	说明
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}”。字典值可以是请求中的空对象（{}）。

IisLogsDataSource

Object

启用此数据收集规则收集 IIS 日志。

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

KnownAgentSettingName

枚举

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

值	说明
MaxDiskQuotaInMB
UseTimeReceivedForForwardedEvents

KnownColumnDefinitionType

枚举

列数据的类型。

值	说明
boolean
datetime
dynamic
int
long
real
string

KnownDataCollectionRuleProvisioningState

枚举

资源预配状态。

值	说明
Canceled
Creating
Deleting
Failed
Succeeded
Updating

KnownDataCollectionRuleResourceKind

枚举

资源的种类。

值	说明
Linux
Windows

KnownDataFlowStreams

枚举

此数据流的流列表。

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

KnownExtensionDataSourceStreams

枚举

此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。

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

KnownLogFilesDataSourceFormat

枚举

日志文件的数据格式

值	说明
json
text

KnownLogFileTextSettingsRecordStartTimestampFormat

枚举

支持的时间戳格式之一

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

KnownPerfCounterDataSourceStreams

枚举

此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。

值	说明
Microsoft-InsightsMetrics
Microsoft-Perf

KnownPrometheusForwarderDataSourceStreams

枚举

此数据源将发送到的流列表。

值	说明
Microsoft-PrometheusMetrics

KnownStorageBlobLookupType

枚举

要对 Blob 执行的查找类型

值	说明
Cidr
String

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

枚举

要收集的日志级别。

值	说明
*
Alert
Critical
Debug
Emergency
Error
Info
Notice
Warning

KnownSyslogDataSourceStreams

枚举

此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。

值	说明
Microsoft-Syslog

KnownWindowsEventLogDataSourceStreams

枚举

此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。

值	说明
Microsoft-Event
Microsoft-WindowsEvent

KnownWindowsFirewallLogsDataSourceProfileFilter

枚举

防火墙日志配置文件筛选器

值	说明
Domain
Private
Public

LogAnalyticsDestination

Object

Log Analytics 目标。

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

LogFilesDataSource

Object

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

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

ManagedServiceIdentityType

枚举

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

值	说明
None
SystemAssigned
SystemAssigned,UserAssigned
UserAssigned

Metadata

Object

有关资源的元数据

名称	类型	说明
provisionedBy	string	Azure 产品/服务代表客户管理此资源。
provisionedByImmutableId	string	Azure 产品/服务的不可变 ID，代表客户管理此资源。
provisionedByResourceId	string	Azure 产品/服务的资源 ID，代表客户管理此资源。

MicrosoftFabricDestination

Object

Microsoft Fabric 目标（非 Azure）。

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

MonitoringAccountDestination

Object

监视帐户目标。

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

PerfCounterDataSource

Object

定义将收集哪些性能计数器以及如何通过此数据收集规则收集它们。从计数器所在的 Windows 和 Linux 计算机收集。

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

PlatformTelemetryDataSource

Object

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

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

PrometheusForwarderDataSource

Object

Prometheus 指标转发配置的定义。

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

References

Object

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

名称	类型	说明
enrichmentData	EnrichmentData	数据流中引用的所有扩充数据源

Settings

Object

日志文件特定设置。

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

StorageBlob

Object

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

StorageBlobDestination

Object

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

StorageTableDestination

Object

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

StreamDeclaration

Object

自定义流的声明。

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

SyslogDataSource

Object

将收集哪些 syslog 数据及其收集方式的定义。仅从 Linux 计算机收集。

名称	类型	说明
facilityNames	KnownSyslogDataSourceFacilityNames[]	设施名称的列表。
logLevels	KnownSyslogDataSourceLogLevels[]	要收集的日志级别。
name	string	数据源的友好名称。此名称应在数据收集规则中的所有数据源（无论类型）中是唯一的。
streams	KnownSyslogDataSourceStreams[]	此数据源将发送到的流列表。流指示将用于此数据的架构，以及 Log Analytics 中要发送到的数据的表。
transformKql	string	用于转换数据源的 KQL 查询。

SystemData

Object

与创建和上次修改资源相关的元数据。

名称	类型	说明
createdAt	string (date-time)	资源创建时间戳（UTC）。
createdBy	string	创建资源的标识。
createdByType	createdByType	创建资源的标识的类型。
lastModifiedAt	string (date-time)	上次修改的资源时间戳（UTC）
lastModifiedBy	string	上次修改资源的标识。
lastModifiedByType	createdByType	上次修改资源的标识的类型。

Text

Object

文本设置

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

UserAssignedIdentity

Object

用户分配的标识属性

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

WindowsEventLogDataSource

Object

定义将收集哪些 Windows 事件日志事件及其收集方式。仅从 Windows 计算机收集。

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

WindowsFirewallLogsDataSource

Object

启用此数据收集规则收集防火墙日志。

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

通过

Data Collection Rules - Get

URI 参数

响应

安全性

azure_auth

作用域

示例

Get data collection rule

示例请求

示例响应

定义

AdxDestination

AgentSetting

AgentSettings

AzureMonitorMetrics

ColumnDefinition

createdByType

DataCollectionRuleResource

DataFlow

DataImports

DataSources

Destinations

Endpoints

EnrichmentData

ErrorAdditionalInfo

ErrorDetail

ErrorResponseCommonV2

EventHub

EventHubDestination

EventHubDirectDestination

ExtensionDataSource

Identity

IisLogsDataSource

KnownAgentSettingName

KnownColumnDefinitionType

KnownDataCollectionRuleProvisioningState

KnownDataCollectionRuleResourceKind

KnownDataFlowStreams

KnownExtensionDataSourceStreams

KnownLogFilesDataSourceFormat

KnownLogFileTextSettingsRecordStartTimestampFormat

KnownPerfCounterDataSourceStreams

KnownPrometheusForwarderDataSourceStreams

KnownStorageBlobLookupType

KnownSyslogDataSourceFacilityNames

KnownSyslogDataSourceLogLevels

KnownSyslogDataSourceStreams

KnownWindowsEventLogDataSourceStreams

KnownWindowsFirewallLogsDataSourceProfileFilter

LogAnalyticsDestination

LogFilesDataSource

ManagedServiceIdentityType

Metadata

MicrosoftFabricDestination

MonitoringAccountDestination

PerfCounterDataSource

PlatformTelemetryDataSource

PrometheusForwarderDataSource

References

Settings

StorageBlob

StorageBlobDestination

StorageTableDestination

StreamDeclaration

SyslogDataSource

SystemData

Text

UserAssignedIdentity

WindowsEventLogDataSource

WindowsFirewallLogsDataSource

其他资源