Guest Diagnostic Settings

Name: Guest Diagnostic Settings API
Brand: Azure Guest Diagnostic Settings
Availability: InStock

★ Only Publicly Available OpenAPI DocumentDeveloper ToolsMonitoring Observabilityoauth26 EndpointsREST

For Agents

Define and manage reusable guest diagnostic configurations — the lists of event logs, perf counters, and ETW providers Azure Monitor should collect from inside VMs.

Connect the Guest Diagnostic Settings to your agent

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

Define a reusable guest diagnostic settings resource specifying event logs and perf counters to collect

List guest diagnostic settings across a subscription or filter by resource group

Retrieve the full configuration of a single guest diagnostic settings resource

Update tags or properties of an existing guest diagnostic settings resource

GET STARTED

Start building with Guest Diagnostic Settings API

Explore with Jentic

View OpenAPI Document

Use for: I need to create a reusable diagnostic profile that collects Windows Security event logs, List all guest diagnostic settings in the resource group 'monitoring-rg', Retrieve the perf counter list defined in the 'baseline' diagnostic settings, Update the diagnostic settings 'baseline' to add CPU and disk counters

Not supported: Does not attach settings to specific VMs, collect platform logs, or query telemetry data — use for managing the reusable settings resource only.

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

Jentic publishes the only available OpenAPI specification for Guest Diagnostic Settings, keeping it validated and agent-ready. The Azure Guest Diagnostic Settings API manages reusable diagnostic configurations that describe which Windows event logs, performance counters, and ETW traces should be collected from inside Azure VMs and Arc-managed servers. Operators define a setting once and then attach it to many guests via the companion association API. The API runs against Azure Resource Manager with Azure AD OAuth2 and exposes six list, get, create-or-update, update, and delete operations on the microsoft.insights provider.

Use Cases

Patterns agents use Guest Diagnostic Settings API for, with concrete tasks.

★ Standardise VM telemetry across an environment

Define one canonical guest diagnostic settings resource that lists the event logs and perf counters needed for compliance and operations, then attach it to every VM via the association API. Centralises the collection profile so changing what gets collected is a single PATCH instead of touching each VM. Suitable for fleets where consistent telemetry is a regulatory requirement.

Create a guestDiagnosticSettings named 'baseline' in resource group 'monitoring-rg' that collects Windows Security event level Warning and CPU + disk perf counters.

Audit existing diagnostic profiles

Walk every guest diagnostic settings resource in a subscription to verify that all collection profiles include required logs and counters. The List endpoint returns the full configuration in one call so an auditor can compare against policy without inspecting each VM. Useful before a compliance review.

List all guestDiagnosticSettings in subscription 'sub-prod' and return any that do not include the Security event log.

Retire deprecated collection profiles

Delete a guest diagnostic settings resource once all VMs have been migrated to a newer profile. Removes ARM-level configuration without touching the underlying VMs, so the operation is non-disruptive. Useful at the end of a telemetry migration project.

Delete the guestDiagnosticSettings 'preview-diag' from resource group 'monitoring-rg' once no associations reference it.

AI agent telemetry policy management

An ops agent maintains diagnostic profiles via Jentic, calling create-or-update to add new perf counters when a new monitoring requirement lands. Jentic resolves the agent's natural-language intent to the correct PUT or PATCH operation and injects the bearer token at execution. The agent never sees raw Azure credentials.

Use Jentic to search for 'update azure guest diagnostic settings', load guestDiagnosticsSettings_Update, and add 'Memory\Available MBytes' to the 'baseline' profile.

Key Endpoints

6 endpoints — jentic publishes the only available openapi specification for guest diagnostic settings, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/subscriptions/{subscriptionId}/providers/microsoft.insights/guestDiagnosticSettings

List all guest diagnostic settings in a subscription

GET