Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Azure Monitor has a wide assortment of APIs. This index separates them into three primary sections, Azure Monitor, Application Insights, and Azure Monitor Logs.
Note
The Azure Monitor section does include the managed service Managed Prometheus, but other managed services such as Azure Managed Grafana and Azure Monitor SCOM Managed Instance use their own REST APIs and aren't included in this index.
For more information, see Azure Managed Grafana REST API Reference and System Center Operations Manager REST API Reference.
Azure Monitor APIs
These APIs are part of the Azure Resource Manager (ARM) control plane APIs for various Azure Monitor features. See the Azure Monitor section of the Azure REST APIs documentation to find the latest API versions for these operation groups.
The endpoints for all of these Azure Monitor ARM APIs are under the https://management.azure.com/ base URL, which is the standard endpoint for ARM APIs.
Activity log
These Azure Monitor APIs retrieve and manage activity logs.
| Operation groups | Description |
|---|---|
| Activity log(s) | Get a list of event entries in the activity log. |
| (Activity log) event categories | Lists the types of Activity Log Entries. |
| Activity log profiles | Operations to manage activity log profiles so you can route activity log events to other locations. |
| Activity log tenant events | Gets the Activity Log event entries for a specific tenant. |
Alerts management and action groups
These Azure Monitor APIs create and manage alert rules, action groups, and alert processing rules.
| Operation groups | Description |
|---|---|
| Action groups | Manages and lists action groups. |
| Activity log alerts | Manages and lists activity log alert rules. |
| Alert management | Lists and updates fired alerts. |
| Alert processing rules | Manages and lists alert processing rules. |
| Metric alert baseline | List the metric baselines used in alert rules with dynamic thresholds. |
| Metric alerts | Manages and lists metric alert rules. |
| Metric alerts status | Lists the status of metric alert rules. |
| Prometheus rule groups | Manages and lists Prometheus rule groups (alert rules and recording rules). |
| Scheduled query rules - 2023-03-15 (preview) | Manages and lists log search alert rules. |
| Scheduled query rules - 2018-04-16 | Manages and lists log search alert rules. |
| Scheduled query rules - 2021-08-01 | Manages and lists log search alert rules. |
| Smart Detector alert rules | Manages and lists smart detection alert rules. |
Autoscale
These Azure Monitor APIs manage autoscale settings and retrieve predictive metric data.
| Operation groups | Description |
|---|---|
| Autoscale settings | Operations to manage autoscale settings. |
| Predictive metric | Retrieves predicted autoscale metric data. |
Data collection
These Azure Monitor APIs manage data collection rules, data collection endpoints, and their associations.
| Operation groups | Description |
|---|---|
| Data collection endpoints | Create and manage a data collection endpoint and retrieve the data collection endpoints within a resource group or subscription. |
| Data collection rule associations | Create and manage a data collection rule association and retrieve the data collection rule associations for a data collection endpoint, resource, or data collection rule. |
| Data collection rules | Create and manage a data collection rule and retrieve the data collection rules within a resource group or subscription. |
Diagnostic settings
These Azure Monitor APIs manage diagnostic settings that control routing of metric data and diagnostic logs.
| Operation groups | Description |
|---|---|
| Diagnostic settings | Operations to create, update, and retrieve the diagnostic settings for a resource. Controls the routing of metric data and diagnostic logs. |
| Diagnostic settings category | Relates to the possible categories for a given resource. |
| Management group diagnostic settings | Manage the management group diagnostic settings for a resource and retrieve the management group diagnostic settings list for a management group. |
| Subscription diagnostic settings | Manage the subscription diagnostic settings for a resource and retrieve the subscription diagnostic settings list for a subscriptionId. |
Resource metrics
These Azure Monitor APIs retrieve resource metric definitions, values, and manage Azure Monitor workspaces used for storing Prometheus metrics.
| Operation groups | Description |
|---|---|
| Azure Monitor Workspaces | Manage an Azure Monitor workspace and retrieve the Azure Monitor workspaces within a resource group or subscription. |
| Metric definitions | Lists the metric definitions available for the resource. That is, what specific metrics can you collect. |
| Metric namespaces | Lists the metric namespaces. Most relevant when using custom metrics. |
| Metrics Batch | List the metric values for multiple resources. This requires the https://<region>.metrics.monitor.azure.com endpoint. |
| Metrics | Lists the metric values for a resource you identify. |
| Metrics – Custom | Post the metric values for a resource. |
Application Insights APIs
These Application Insights APIs include both control plane APIs for managing Application Insights resources and data plane APIs for querying telemetry data. See the Application Insights section of the Azure REST APIs documentation for the latest API versions.
| Operation groups | Description |
|---|---|
| Components | Enables you to manage components that contain Application Insights data. |
| Data Access | Query Application Insights data. |
| Events | Retrieve the data for a single event or multiple events by event type and retrieve the OData EDMX metadata for an application. |
| Metadata | Retrieve and export metadata information for an Application Insights application. |
| Metrics | Retrieve or export the metric data for an application and retrieve the metadata describing the available metrics for an application. |
| Query | The Query operation group, which includes Execute and Get operations, enables running analytics queries on resources and retrieving the results, even for large data sets that require extended processing time. |
| Web Tests | Set up web tests to monitor a web endpoint's availability and responsiveness. |
| Workbooks | Manage Azure workbooks for an Application Insights component resource and retrieve workbooks within resource group or subscription by category. |
Azure Monitor Logs APIs
These Azure Monitor Logs APIs have three distinct API groups for ingestion, querying and management.
Logs ingestion
This is the Azure Monitor Logs data plane API to ingest data into a Log Analytics workspace.
API endpoint is either the data collection endpoint (DCE) or the DCR logs ingestion endpoint. For more information see Logs ingestion API endpoints.
Scope is https://monitor.azure.com/.default.
| Operation groups | Description |
|---|---|
| Upload | Lets you send data to a Log Analytics workspace using either a REST API call or client libraries. |
Logs query
These are the Azure Monitor Logs data plane APIs for querying data in your Log Analytics workspaces.
API endpoint is api.loganalytics.io or api.loganalytics.azure.com.
| Operation groups | Description |
|---|---|
| Query | Query Log Analytics data using the REST API. For more information, see the Logs query API overview. |
| Metadata | Retrieve metadata information for a Log Analytics workspace, including table schemas and functions. |
Logs management
These Azure Monitor Logs APIs are part of the Azure Resource Manager (ARM) control plane and allow you to create, update, delete, and retrieve Log Analytics workspaces and related resources such as clusters, data exports, and linked services.
API endpoint is management.azure.com.
| Operation groups | Description |
|---|---|
| Available service tiers | Retrieve the available service tiers for a Log Analytics workspace. |
| Clusters | Manage Log Analytics clusters. |
| Data exports | Manage a data export for a Log Analytics workspace or retrieve the data export instances within a Log Analytics workspace. |
| Data Sources | Create or update data sources. |
| Deleted workspaces | Retrieve the recently deleted workspaces within a subscription or resource group. |
| Gateways | Delete a Log Analytics gateway. |
| Intelligence Packs | Enable or disable an intelligence pack for a Log Analytics workspace or retrieve all intelligence packs for a Log Analytics workspace. |
| Linked Services | Create or update linked services. |
| Linked Storage Accounts | Manage a link relation between a workspace and storage accounts and retrieve all linked storage accounts associated with a workspace. |
| Management Groups | Retrieve all management groups connected to a Log Analytics workspace. |
| Operation Statuses | Retrieve the status of a long running asynchronous operation. |
| Operations | Retrieve all of the available OperationalInsights Rest API operations. |
| Query pack queries | Manage a query defined within a Log Analytics QueryPack and retrieve or search the list of queries defined within a Log Analytics QueryPack. |
| Query packs | Manage a Log Analytics QueryPack including updating its tags and retrieve a list of all Log Analytics QueryPacks within a subscription or resource group. |
| Saved Searches | Create or update saved searches. |
| Storage Insights | Create or update storage insights. |
| Tables | Manage Log Analytics workspace tables. |
| Workspace purge | Retrieve the status of an ongoing purge operation or purge the data in a Log Analytics workspace. |
| Workspace schema | Retrieves the schema for a Log Analytics workspace. |
| Workspace shared keys | Retrieve or regenerate the shared keys for a Log Analytics workspace. |
| Workspace usages | Retrieve the usage metrics for a Log Analytics workspace. |
| Workspaces | Manage Log Analytics workspaces. |
Retired and deprecated APIs
The following APIs have been retired or are scheduled for retirement. They're listed here for reference. See the linked documentation for migration guidance.
| Operation groups | Description |
|---|---|
| Alerts (classic) rule incidents | Retired in 2019 in the public cloud. Older classic alerts functions. Gets an incident associated to a classic metric alert rule. When an alert rule fires because the threshold is crossed in the up or down direction, an incident is created and an entry added to the Activity Log. |
| Alert (classic) rules | Being retired in 2019 in the public cloud. Provides operations for managing classic alert rules. |
| Data Collector | Legacy HTTP Data Collector API reference and how to migrate to the Logs ingestion API. |