ResourceHealthMetadata API Client

Name: ResourceHealthMetadata API Client API
Brand: ResourceHealthMetadata API Client
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCloud InfrastructureComputeoauth26 EndpointsREST

For Agents

Read Azure App Service resource health metadata for subscriptions, resource groups, web apps, and deployment slots so agents can interpret platform availability signals.

Connect the ResourceHealthMetadata API Client to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the ResourceHealthMetadata API Client, 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 ResourceHealthMetadata API Client API.

List resource health metadata for every App Service site in a subscription

Filter resource health metadata to a single resource group

Retrieve resource health metadata for a specific App Service site

Inspect resource health metadata for a deployment slot of a web app

GET STARTED

Start building with ResourceHealthMetadata API Client API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for ResourceHealthMetadata API Client, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for the ResourceHealthMetadata API Client, keeping it validated and agent-ready. The API exposes Azure App Service resource health metadata, which describes how the platform reports availability and signals for web apps and deployment slots. Agents can list metadata at the subscription, resource group, app, or slot level to understand what health categories Azure is tracking before correlating those signals with diagnostics or alerts. The service runs against the Azure Resource Manager control plane for the Microsoft.Web provider.

Use Cases

Patterns agents use ResourceHealthMetadata API Client API for, with concrete tasks.

★ App Service Availability Triage

Site reliability engineers triaging App Service incidents need to know which health signals Azure publishes for an affected site. The ResourceHealthMetadata API returns the metadata document describing how the platform classifies availability for that resource, which is the prerequisite for then querying Azure Resource Health or Service Health for the actual events. The triage runs against the Microsoft.Web provider in the Azure Resource Manager control plane.

GET /subscriptions/{subscriptionId}/resourceGroups/{rg}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata for the affected site and return the categories array

Deployment Slot Health Check

Before swapping a staging slot into production, an agent can fetch the slot's resource health metadata to confirm the platform is publishing availability signals for it. The slot-scoped endpoint returns metadata for a named slot under a given site, which lets the agent gate the swap on a healthy metadata response.

GET resourceHealthMetadata for site myapp slot staging and confirm the response contains a non-empty signalAvailability category before triggering a slot swap

Subscription-Wide App Service Inventory

Cloud governance teams building inventories of App Service workloads use the subscription-scoped list endpoint to enumerate every site that has health metadata published. The response gives a per-site metadata record, which is enough to seed a CMDB with the health-tracking posture of each web app without iterating through every resource group manually.

GET /subscriptions/{subscriptionId}/providers/Microsoft.Web/resourceHealthMetadata and return the count of sites with category=Availability

Agent-Driven Health Awareness via Jentic

Through Jentic, an SRE agent can search for app service health metadata, load the GET schema for the appropriate scope, and execute the call with a managed Azure OAuth token. The agent never handles a service principal secret directly, and the response feeds downstream operations such as opening incidents or pausing deployments.

Search Jentic for app service health metadata, load the site-scoped GET, execute it for site myapp in resource group rg-prod, and return the categories array to the calling workflow

Key Endpoints

6 endpoints — jentic publishes the only available openapi specification for the resourcehealthmetadata api client, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/subscriptions/{subscriptionId}/providers/Microsoft.Web/resourceHealthMetadata

List health metadata across a subscription

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/resourceHealthMetadata

List health metadata in a resource group

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata

List health metadata for a site

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata

List health metadata for a slot

GET

/subscriptions/{subscriptionId}/providers/Microsoft.Web/resourceHealthMetadata

List health metadata across a subscription

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/resourceHealthMetadata

List health metadata in a resource group

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/resourceHealthMetadata

List health metadata for a site

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata

List health metadata for a slot

Why though Jentic?

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

Credential isolation

Azure service principal credentials are stored encrypted in the Jentic vault. Agents receive scoped OAuth bearer tokens for the management.azure.com audience only — the client secret never enters the agent context.

Intent-based discovery

Agents search by intent such as app service health metadata or web app availability signals, and Jentic returns the matching ResourceHealthMetadata operation with its full input schema across subscription, resource group, site, and slot scopes.

Time to first call

Direct integration: half a day to wire MSAL and ARM error handling. Through Jentic: a few minutes to search, load the schema, and execute the call.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Azure WebApps API Client

Manage the App Service sites whose health metadata you read here

Use to list, configure, or restart the web apps that this metadata describes

Complementary

Azure Monitor (Microsoft.Insights)

Query metrics and alerts that complement health metadata

Use after metadata lookup to fetch the actual availability metric values and configure alerts

Alternative

Azure Microsoft.ResourceHealth

Returns the live availability events themselves rather than metadata

Use when you need current resource health status, not the schema describing what is tracked

FAQs

Specific to using ResourceHealthMetadata API Client API through Jentic.

Why is there no official OpenAPI spec for the ResourceHealthMetadata API Client?

Microsoft Azure does not publish a unified OpenAPI specification for the App Service ResourceHealthMetadata API. Jentic generates and maintains this spec so that AI agents and developers can call ResourceHealthMetadata via structured tooling. It is validated against the live Azure Resource Manager API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the ResourceHealthMetadata API Client use?

It uses Azure Active Directory OAuth 2.0 via the azure_auth flow defined in the spec. Acquire a bearer token for https://management.azure.com/.default and pass it as Authorization: Bearer. Jentic stores the underlying service principal in its vault and hands the agent only a scoped token.

Can I read health metadata for a deployment slot with this API?

Yes. Call GET /subscriptions/{subscriptionId}/resourceGroups/{rg}/providers/Microsoft.Web/sites/{name}/slots/{slot}/resourceHealthMetadata. The response describes how Azure tracks availability for that specific slot, separate from the production site.

Does the ResourceHealthMetadata API return live availability events?

No. This API returns metadata describing the categories and dimensions Azure tracks. To get the actual availability events you query Azure Resource Health or Service Health. Use this metadata to interpret what the live signals mean.

What are the rate limits for the ResourceHealthMetadata API?

Requests count against Azure Resource Manager subscription throttling, roughly 12,000 reads per hour per subscription. Throttled responses come back as HTTP 429 with a Retry-After header indicating how long to wait.

How do I look up site health metadata through Jentic?

Search Jentic for app service health metadata, call client.load on the site-scoped GET operation to receive its input schema, then call client.execute with subscriptionId, resourceGroupName, and the site name. Jentic injects the OAuth token and returns the metadata document.