Workload Monitor

Name: Workload Monitor API
Brand: Workload Monitor
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsMonitoring Observabilityoauth213 EndpointsREST

For Agents

Inspect Azure Workload Monitor components, monitors, monitor instances, and notification settings to understand the health of monitored workloads and roll the data up to dashboards or agents.

Connect the Workload Monitor to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Workload Monitor, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Workload Monitor API.

Summarise components and monitor instances across an entire subscription for at-a-glance health

List all components on a specific Azure resource with their current monitoring state

Retrieve monitor and monitor instance details to inspect health status and last evaluation

Read notification settings for a monitored resource to see who gets paged on a state change

GET STARTED

Start building with Workload Monitor API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Workload Monitor, keeping it validated and agent-ready.

The Azure Workload Monitor API surfaces health monitoring data for workloads running on Azure resources, including components, monitors, monitor instances, and notification settings under the Microsoft.WorkloadMonitor provider. It exposes 13 operations across 11 resource paths covering subscription-wide summaries, per-resource component listings, monitor configuration retrieval, and notification configuration. Use it to inventory monitored components, retrieve health status for individual monitor instances, and roll up workload health into dashboards or alerts.

Use Cases

Patterns agents use Workload Monitor API for, with concrete tasks.

★ Workload health dashboard backend

Power a workload health dashboard by calling the components and monitor instances summary endpoints to roll up state across an entire Azure subscription. The API returns counts and statuses suitable for high-level dashboards, with per-resource drill-downs available through the components and monitorInstances endpoints.

Call componentsSummary and monitorInstancesSummary for subscription 00000000-0000-0000-0000-000000000000 and return the unhealthy counts.

Per-resource health inspection

Drill from a subscription-wide summary into a single resource's monitored components and monitor instances to investigate why a workload appears unhealthy. The components and monitorInstances endpoints scoped to a specific resource provide detailed state per monitored item, supporting root-cause investigation.

List components on resource /subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Compute/virtualMachines/web-01 and return any in an unhealthy state.

Notification configuration audit

Read the notification settings on monitored resources to confirm who receives alerts when monitors change state. The notificationSettings endpoint exposes the configured channels so an agent can audit coverage and flag resources without notifications wired up.

Get the notification settings for resource /subscriptions/{sub}/resourceGroups/{rg}/providers/Microsoft.Compute/virtualMachines/web-01 and report the configured email recipients.

Agent-driven workload health checks

Let an AI agent answer 'is my production workload healthy?' by combining the summary endpoints with the per-resource detail calls through Jentic. This turns a multi-step portal investigation into a single conversational query.

Search Jentic for 'azure workload monitor instances summary', load the schema, execute it, and report any subscription with unhealthy instance counts above zero.

Key Endpoints

13 endpoints — the azure workload monitor api surfaces health monitoring data for workloads running on azure resources, including components, monitors, monitor instances, and notification settings under the microsoft.

METHOD

PATH

DESCRIPTION

GET

/subscriptions/{subscriptionId}/providers/Microsoft.WorkloadMonitor/componentsSummary

Subscription-wide component summary

GET

/subscriptions/{subscriptionId}/providers/Microsoft.WorkloadMonitor/monitorInstancesSummary

Subscription-wide monitor instance summary

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/components

List monitored components on a resource

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitorInstances

List monitor instances on a resource

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitors

List monitors attached to a resource

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/notificationSettings

Get notification settings for a resource

GET

/providers/Microsoft.WorkloadMonitor/operations

List available WorkloadMonitor operations

GET

/subscriptions/{subscriptionId}/providers/Microsoft.WorkloadMonitor/componentsSummary

Subscription-wide component summary

GET

/subscriptions/{subscriptionId}/providers/Microsoft.WorkloadMonitor/monitorInstancesSummary

Subscription-wide monitor instance summary

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/components

List monitored components on a resource

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceNamespace}/{resourceType}/{resourceName}/providers/Microsoft.WorkloadMonitor/monitorInstances

List monitor instances on a resource

GET

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Azure AD OAuth tokens for `azure_auth` are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped, short-lived bearer tokens — refresh tokens and client secrets never enter the agent context.

Intent-based discovery

Agents search Jentic by intent (e.g. 'azure workload health summary') and Jentic returns the matching componentsSummary or monitorInstancesSummary operation with its full input schema, so the agent can call the right ARM endpoint without reading docs.

Time to first call

Direct integration: a day or so to handle Azure AD auth, ARM polling, and the resource-namespace path templates. Through Jentic: under 30 minutes — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Azure Monitor Management Client

Production Azure Monitor surface for metrics, logs, and alerts

Choose Monitor Management for GA workflows; use Workload Monitor only when component- and monitor-instance-level workload health is specifically required.

Complementary

Application Insights Management Client

Manage Application Insights resources alongside workload health

Use Application Insights for application telemetry, and Workload Monitor for resource and component health summaries.

Complementary

Azure Alerts Management

Investigate and manage alerts triggered by workload state changes

Use Alerts Management to handle the alerts that fire when Workload Monitor sees an unhealthy monitor instance.

FAQs

Specific to using Workload Monitor API through Jentic.

What authentication does the Workload Monitor API use?

The API uses Azure Active Directory OAuth 2.0 via the implicit flow scheme `azure_auth`, scoped to user_impersonation against https://management.azure.com. Through Jentic the OAuth token stays in the vault and only short-lived scoped bearer tokens are exposed to the agent.

Can I get a subscription-wide summary of workload health?

Yes. GET /subscriptions/{subscriptionId}/providers/Microsoft.WorkloadMonitor/componentsSummary and the matching monitorInstancesSummary endpoint return rolled-up counts of components and monitor instances by health state across the whole subscription.

What are the rate limits for this API?

The spec does not declare explicit rate limits. Calls go through Azure Resource Manager, which applies standard ARM throttling per subscription. Inspect the x-ms-ratelimit-remaining-subscription-reads response header to track quota.

How do I list monitor instances on a specific VM through Jentic?

Search Jentic for 'list azure workload monitor instances on a resource', load the schema for GET /subscriptions/{sub}/resourceGroups/{rg}/providers/{ns}/{type}/{name}/providers/Microsoft.WorkloadMonitor/monitorInstances, and execute it. Install with `pip install jentic` and use the async search/load/execute pattern.

Does this API let me create new monitors?

No. The 2018-08-31 preview surface is read-oriented: you can list and get components, monitors, monitor instances, and notification settings, but the spec does not include create or update operations for monitors themselves. New monitors are created through the broader Azure Monitor configuration.

Is this API GA or still in preview?

It is the 2018-08-31 preview version. Treat workflows depending on it as preview-grade and prefer the production Azure Monitor APIs for long-lived automation.