Microsoft Azure

Azure Labservices: Virtual Machines

REST API for managing Azure Lab Services virtual machines.

Developer tools#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

REST API for managing Azure Lab Services virtual machines.

Endpoints 7

VirtualMachine

  • GETGet all virtual machines for a lab./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.LabServices/labs/:labName/virtualMachines?$filter=stringReturns a list of all virtual machines for a lab.
  • GETGet a lab virtual machine./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.LabServices/labs/:labName/virtualMachines/:virtualMachineNameReturns the properties for a lab virtual machine.
  • POSTStart a lab virtual machine./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.LabServices/labs/:labName/virtualMachines/:virtualMachineName/startAction to start a lab virtual machine.
  • POSTStop a lab virtual machine./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.LabServices/labs/:labName/virtualMachines/:virtualMachineName/stopAction to stop a lab virtual machine.
  • POSTRe-image a lab virtual machine./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.LabServices/labs/:labName/virtualMachines/:virtualMachineName/reimageRe-image a lab virtual machine. The virtual machine will be deleted and recreated using the latest published snapshot of the reference environment of the lab.
  • POSTRedeploy a lab virtual machine to a different compute node. For troubleshooting connectivity./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.LabServices/labs/:labName/virtualMachines/:virtualMachineName/redeployAction to redeploy a lab virtual machine to a different compute node. For troubleshooting connectivity.
  • POSTReset a lab virtual machine password./subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.LabServices/labs/:labName/virtualMachines/:virtualMachineName/resetPasswordResets a lab virtual machine password.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
7 operations on 7 pathsPOST 5GET 2
Main resources
VirtualMachine 7
Response formats
application/json
Description format
Swagger 2.0, API version 2023-06-07

How to test the Azure Labservices: Virtual Machines in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Labservices: Virtual Machines collection, without the publisher's secrets.
  3. Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get all virtual machines for a lab.” (GET /subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.LabServices/labs/:labName/virtualMachines?$filter=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Labservices: Virtual Machines?

REST API for managing Azure Lab Services virtual machines. It is listed under Developer tools and has 7 endpoints.

Who publishes the Azure Labservices: Virtual Machines?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Azure Labservices: Virtual Machines?

Requests go to https://management.azure.com. Endpoint paths are added to this base URL.

How do I authenticate with the Azure Labservices: Virtual Machines?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Labservices: Virtual Machines have?

7 operations on 7 paths (5 POST, 2 GET). The largest groups are VirtualMachine.

Is forking the Azure Labservices: Virtual Machines free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.