Microsoft Azure

Azure Azurestackhci: Virtual Machine Instances

The Microsoft.AzureStackHCI Rest API spec.

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

The Microsoft.AzureStackHCI Rest API spec.

Endpoints 14

HybridIdentityMetadata

  • GETGets HybridIdentityMetadata./:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/defaultImplements HybridIdentityMetadata GET method.
  • GETImplements GET HybridIdentityMetadata in a vm./:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadataReturns the list of HybridIdentityMetadata of the given vm.

GuestAgents

  • GETGets GuestAgent./:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/defaultImplements GuestAgent GET method.
  • PUTImplements GuestAgent PUT method./:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/defaultCreate Or Update GuestAgent.
  • DELETEDeleted an GuestAgent./:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgents/defaultImplements GuestAgent DELETE method.
  • GETImplements GET GuestAgent in a vm./:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/guestAgentsReturns the list of GuestAgent of the given vm.
  • GETVirtualMachineInstances_Get/:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstances/defaultGets a virtual machine instance
  • PUTVirtualMachineInstances_CreateOrUpdate/:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstances/defaultThe operation to create or update a virtual machine instance. Please note some properties can be set only during virtual machine instance creation.
  • DELETEVirtualMachineInstances_Delete/:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstances/defaultThe operation to delete a virtual machine instance.
  • PATCHVirtualMachineInstances_Update/:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstances/defaultThe operation to update a virtual machine instance.
  • POSTVirtualMachineInstances_Start/:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/startThe operation to start a virtual machine instance.
  • POSTVirtualMachineInstances_Stop/:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/stopThe operation to stop a virtual machine instance.
  • POSTVirtualMachineInstances_Restart/:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/restartThe operation to restart a virtual machine instance.
  • GETVirtualMachineInstances_List/:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstancesLists all of the virtual machine instances within the specified parent resource.

API details

Base URL
https://management.azure.com
Authentication
OAuth 2.0 (implicit flow) with 1 scope
Operations
14 operations on 9 pathsGET 6POST 3PUT 2DELETE 2PATCH 1
Main resources
GuestAgents 4HybridIdentityMetadata 2
Response formats
application/json
Description format
Swagger 2.0, API version 2024-01-01

How to test the Azure Azurestackhci: Virtual Machine Instances 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 Azurestackhci: Virtual Machine Instances 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 “Gets HybridIdentityMetadata.” (GET /:resourceUri/providers/Microsoft.AzureStackHCI/virtualMachineInstances/default/hybridIdentityMetadata/default), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure Azurestackhci: Virtual Machine Instances?

The Microsoft.AzureStackHCI Rest API spec. It is listed under Developer tools and has 14 endpoints.

Who publishes the Azure Azurestackhci: Virtual Machine Instances?

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 Azurestackhci: Virtual Machine Instances?

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

How do I authenticate with the Azure Azurestackhci: Virtual Machine Instances?

With OAuth 2.0 (implicit flow) with 1 scope.

How many endpoints does the Azure Azurestackhci: Virtual Machine Instances have?

14 operations on 9 paths (6 GET, 3 POST, 2 PUT, 2 DELETE, 1 PATCH). The largest groups are GuestAgents, HybridIdentityMetadata.

Is forking the Azure Azurestackhci: Virtual Machine Instances 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.