Microsoft Azure

Azure Compute: Run Commands

The Run Commands Client.

Developer tools#openapi#cloud

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

The Run Commands Client.

Endpoints 14

VirtualMachineRunCommands

  • GETVirtualMachineRunCommands_List/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/runCommands?api-version=stringLists all available run commands for a subscription in a location.
  • GETVirtualMachineRunCommands_Get/subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/runCommands/:commandId?api-version=stringGets specific run command for a subscription in a location.
  • GETVirtualMachineRunCommands_GetByVirtualMachine/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/runCommands/:runCommandName?$expand=string&api-version=stringThe operation to get the run command.
  • PUTVirtualMachineRunCommands_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/runCommands/:runCommandName?api-version=stringThe operation to create or update the run command.
  • DELETEVirtualMachineRunCommands_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/runCommands/:runCommandName?api-version=stringThe operation to delete the run command.
  • PATCHVirtualMachineRunCommands_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/runCommands/:runCommandName?api-version=stringThe operation to update the run command.
  • GETVirtualMachineRunCommands_ListByVirtualMachine/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/runCommands?$expand=string&api-version=stringThe operation to get all run commands of a Virtual Machine.

VirtualMachines

  • POSTVirtualMachines_RunCommand/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachines/:vmName/runCommand?api-version=stringRun command on the VM.

VirtualMachineScaleSetVMs

  • POSTVirtualMachineScaleSetVMs_RunCommand/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualmachines/:instanceId/runCommand?api-version=stringRun command on a virtual machine in a VM scale set.

VirtualMachineScaleSetVMRunCommands

  • GETVirtualMachineScaleSetVMRunCommands_Get/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/runCommands/:runCommandName?$expand=string&api-version=stringThe operation to get the VMSS VM run command.
  • PUTVirtualMachineScaleSetVMRunCommands_CreateOrUpdate/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/runCommands/:runCommandName?api-version=stringThe operation to create or update the VMSS VM run command.
  • DELETEVirtualMachineScaleSetVMRunCommands_Delete/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/runCommands/:runCommandName?api-version=stringThe operation to delete the VMSS VM run command.
  • PATCHVirtualMachineScaleSetVMRunCommands_Update/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/runCommands/:runCommandName?api-version=stringThe operation to update the VMSS VM run command.
  • GETVirtualMachineScaleSetVMRunCommands_List/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Compute/virtualMachineScaleSets/:vmScaleSetName/virtualMachines/:instanceId/runCommands?$expand=string&api-version=stringThe operation to get all run commands of an instance in Virtual Machine Scaleset.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
14 operations on 8 pathsGET 6PUT 2POST 2PATCH 2DELETE 2
Main resources
VirtualMachineRunCommands 7VirtualMachineScaleSetVMRunCommands 5VirtualMachineScaleSetVMs 1VirtualMachines 1
Response formats
application/json text/json
Description format
Swagger 2.0, API version 2021-11-01

How to test the Azure Compute: Run Commands 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 Compute: Run Commands 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 “VirtualMachineRunCommands_List” (GET /subscriptions/:subscriptionId/providers/Microsoft.Compute/locations/:location/runCommands?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Compute: Run Commands?

The Run Commands Client. It is listed under Developer tools and has 14 endpoints.

Who publishes the Azure Compute: Run Commands?

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 Compute: Run Commands?

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

How do I authenticate with the Azure Compute: Run Commands?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Compute: Run Commands have?

14 operations on 8 paths (6 GET, 2 PUT, 2 POST, 2 PATCH, 2 DELETE). The largest groups are VirtualMachineRunCommands, VirtualMachineScaleSetVMRunCommands, VirtualMachineScaleSetVMs, VirtualMachines.

Is forking the Azure Compute: Run Commands 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.