Microsoft Azure SqlVirtualMachineManagementClient
Browse all Azure APIs43
AI ReadinessFoundational (D-)43/100
Agent-ready OpenAPI document · curated by JenticCloud InfrastructureComputeoauth218 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Provision, configure, and delete SQL Server virtual machines, virtual machine groups, and availability group listeners on Azure.
Use for: I want to provision a SQL Server 2019 virtual machine on Azure, List all SQL virtual machines in my subscription, Create a SQL virtual machine group for an Always On availability cluster, Add an availability group listener to my SQL VM group
Not supported: Does not configure SQL Server cluster internals, run T-SQL, or manage Azure SQL Database PaaS - use for Azure-side lifecycle of SQL Server VMs, groups, and listeners only.
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.
Install Jentic One Beta
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.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fazure.com%2Fsqlvirtualmachinemanagementclient" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fazure.com%2Fsqlvirtualmachinemanagementclient" | sh
jentic register # connects your agent to your Jentic One instanceJentic 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
Update the SQL Server license type or storage configuration on a VM
Delete a SQL virtual machine and its group membership
Discover available SQL VM management operations supported by the resource provider
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 your Jentic One instance.
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
/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
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
S
SqlVirtualMachineManagementClient
- Foundational (D-)43/100
65
Foundational Compliance61
Developer Experience & Jentic Compatibility21
AI-Readiness & Agent Experience94
Agent Usability35
Security100
AI DiscoverabilityPowered by JenticScoring Framework 1.0.0 | Scoring Engine 0.4.0
Show dimension breakdown
65
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: BSignals: 4
84%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
100%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
0%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
75%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
61
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
93%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
21
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
85%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
0%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
0%
Summary Coverage
Coverage of summaries across operations/tags/info.
94
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: A+Signals: 1
94%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
35
Security
Trust, risk posture, and security compliance.
Grade: FSignals: 1
35%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
100
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: A+Signals: 1
100%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the Microsoft.SqlVirtualMachine provider by hand means registering an Azure AD app, running the OAuth2 token exchange, and polling the Azure-AsyncOperation header that create and delete operations return with 202. Through Jentic you install once, import SQL Virtual Machine Management from the API Directory, store the Azure AD service principal credential once, and your agent calls it.
Permission scoping
This API puts the subscription, resource group, and SQL VM or group name in the URL path (/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SqlVirtualMachine/sqlVirtualMachineGroups/{sqlVirtualMachineGroupName}/...), so a rule can pin your agent to one SQL VM group and its listeners. You choose the operations it may call, so deleting a SQL virtual machine or removing an availability group listener is not included unless you add it.
Credential isolation
Your Azure AD service principal credential is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'create a SQL Server virtual machine on Azure' or 'add an availability group listener', and Jentic returns the matching Microsoft.SqlVirtualMachine operation with its input schema so the agent calls the right endpoint without reading the ARM reference.
Related APIs
Alternatives and complements available in the Jentic catalogue.
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 with Jentic One, the self-hosted execution layer.
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 your Jentic One instance 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.
Can I limit what my agent is allowed to do with the Azure SQL Virtual Machine Management Client API?
Yes. Jentic One is self-hosted by you, so your own rules decide which operations and credentials the agent may use. Because this API carries the subscription, resource group, and SQL VM or group name in the URL path, you can pin the agent to a single SQL virtual machine group and its availability group listeners. You also choose the operations it may call, so destructive actions like deleting a SQL virtual machine or removing an availability group listener stay out of reach unless you add them.
GET STARTED