Microsoft Azure MicrosoftSerialConsoleClient

★ Only Publicly Available OpenAPI DocumentCloud InfrastructureComputeoauth24 Endpoints

Install Jentic One Beta

Connect the MicrosoftSerialConsoleClient to your agent

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

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: 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

Step 2: 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 MicrosoftSerialConsoleClient API.

Enable Serial Console access for an entire Azure subscription

Disable Serial Console access subscription-wide for compliance or lockdown scenarios

Retrieve the current Serial Console enablement state for a subscription

GET STARTED

Start building with MicrosoftSerialConsoleClient API

Explore with Jentic

View OpenAPI Document

For Agents

Enable or disable Azure Serial Console access at the subscription level and inspect operations metadata. Covers 4 endpoints for the consoleServices control plane.

Use for: Enable Azure Serial Console access for my subscription, I need to disable Serial Console access for compliance reasons, Check whether Serial Console is enabled on my subscription, Get the list of Serial Console operations available in this subscription

Not supported: Does not handle the serial console websocket stream, per-VM boot diagnostics, or VM lifecycle operations — use for subscription-level Serial Console enablement only.

Jentic publishes the only available OpenAPI specification for MicrosoftSerialConsoleClient, keeping it validated and agent-ready. The Azure Serial Console API enables and disables text-based serial console access at the subscription level for virtual machines and VM scale set instances. Serial Console is the recovery channel that operators reach for when SSH or RDP is unavailable, allowing direct keyboard input to the VM bootloader, single-user mode, or kernel debugger. The control plane exposed here governs subscription-wide enablement of the feature; the actual console stream is delivered over a separate websocket channel established through the Azure portal or CLI.

Use Cases

Patterns agents use MicrosoftSerialConsoleClient API for, with concrete tasks.

★ VM recovery prep

When a virtual machine becomes unreachable over the network, operators need Serial Console enabled before they can recover it. The API allows infrastructure-as-code workflows to enable the console at subscription provisioning time, so when the unreachable-VM page fires the on-call engineer can connect immediately rather than waiting on a portal toggle. Enablement is idempotent and takes effect within seconds.

Enable Serial Console for subscription abc by calling POST /subscriptions/abc/providers/Microsoft.SerialConsole/consoleServices/{default}/enableConsole and confirm the enabled flag is true.

Compliance lockdown of recovery channels

Some regulated environments require Serial Console to be disabled outside of break-glass scenarios because it bypasses identity-aware proxies. Compliance tooling can call the disableConsole endpoint on a schedule and verify the state via the get endpoint, then re-enable it only when an approved change ticket is open. This produces an auditable trail of when out-of-band access was available.

Disable Serial Console for subscription abc by calling POST /subscriptions/abc/providers/Microsoft.SerialConsole/consoleServices/{default}/disableConsole and assert the get endpoint returns disabled true.

Console state reporting across subscriptions

Cloud governance teams that manage many subscriptions need a quick way to report which ones have Serial Console enabled. Iterating subscriptions and calling GET on the consoleServices/{default} resource yields a per-subscription enabled flag that can populate a compliance dashboard. The endpoint is read-only and inexpensive, so it can run on a frequent governance cadence.

Retrieve Serial Console state for each subscription in the tenant and produce a CSV with subscription ID, name, and enabled status.

Agent-driven recovery readiness

AI agents can use Jentic to discover MicrosoftSerialConsoleClient operations by intent, load the structured input schema, and execute calls against management.azure.com without browsing the Azure REST docs. When an alerting agent escalates an unreachable-VM page, it can pre-flight Serial Console enablement on the subscription so the human responder finds the channel ready when they connect.

Search Jentic for enable azure serial console, load the input schema, and execute it for the affected subscription before paging the on-call engineer.

Key Endpoints

4 endpoints — jentic publishes the only available openapi specification for microsoftserialconsoleclient, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

GET

/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}

Get current Serial Console enablement state

POST

/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/enableConsole

Enable Serial Console for a subscription

POST

/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/disableConsole

Disable Serial Console for a subscription

GET

/providers/Microsoft.SerialConsole/operations

List Microsoft.SerialConsole operations

GET

/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}

Get current Serial Console enablement state

POST

/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/enableConsole

Enable Serial Console for a subscription

POST

/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/disableConsole

Disable Serial Console for a subscription

GET

/providers/Microsoft.SerialConsole/operations

List Microsoft.SerialConsole operations

Why Jentic?

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

Credential isolation

Your Azure AD credential is stored once, encrypted, by your own Jentic One instance and exchanged for a short-lived ARM-scoped bearer token at execution time. It never enters the agent's prompt, logs, or context.

Intent-based discovery

Agents search Jentic by intent such as 'enable Azure Serial Console for a subscription' or 'check whether Serial Console is enabled', and Jentic returns the matching Serial Console operation with its input schema so the agent supplies the subscription and executes.

Time to first call

FAQs

Specific to using MicrosoftSerialConsoleClient API through Jentic.

Why is there no official OpenAPI spec for MicrosoftSerialConsoleClient?

Microsoft Azure does not publish an OpenAPI specification for the Microsoft.SerialConsole Resource Provider. Jentic generates and maintains this spec from the Azure Resource Manager contracts so that AI agents and developers can call MicrosoftSerialConsoleClient 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 Serial Console API use?

The API uses Azure Active Directory OAuth 2.0 with the user_impersonation scope against https://login.microsoftonline.com/common/oauth2/authorize. Jentic stores the AAD client secret or service principal credentials encrypted in its vault and supplies scoped bearer tokens to agents at execution time without exposing the underlying credential.

Can I enable Serial Console for a single VM through this API?

No. Enablement is subscription-scoped: POST /subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/enableConsole turns Serial Console on for every supported VM and VM scale set instance in the subscription. Per-VM diagnostic settings such as boot diagnostics are managed by the compute management API.

What are the rate limits for the Azure Serial Console API?

The API follows the standard Azure Resource Manager throttling limits, which apply per subscription and per region. Read operations are limited to 1200 requests per hour per subscription. Enable and disable operations are infrequent control-plane changes, so practical rate limits are not a concern outside of bulk governance scans across many subscriptions.

How do I disable Serial Console through Jentic?

Search Jentic for disable azure serial console, load the schema for POST /subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/disableConsole, and execute it with the target subscription ID. Jentic handles the AAD token exchange and returns the resulting state, which the agent can verify with a follow-up GET.

Does the Serial Console API stream console output?

No. The serial stream itself is delivered over a separate websocket channel established by the Azure portal or by the az serial-console CLI. This API only governs whether the feature is enabled at the subscription level; it does not transport keystrokes or boot output.

Microsoft Azure MicrosoftSerialConsoleClient

Connect the MicrosoftSerialConsoleClient to your agent

Capabilities

Start building with MicrosoftSerialConsoleClient API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs