VM Insights Onboarding

Name: VM Insights Onboarding API
Brand: VM Insights Onboarding
Availability: InStock

★ Only Publicly Available OpenAPI DocumentCloud InfrastructureComputeoauth21 EndpointsREST

For Agents

Reads the VM Insights onboarding status (workspace, data status, onboarded yes/no) for a VM, Scale Set, or resource group so agents can audit observability coverage.

Connect the VM Insights Onboarding to your agent

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

Check whether a specific VM is onboarded to VM Insights and which Log Analytics workspace receives its data

Audit a Virtual Machine Scale Set's VM Insights onboarding status to confirm observability coverage before scaling out

Sweep a resource group and report which resources have VM Insights enabled and which do not

Gate a deployment pipeline on a successful VM Insights onboarding check before promoting a workload

GET STARTED

Start building with VM Insights Onboarding API

Explore with Jentic

View OpenAPI Document

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

Jentic publishes the only available OpenAPI specification for VM Insights Onboarding, keeping it validated and agent-ready. The Azure VM Insights Onboarding API exposes a single Microsoft.Insights resource — vmInsightsOnboardingStatuses/default — that returns whether a given VM, VM Scale Set, or resource group is onboarded to VM Insights along with its associated Log Analytics workspace and data status. Agents use it to audit observability coverage, gate deployments on monitoring being present, and drive VM Insights enablement workflows. Authentication uses Azure Active Directory OAuth 2.0.

Use Cases

Patterns agents use VM Insights Onboarding API for, with concrete tasks.

★ Pre-deploy observability gate

A deployment pipeline that promotes new Scale Sets needs to confirm VM Insights is collecting performance and map data before traffic shifts. The agent calls GET /{resourceUri}/providers/Microsoft.Insights/vmInsightsOnboardingStatuses/default with the Scale Set's resource URI, asserts onboardingStatus is 'onboarded' and dataStatus is 'present', and only then proceeds. Failures route to a remediation step.

Call GET /{resourceUri}/providers/Microsoft.Insights/vmInsightsOnboardingStatuses/default for the Scale Set resource URI and fail the pipeline unless onboardingStatus='onboarded' and dataStatus='present'.

Subscription-wide coverage audit

An observability team auditing a subscription needs a list of VMs and Scale Sets whose VM Insights status is anything other than 'onboarded'. The agent enumerates compute resources via the Compute API, calls this endpoint for each resource URI, and emits a report grouped by resource group. The result drives the enablement backlog for the next sprint.

For each VM and Scale Set resource id in subscription SUB123, GET /{resourceUri}/providers/Microsoft.Insights/vmInsightsOnboardingStatuses/default; collect entries where onboardingStatus != 'onboarded' and write a CSV grouped by resource group.

Workspace mapping for cost attribution

FinOps teams attributing Log Analytics ingestion cost to workloads need to know which workspace each VM is sending data to. This endpoint returns workspaceResourceId per resource. The agent maps every onboarded resource to its workspace and joins to Log Analytics ingestion volumes for an accurate cost split.

Pull onboarding statuses for every VM in resource group 'platform-rg' and emit a JSON map of vmId to workspaceResourceId.

Agent-driven onboarding remediation via Jentic

An ops agent receiving an alert that a workload lacks VM Insights can call this endpoint through Jentic to confirm, then chain into the Microsoft.OperationsManagement and DCR APIs to onboard the resource. Jentic exposes the operation with the resourceUri parameter declared so the agent only needs to compose the resource id.

Search Jentic for 'vm insights onboarding status', execute the GET for resource URI '/subscriptions/SUB123/resourceGroups/web-rg/providers/Microsoft.Compute/virtualMachines/web-01', and return onboardingStatus plus workspaceResourceId.

Key Endpoints

1 endpoints — jentic publishes the only available openapi specification for vm insights onboarding, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/{resourceUri}/providers/Microsoft.Insights/vmInsightsOnboardingStatuses/default

Get the VM Insights onboarding status for a resource

GET

/{resourceUri}/providers/Microsoft.Insights/vmInsightsOnboardingStatuses/default

Get the VM Insights onboarding status for a resource

Why though Jentic?

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

Credential isolation

Azure AD client credentials stay encrypted in the Jentic vault. Agents see only a scoped OAuth bearer token at call time, so observability auditing never exposes the underlying service principal secret.

Intent-based discovery

Agents query Jentic with 'vm insights onboarding status' and Jentic returns the GET on /{resourceUri}/providers/Microsoft.Insights/vmInsightsOnboardingStatuses/default with the resourceUri parameter declared, ready to fill with the target ARM id.

Time to first call

Direct ARM integration: a few hours to wire MSAL and parse onboardingStatus. Through Jentic: under 15 minutes.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

MonitorManagementClient

Configures Azure Monitor metrics, alerts, and diagnostic settings alongside VM Insights

Use to set up alerts on the metrics VM Insights begins collecting once a resource is onboarded.

Complementary

Microsoft.Insights

Broader Microsoft.Insights provider including diagnostic settings and metric definitions

Use alongside VM Insights Onboarding when an agent needs to read metric data or configure diagnostic forwarding.

Alternative

ApplicationInsightsManagementClient

Application-level observability via Application Insights

Choose Application Insights when the workload needs APM and request-trace data; VM Insights covers infrastructure-level performance and dependency mapping.

FAQs

Specific to using VM Insights Onboarding API through Jentic.

Why is there no official OpenAPI spec for VM Insights Onboarding?

Microsoft Azure does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call VM Insights Onboarding 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 VM Insights Onboarding API use?

Azure Active Directory OAuth 2.0 with the user_impersonation scope against https://login.microsoftonline.com/common/oauth2/authorize. Through Jentic the AAD client secret stays encrypted in the vault and the agent only sees a scoped bearer token at call time.

Can I check whether a VM is onboarded to VM Insights with this API?

Yes. GET /{resourceUri}/providers/Microsoft.Insights/vmInsightsOnboardingStatuses/default returns onboardingStatus and dataStatus along with the linked Log Analytics workspaceResourceId. resourceUri is the full ARM id of the VM, Scale Set, or resource group.

What are the rate limits for the VM Insights Onboarding API?

Calls go through Azure Resource Manager and inherit the standard ARM read throttling envelope (roughly 12,000 reads per hour per subscription). The endpoint is read-only and lightweight; respect Retry-After on a 429.

How do I check VM Insights onboarding through Jentic?

Run pip install jentic, then client.search('vm insights onboarding status'), client.load on the returned GET on /{resourceUri}/providers/Microsoft.Insights/vmInsightsOnboardingStatuses/default, and client.execute with resourceUri set to the ARM id of the VM or Scale Set. Jentic injects the AAD bearer token from the vault.

Can this API onboard a VM to VM Insights?

No. This endpoint only reports status. To enable VM Insights, use the Microsoft.OperationsManagement solutions API and the Data Collection Rule (DCR) APIs to associate the VM with the correct Log Analytics workspace and DCR.