portal

Name: portal API
Brand: Azure Portal Dashboards
Availability: InStock

★ Only Publicly Available OpenAPI DocumentProductivityCollaborationoauth27 EndpointsREST

For Agents

Provision and manage shared Azure portal dashboards (tile layouts) at subscription and resource group scope through 7 ARM operations on Microsoft.Portal.

Connect the portal to your agent

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

Create a shared portal dashboard from a JSON layout definition

List shared dashboards in a subscription or in a specific resource group

Retrieve a dashboard definition for export or version control

Update an existing dashboard's tile layout, scope filters, or markdown content

GET STARTED

Start building with portal API

Explore with Jentic

View OpenAPI Document

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

Jentic publishes the only available OpenAPI specification for the Azure Portal dashboard API, keeping it validated and agent-ready. The Microsoft.Portal management API exposes 7 operations for managing shared dashboards in the Azure portal — the rectangular layouts of tiles (charts, markdown notes, resource lists) that engineering and operations teams pin into the portal home page. Use it to publish a dashboard programmatically as code, share it across a resource group, version it through CI, and tear down ephemeral dashboards when an investigation is finished.

Use Cases

Patterns agents use portal API for, with concrete tasks.

★ Dashboards as Code

Treat operational dashboards the same way you treat infrastructure — JSON definitions in a repository, deployed through CI. The API's create/update endpoint takes the dashboard layout in the request body, so a pipeline can render a dashboard from a template, apply environment-specific variables (subscription IDs, resource names), and push it to the target resource group. Drift between environments disappears because the source of truth is the repo, not what someone clicked together in the portal.

Read the dashboard JSON template at /dashboards/prod-overview.json, substitute the production subscription ID, and create or update the dashboard in resource group 'observability'

Incident Dashboard Lifecycle

During an incident an SRE may stand up an ad-hoc dashboard pinning all the relevant resources, log queries, and metric charts for the incident's duration. After the incident closes the dashboard is no longer useful and should be removed. Listing dashboards in the incident resource group, identifying ones older than a threshold, and deleting them keeps the portal home page tidy without anyone needing to remember to clean up manually.

List dashboards in resource group 'incident-response', filter to those tagged 'incident' with createdDate older than 14 days, and delete each one

Cross-Environment Dashboard Promotion

Promote a dashboard from a development resource group to production. The flow is: GET the dashboard from the source resource group, rewrite the embedded resource scopes (subscription IDs, resource group names) to point at production resources, and PUT the new dashboard to the target resource group. This pattern lets observability teams iterate on dashboards in a sandbox before exposing them to on-call engineers.

Get dashboard 'service-health' from resource group 'dashboards-dev', substitute every reference to subscription dev-sub with prod-sub, and create the dashboard in resource group 'dashboards-prod'

AI Agent Dashboard Operator

An AI agent in an SRE workflow can publish and tear down portal dashboards through Jentic. The agent searches by intent ('create an azure portal dashboard'), Jentic returns the Dashboards_CreateOrUpdate operation with its schema, and the agent executes the call with managed Azure credentials. Listing, retrieval, and deletion follow the same intent-driven flow.

Search Jentic for 'create an Azure portal dashboard', load the Dashboards_CreateOrUpdate schema, and execute it with the supplied dashboard JSON in the target resource group

Key Endpoints

7 endpoints — jentic publishes the only available openapi specification for the azure portal dashboard api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/subscriptions/{subscriptionId}/providers/Microsoft.Portal/dashboards

List all shared dashboards in a subscription

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards

List dashboards in a resource group

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}

Get a specific dashboard

GET

/providers/Microsoft.Portal/operations

List Microsoft.Portal provider operations

GET

/subscriptions/{subscriptionId}/providers/Microsoft.Portal/dashboards

List all shared dashboards in a subscription

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards

List dashboards in a resource group

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Portal/dashboards/{dashboardName}

Get a specific dashboard

GET

/providers/Microsoft.Portal/operations

List Microsoft.Portal provider operations

Why though Jentic?

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

Credential isolation

Azure service principal credentials are encrypted in the Jentic vault. Agents receive scoped ARM bearer tokens at execution time and never see the underlying client secret.

Intent-based discovery

Agents search by intent ('create an azure portal dashboard' or 'list azure dashboards') and Jentic returns the matching operation, avoiding the need to learn the Microsoft.Portal namespace.

Time to first call

Direct ARM integration: a couple of hours for AAD app registration, MSAL token handling, and dashboard JSON modelling. Through Jentic: under 15 minutes.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Azure Monitor

Provides the metrics and log queries that dashboard tiles render.

Use Monitor to set up the underlying metrics and queries; use Portal to lay them out for human consumption.

Complementary

Application Insights Management

Provision the Application Insights resources whose data dashboards display.

Use App Insights Management to provision telemetry sources before a dashboard tiles them.

Complementary

Azure Advisor Management

Provides recommendations that operations dashboards commonly surface.

Use Advisor to fetch recommendations whose summaries can be tiled in a portal dashboard.

FAQs

Specific to using portal API through Jentic.

Why is there no official OpenAPI spec for the Azure Portal dashboard API?

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

What authentication does the Azure Portal dashboard API use?

It uses Azure Active Directory OAuth 2.0 against https://management.azure.com/ with the user_impersonation scope. The caller needs Contributor or a custom role with Microsoft.Portal/dashboards/* permissions on the resource group. Jentic stores service principal credentials encrypted and issues short-lived bearer tokens at execution time.

Can I publish a dashboard from a JSON template through this API?

Yes. PUT to /subscriptions/{id}/resourceGroups/{rg}/providers/Microsoft.Portal/dashboards/{name} with the dashboard layout (lenses, parts, metadata) in the request body. The dashboard appears in the Azure portal under Shared Dashboards immediately after the call returns 201.

What are the rate limits for the Azure Portal dashboard API?

Azure Resource Manager applies subscription-level throttling at roughly 1,200 reads and 1,200 writes per hour. Dashboard create and update operations are synchronous and typically complete in well under a second.

How do I publish a dashboard through Jentic?

Run pip install jentic and search for 'create an azure portal dashboard'. Jentic returns the Dashboards_CreateOrUpdate operation; load its schema and execute it with your resource group, dashboard name, and the JSON layout body.

Can I export an existing portal dashboard to JSON through this API?

Yes. GET /subscriptions/{id}/resourceGroups/{rg}/providers/Microsoft.Portal/dashboards/{name} returns the full dashboard definition, including its lenses and tile parts, ready to commit into version control or apply to another environment.