How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Microsoft Azure GuestAgents API

The GuestAgents API from Microsoft Azure — 4 operation(s) for guestagents.

Microsoft Azure GuestAgents API is one of 1667 APIs that Microsoft Azure publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include GuestAgents. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, a JSON-LD context, and a getting-started guide.

This API exposes 8 operations across 4 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 2020-08-01-preview.

8 operations 4 paths 12 schemas 2 DELETE4 GET2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2020-08-01-preview
Resource Areas
1

Paths & Operations 8

Across 4 paths, the API surfaces 8 operations — 2 DELETE, 4 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

GuestAgents 8
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/guestAgents/{name}
Microsoft Azure Implements Guestagent Put Method
microsoftAzureGuestagentsCreate 5 params body → 200201default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/guestAgents/{name}
Microsoft Azure Gets Guestagent
microsoftAzureGuestagentsGet 5 params → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/guestAgents/{name}
Microsoft Azure Deletes An Guestagent
microsoftAzureGuestagentsDelete 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachines/{virtualMachineName}/guestAgents
Microsoft Azure Implements Get Guestagent In A Vm
microsoftAzureGuestagentsList 4 params → 200default
PUT
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/guestAgents/{guestAgentName}
Microsoft Azure Implements Guestagent Put Method
microsoftAzureGuestagentsCreate 5 params body → 200201default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/guestAgents/{guestAgentName}
Microsoft Azure Gets Guestagent
microsoftAzureGuestagentsGet 5 params → 200default
DELETE
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/guestAgents/{guestAgentName}
Microsoft Azure Deletes An Guestagent
microsoftAzureGuestagentsDelete 5 params → 200202204default
GET
/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachines/{virtualMachineName}/guestAgents
Microsoft Azure Implements Get Guestagent In A Vm
microsoftAzureGuestagentsListbyvm 4 params → 200default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are GuestAgentProperties (9 properties), GuestAgentProperties_2 (7 properties), ResourceStatus (6 properties), ErrorDefinition (3 properties). Each schema is shown below with its type and property counts.

ErrorResponse
object
Error response.
1 property
GuestAgentProperties
object
Describes the properties of a Virtual Machine Guest Agent.
9 properties
ResourceStatus
object
The resource status information.
6 properties
GuestAgentList
object
List of GuestAgent.
2 properties 1 required
GuestAgent_2
object
Defines the GuestAgent.
1 property 1 required
HttpProxyConfiguration
object
HTTP Proxy configuration for the VM.
1 property
GuestAgent
object
Defines the GuestAgent.
1 property 1 required
ResourceProvisioningState
string
The current deployment state of resource.
ProvisioningAction
string
Defines the different types of operations for guest agent.
ErrorDefinition
object
Error definition.
3 properties
GuestCredential
object
Username / Password Credentials to connect to guest.
2 properties
GuestAgentProperties_2
object
Defines the resource properties.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

microsoft-azure-guestagents-api-openapi.yml Raw ↑

Other APIs Microsoft Azure publishes across the network.

Microsoft Azure AI Search API
Microsoft Azure Communication Services API
Microsoft Azure Event Grid API
Microsoft Azure Functions API
Microsoft Azure DevOps REST API
Microsoft Azure AI Foundry API
Microsoft Azure Resource JSON Schema
Microsoft Azure JSON-LD Context
Microsoft Azure AccessConnector API
Microsoft Azure AccessControlRecords API
Microsoft Azure AccessPolicies API
Microsoft Azure AccessReviewInstanceAcceptRecommmendations API
Where this information came from

This is an independent, third-party profile of Microsoft Azure GuestAgents API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.