SqlVirtualMachineManagementClient

★ Only Publicly Available OpenAPI DocumentCloud InfrastructureComputeoauth218 EndpointsREST

For Agents

Provision, configure, and delete SQL Server virtual machines, virtual machine groups, and availability group listeners on Azure.

Connect the SqlVirtualMachineManagementClient to your agent

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

Create and configure a SQL Server virtual machine in Azure

List every SQL virtual machine across a subscription or resource group

Group SQL virtual machines into a SQL virtual machine group for clustering

Add and remove availability group listeners for Always On groups

GET STARTED

Start building with SqlVirtualMachineManagementClient API

Explore with Jentic

View OpenAPI Document

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

Jentic publishes the only available OpenAPI specification for SqlVirtualMachineManagementClient, keeping it validated and agent-ready. The SQL virtual machine management API exposes RESTful operations to provision and manage SQL Server installations running on Azure Compute, including individual SQL virtual machines, SQL virtual machine groups, and availability group listeners. It coordinates with Azure Compute, Network, and Storage to install, configure, and tear down SQL Server VMs, and to wire them into Always On availability groups. Use it for IaaS SQL Server lifecycle management, not Azure SQL Database PaaS schemas.

Use Cases

Patterns agents use SqlVirtualMachineManagementClient API for, with concrete tasks.

★ Lift-and-Shift SQL Server to Azure VMs

Teams migrating on-premises SQL Server workloads onto Azure IaaS rather than Azure SQL Database use SqlVirtualMachineManagementClient to register and manage the SQL VM resource that wraps the underlying Azure Compute VM. The API handles the SQL-specific configuration layer — license type, storage layout, and Always On group membership — leaving the base VM lifecycle to Microsoft.Compute. A single migration script can stand up a SQL VM, register it, and join it to an availability group in minutes.

Create a SQL virtual machine resource named 'finance-sql-01' in resource group 'finance-rg' tied to an existing compute VM, with PAYG license type.

Building Always On Availability Clusters

High-availability SQL Server deployments on Azure require a SQL virtual machine group plus availability group listeners that route traffic to the current primary replica. SqlVirtualMachineManagementClient creates the group resource, registers each SQL VM into it, and provisions the listener with the right load balancer wiring. Failover behaviour is handled by SQL Server itself; this API manages the Azure-side metadata that ties it together.

Create a SQL virtual machine group 'sales-ag' in resource group 'sales-rg', register two existing SQL VMs to it, then add an availability group listener on port 1433.

Bulk Audit of SQL VM Estate

Operations teams running dozens of SQL VMs across multiple subscriptions need an inventory of license types, group membership, and configuration drift. SqlVirtualMachineManagementClient supports listing SQL VMs by subscription and by resource group, returning the SQL-specific metadata for each. A nightly job can pull the full estate, compare against expected configuration, and raise alerts on drift.

List every SQL virtual machine in subscription 'data-platform', then group results by license type and resource group.

Agent-Driven SQL VM Provisioning via Jentic

An AI agent that orchestrates infrastructure can provision SQL Server on Azure VMs without learning the full ARM JSON model. Through Jentic, the agent discovers the SqlVirtualMachineManagementClient operations by intent, loads the create-or-update schema for SQL virtual machines, and submits the request with the user's parameters. Azure AD tokens stay inside the Jentic vault.

Use Jentic to load the SqlVirtualMachineManagementClient create-or-update operation, then create a SQL VM 'reporting-sql-02' tied to an existing compute resource id.

Key Endpoints

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

METHOD

PATH

DESCRIPTION

GET

/providers/Microsoft.SqlVirtualMachine/operations

List operations exposed by the resource provider

GET

/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines

List SQL virtual machines in a subscription

GET

/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups

List SQL virtual machine groups in a subscription

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}

Create or update a SQL virtual machine group

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/availabilityGroupListeners/{availabilityGroupListenerName}

Create or update an availability group listener

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/sqlVirtualMachines

List SQL VMs registered to a group

GET

/providers/Microsoft.SqlVirtualMachine/operations

List operations exposed by the resource provider

GET

/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachines

List SQL virtual machines in a subscription

GET

/subscriptions/{subscriptionId}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups

List SQL virtual machine groups in a subscription

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}

Create or update a SQL virtual machine group

PUT

Why though Jentic?

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

Credential isolation

Azure AD OAuth tokens are stored encrypted in the Jentic vault (MAXsystem). Agents calling SqlVirtualMachineManagementClient receive scoped, short-lived bearer tokens at execution time — refresh tokens and tenant secrets never enter the agent's context.

Intent-based discovery

Agents search Jentic by intent (e.g., 'create a sql server virtual machine on azure') and Jentic returns the matching SqlVirtualMachineManagementClient operation with its full input schema, so the agent can call create, update, or delete without reading ARM docs.

Time to first call

Direct integration with Azure Resource Manager — service principal setup, MSAL token handling, ARM polling — typically takes 1-2 days. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

SqlManagementClient

Manages Azure SQL Database PaaS schema metadata rather than SQL Server on VMs

Choose SqlManagementClient when the workload is Azure SQL Database (PaaS); choose this when SQL Server runs on an Azure VM.

Complementary

StorageManagementClient

Manages the storage accounts that hold SQL backups and data files

Pair with SqlVirtualMachineManagementClient when configuring backup destinations or attached data disks.

Complementary

StorageImportExport

Bulk import and export of disk data into Azure Storage

Useful when seeding a SQL VM's data disks from large on-premises datasets shipped to Azure.

FAQs

Specific to using SqlVirtualMachineManagementClient API through Jentic.

Why is there no official OpenAPI spec for SqlVirtualMachineManagementClient?

Microsoft Azure publishes Swagger fragments for individual ARM resource providers but does not publish a consolidated, validated OpenAPI 3 spec for the Microsoft.SqlVirtualMachine provider. Jentic generates and maintains this spec so that AI agents and developers can call SqlVirtualMachineManagementClient 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 SqlVirtualMachineManagementClient use?

All endpoints require Azure Active Directory OAuth 2.0, declared as the azure_auth security scheme with the user_impersonation scope against https://login.microsoftonline.com. Through Jentic, Azure access tokens are held in the Jentic vault and injected at call time so the agent never sees the raw bearer token.

Can I create a SQL Server availability group with this API?

You can create the Azure-side resources that support an Always On availability group: a SQL virtual machine group and one or more availability group listeners under /providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{name}/availabilityGroupListeners. The actual SQL Server cluster configuration still happens inside SQL Server itself.

What are the rate limits for the SqlVirtualMachineManagementClient?

Calls go through Azure Resource Manager, which throttles writes per subscription (typically 1,200 writes per hour) and reads more generously. Long-running operations like create or delete return 202 with an Azure-AsyncOperation header — poll that URL rather than retrying the original call.

How do I provision a SQL VM through Jentic?

Run pip install jentic, search Jentic for 'create a sql server virtual machine on azure', load the SqlVirtualMachineManagementClient create-or-update operation, and execute it with subscriptionId, resourceGroupName, sqlVirtualMachineName, and the body containing the linked virtualMachineResourceId and sqlServerLicenseType. Jentic handles the Azure AD token exchange.

Does this API manage Azure SQL Database (PaaS)?

No. SqlVirtualMachineManagementClient only manages SQL Server running inside Azure Compute VMs. For Azure SQL Database PaaS, use SqlManagementClient or the Microsoft.Sql resource provider APIs.