canonical: https://jentic.com/apis/azure.com/vmwarecloudsimple

# Microsoft Azure VMwareCloudSimple

Jentic publishes the only available OpenAPI specification for VMwareCloudSimple, keeping it validated and agent-ready. The Azure VMwareCloudSimple API provisions and manages CloudSimple-hosted VMware private clouds, dedicated cloud nodes, virtual machines, virtual networks, and customisation policies inside Microsoft Azure. It exposes 34 management plane operations across 25 resource paths under the Microsoft.VMwareCloudSimple provider, covering private cloud lifecycle, node placement on dedicated hardware, VM templates, and SKU availability lookups by region. Use it to drive infrastructure-as-code workflows for VMware workloads on Azure without leaving the ARM control plane.

## For AI agents

Provision VMware private clouds, dedicated nodes, and virtual machines on Azure CloudSimple, and inspect available SKUs and regions through the Azure Resource Manager control plane.

## Scope

Does not handle guest OS configuration, application deployment, or in-guest patching - use for Azure CloudSimple control plane operations only.

## Capabilities

- Provision and tear down VMware private clouds in specific Azure regions under a subscription
- Reserve and release dedicated cloud nodes for isolated VMware workloads
- Create virtual machines from VM templates and attach them to virtual networks
- List customisation policies and resource pools available within a private cloud
- Look up SKU and region availability before provisioning new CloudSimple resources
- Track long-running operations through operation result endpoints for audit and reconciliation

## Use cases

### Lift-and-shift VMware workloads to Azure

Migrate existing on-premises VMware workloads to Azure by provisioning a CloudSimple private cloud, reserving dedicated nodes, and creating virtual machines from existing templates. The API exposes the full ARM lifecycle for private clouds and nodes so migration can be scripted end to end. Typical first-pass provisioning takes minutes once SKU and region availability have been confirmed.

Example prompt: Create a private cloud named prod-vmw-eastus in region eastus with one dedicated node SKU and verify the operation reaches succeeded state.

### Capacity planning for VMware private clouds

Query availability of CloudSimple SKUs across regions before placing capacity, so finance and platform teams can plan reservations against dedicated cloud nodes. The availabilities and dedicatedCloudServices endpoints expose what can be provisioned where, allowing agents to pre-validate capacity before initiating long-running provisioning calls.

Example prompt: List all availabilities under regionId=eastus2 and report which dedicated cloud node SKUs have remaining capacity.

### Automated VM provisioning from templates

Stand up VMware virtual machines from existing VM templates on a CloudSimple private cloud and attach them to specific virtual networks and resource pools. The virtualMachineTemplates, virtualNetworks, and resourcePools endpoints provide everything needed to drive a templated VM build from an automation runner.

Example prompt: Create a virtual machine named app-01 from template tpl-rhel8 on private cloud pc-prod, attached to network vnet-app, and confirm the deployment status.

### Agent-driven infrastructure operations on CloudSimple

Let an AI agent drive routine CloudSimple operations such as listing private clouds, retrieving node status, and polling operation results, using Jentic to discover and call the right management plane endpoints without hand-coding ARM URIs. This lets ops teams expose VMware-on-Azure runbooks as agent tools.

Example prompt: Search Jentic for 'list azure vmware private clouds', load the operation schema, and execute it against subscription 00000000-0000-0000-0000-000000000000.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds | List private clouds in a region |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName} | Get a private cloud by name |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes | List dedicated cloud nodes |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/availabilities | List availability for SKUs in a region |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/customizationPolicies | List customisation policies on a private cloud |
| GET | /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/operationResults/{operationId} | Track a long-running operation |
| GET | /providers/Microsoft.VMwareCloudSimple/operations | List all available operations under the provider |

## Key resources

- **PrivateClouds** — Provision and manage CloudSimple private clouds per region
- **DedicatedCloudNodes** — Reserve and inspect dedicated VMware host nodes
- **VirtualMachines** — Create and manage VMs running on a private cloud
- **VirtualMachineTemplates** — Discover VM templates available for provisioning
- **VirtualNetwork** — List virtual networks available within a private cloud
- **CustomizationPolicies** — Inspect guest OS customisation policies for a private cloud
- **AvailabilityUsages** — Check SKU availability for capacity planning

## Why Jentic

- **Setup:** Driving the VMware CloudSimple control plane by hand means acquiring Azure Active Directory OAuth 2.0 tokens, targeting the management.azure.com ARM control plane, and threading subscription, region, and private cloud names through every path yourself. Through Jentic you install once, import VMware CloudSimple from the API Directory, store the Azure AD credential once, and your agent calls it.
- **Permission scoping:** This API carries the subscription, region, and private cloud name in the URL path (/subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}), so a rule can pin your agent to one private cloud or region and nothing else. You choose the operations it may call, so anything that deletes a dedicated cloud node or virtual machine is not included unless you add it.
- **Credential handling:** Your Azure AD token 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.
- **Discovery method:** Agents search Jentic by intent such as 'list VMware private clouds in a region' or 'check CloudSimple node availability', and Jentic returns the matching VMwareCloudSimple operation with its input schema so the agent calls the right ARM endpoint without browsing Microsoft docs.

## Related APIs

- **Azure Compute Management Client** — Native Azure VM management without the VMware hypervisor layer
- **Azure Network Management Client** — Manage Azure virtual networks, NSGs and routing alongside CloudSimple
- **Azure Resource Graph** — Query CloudSimple resources at scale across subscriptions with KQL

## FAQ

### Why is there no official OpenAPI spec for VMwareCloudSimple?

Microsoft Azure does not publish a standalone OpenAPI specification for the VMwareCloudSimple management API. Jentic generates and maintains this spec from the published Azure REST API definitions so that AI agents and developers can call VMwareCloudSimple via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the VMwareCloudSimple API use?

The API uses Azure Active Directory OAuth 2.0 via the implicit flow scheme `azure_auth` defined in the spec, scoped to user_impersonation against https://management.azure.com. When called through Jentic, the OAuth token is held in your Jentic One instance and only short-lived scoped credentials are exposed to the agent.

### Can I provision a VMware private cloud with this API?

Yes. The PUT operation on /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName} provisions a private cloud in the specified region, and the matching operationResults endpoint lets you poll until the long-running operation completes.

### What are the rate limits for the VMwareCloudSimple API?

The spec does not declare explicit rate limits. Calls go through Azure Resource Manager, which enforces standard ARM throttling per subscription and per region. Inspect the x-ms-ratelimit-remaining-subscription-* response headers in production to see remaining quota.

### How do I list dedicated cloud nodes through Jentic?

Search Jentic for 'list azure vmware dedicated cloud nodes', load the operation schema for GET /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/dedicatedCloudNodes, then execute it with your subscriptionId. Install with `pip install jentic` and use the async search/load/execute pattern.

### Does this API cover guest OS configuration inside the VM?

No. The API manages the placement and lifecycle of VMs and private clouds at the Azure control plane only. Guest OS configuration, application installation, and in-guest patching are not in scope and must be handled by VMware tooling or configuration management running inside the VM.

### Can I limit what my agent is allowed to do with the Microsoft Azure VMwareCloudSimple API?

Yes. Because you run Jentic One yourself, your own rules decide which operations and credentials the agent may use, and the API carries the subscription, region, and private cloud name in the URL path, so you can pin the agent to a single private cloud or region and nothing else. You choose which operations it may call, so read-only calls like listing private clouds, dedicated cloud nodes, or SKU availability can be enabled while anything that deletes a dedicated cloud node or virtual machine stays out unless you add it. The stored Azure AD token is injected at execution time and never enters the agent's prompt or logs.