Azure Monitor REST API 索引

Azure Monitor具有各种 API。 此索引将它们分为三个主要部分,Azure Monitor、Application Insights 和Azure Monitor日志。

注释

Azure Monitor部分确实包括托管服务 Managed Prometheus,但其他托管服务(如 Azure 托管 GrafanaAzure Monitor SCOM 托管实例使用自己的 REST API,并且不是包含在此索引中。

有关详细信息,请参阅 Azure 托管 Grafana REST API 参考System Center Operations Manager REST API 参考

Azure Monitor API

这些 API 是各种Azure Monitor功能的Azure 资源管理器(ARM)控制平面 API 的一部分。 请参阅 Azure REST API 文档的 Azure Monitor 部分,查找这些操作组的最新 API 版本。

所有这些AZURE MONITOR ARM API 的终结点都位于 https://management.chinacloudapi.cn/ 基 URL 下,这是 ARM API 的标准终结点。

活动日志

这些Azure Monitor API 检索和管理活动日志。

操作组 DESCRIPTION
活动日志 获取活动日志中的事件条目列表。
(活动日志)事件类别 列出活动日志条目的类型。
活动日志配置文件 用于管理活动日志配置文件的操作,以便可以将活动日志事件路由到其他位置。
活动日志租户事件 获取特定租户的活动日志事件条目。

警报管理和操作组

这些Azure Monitor API 创建和管理警报规则、操作组和警报处理规则。

操作组 DESCRIPTION
操作组 管理和列出操作组
活动日志警报 管理和列出活动日志警报规则
警报管理 列出和更新触发的警报
警报处理规则 管理和列出警报处理规则
指标警报基线 列出警报规则中使用的具有动态阈值的指标基线。
指标警报 管理和列出指标警报规则
指标警报状态 列出指标警报规则的状态。
Prometheus 规则组 管理和列出 Prometheus 规则组 (警报规则和记录规则)。
计划查询规则 - 2023-03-15(预览版) 管理和列出日志搜索警报规则
计划查询规则 - 2018-04-16 管理和列出日志搜索警报规则
计划的查询规则 - 2021-08-01 管理和列出日志搜索警报规则
智能检测器警报规则 管理和列出智能检测警报规则

Autoscale

这些Azure Monitor API 管理自动缩放设置并检索预测指标数据。

操作组 DESCRIPTION
自动缩放设置 用于管理自动缩放设置的操作。
预测指标 检索预测的自动缩放指标数据。

数据收集

这些Azure Monitor API 管理数据收集规则、数据收集终结点及其关联。

操作组 DESCRIPTION
数据收集终结点 创建和管理数据收集终结点,并检索资源组或订阅中的数据收集终结点。
数据收集规则关联 创建和管理数据收集规则关联,并检索数据收集终结点、资源或数据收集规则的数据收集规则关联。
数据收集规则 创建和管理数据收集规则,并检索资源组或订阅中的数据收集规则。

诊断设置

这些Azure Monitor API 管理用于控制指标数据和诊断日志路由的诊断设置。

操作组 DESCRIPTION
诊断设置 用于创建、更新和检索资源的诊断设置的操作。 控制指标数据和诊断日志的路由。
诊断设置类别 与给定资源的可能类别相关。
管理组诊断设置 管理资源的管理组诊断设置,并检索管理组的管理组诊断设置列表。
订阅诊断设置 管理资源的订阅诊断设置,并检索 subscriptionId 的订阅诊断设置列表。

资源指标

这些Azure Monitor API 检索资源指标定义、值和管理用于存储 Prometheus 指标的Azure Monitor工作区。

操作组 DESCRIPTION
Azure Monitor 工作区 管理 Azure Monitor 工作区并检索资源组或订阅中的 Azure Monitor 工作区。
指标定义 列出可用于该资源的指标定义。 即可以收集哪些特定指标
指标命名空间 列出指标命名空间。 使用 自定义指标时最相关。
指标批处理 列出多个资源的指标值。 这需要 https://<region>.metrics.monitor.azure.cn 终结点。
指标 列出标识的资源的指标值。
指标 - 自定义 发布资源的指标值。

Application Insights API

这些 Application Insights API 包括用于管理 Application Insights 资源和用于查询遥测数据的数据平面 API 的控制平面 API。 有关最新版本的 Azure REST API 文档,请参阅 Application Insights 部分

操作组 DESCRIPTION
组件 使你能够管理包含 Application Insights 数据的组件。
数据访问 查询 Application Insights 数据。
事件 按事件类型检索单个事件或多个事件的数据,并检索应用程序的 OData EDMX 元数据。
元数据 检索和导出 Application Insights 应用程序的元数据信息。
指标 检索或导出应用程序的指标数据,并检索描述应用程序可用指标的元数据。
查询 查询操作组(包括执行和获取操作)支持对资源运行分析查询和检索结果,即使对于需要延长处理时间的大型数据集也是如此。
Web 测试 设置 Web 测试以监视 Web 终结点的可用性和响应能力。
工作簿 管理 Application Insights 组件资源的 Azure 工作簿,并按类别检索资源组或订阅中的工作簿。

Azure Monitor日志 API

这些Azure Monitor日志 API 有三个不同的 API 组用于引入、查询和管理。

日志摄取

这是Azure Monitor将数据引入Log Analytics工作区的数据平面 API。

API 终结点是数据收集终结点(DCE)或 DCR 日志引入终结点。 有关详细信息,请参阅 日志引入 API 终结点

范围为 https://monitor.azure.cn/.default.

操作组 DESCRIPTION
上传 允许使用 REST API 调用客户端库将数据发送到 Log Analytics 工作区。

日志查询

这些是用于查询Log Analytics工作区中的数据的Azure Monitor日志数据平面 API。

API 终结点为 api.loganalytics.ioapi.loganalytics.azure.cn

操作组 DESCRIPTION
查询 使用 REST API 查询Log Analytics数据。 有关详细信息,请参阅 日志查询 API 概述
元数据 检索Log Analytics工作区的元数据信息,包括表架构和函数。

日志管理

这些Azure Monitor日志 API 是Azure 资源管理器(ARM)控制平面的一部分,可用于创建、更新、删除和检索Log Analytics工作区和相关资源,例如群集、数据导出和链接服务。

API 终结点为 management.chinacloudapi.cn.

操作组 DESCRIPTION
可用服务层级 检索 Log Analytics 工作区的可用服务层。
群集 管理 Log Analytics 群集。
数据导出 管理 Log Analytics 工作区的数据导出,或检索 Log Analytics 工作区中的数据导出实例。
数据源 创建或更新数据源。
已删除的工作区 检索订阅或资源组中最近删除的工作区。
网关 删除 Log Analytics 网关。
智能包 启用或禁用 Log Analytics 工作区的智能包,或检索 Log Analytics 工作区的所有智能包。
链接服务 创建或更新链接服务。
链接存储帐户 管理工作区和存储帐户之间的链接关系,并检索与工作区关联的所有链接存储帐户。
管理组群 检索连接到 Log Analytics 工作区的所有管理组。
作状态 检索长时间运行的异步操作的状态。
操作 检索所有可用的 OperationalInsights Rest API 操作。
查询包查询 管理在 Log Analytics QueryPack 中定义的查询,并检索或搜索 Log Analytics QueryPack 中定义的查询列表。
查询包 管理 Log Analytics QueryPack,包括更新其标记,并检索订阅或资源组中所有 Log Analytics QueryPack 的列表。
保存的搜索 创建或更新保存的搜索。
存储见解 创建或更新存储见解。
管理 Log Analytics 工作区表。
工作区清除 检索正在进行的清除操作的状态,或清除 Log Analytics 工作区中的数据。
工作区架构 检索 Log Analytics 工作区的架构。
工作区共享密钥 检索或重新生成 Log Analytics 工作区的共享密钥。
工作区使用情况 检索 Log Analytics 工作区的使用指标。
工作区 管理 Log Analytics 工作区。

已停用和弃用的 API

以下 API 已停用或计划停用。 此处列出了供参考。 有关迁移指南,请参阅链接的文档。

操作组 DESCRIPTION
警报(经典)规则事件 在公有云中停用 2019 年。 较旧的经典警报函数。 获取与经典指标警报规则关联的事件。 当警报规则由于阈值在向上或向下方向交叉而触发时,将创建一个事件,并将一个条目添加到活动日志
警报(经典)规则 在公有云中于 2019 年停用。 提供用于管理经典警报规则的操作。
数据收集器 旧版 HTTP 数据收集器 API 参考以及如何迁移到日志引入 API。