Azure Serialconsole: Openapi
The Azure Serial Console allows you to access the serial console of a Virtual Machine or VM scale set instance
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 Azure Serial Console allows you to access the serial console of a Virtual Machine or VM scale set instance
Endpoints 9
SerialConsole
- GETListOperations
/providers/Microsoft.SerialConsole/operationsGets a list of Serial Console API operations. - GETGet the disabled status for a subscription
/subscriptions/:subscriptionId/providers/Microsoft.SerialConsole/consoleServices/:defaultGets whether or not Serial Console is disabled for a given subscription - POSTDisable Serial Console for a subscription
/subscriptions/:subscriptionId/providers/Microsoft.SerialConsole/consoleServices/:default/disableConsoleDisables the Serial Console service for all VMs and VM scale sets in the provided subscription - POSTEnable Serial Console for a subscription
/subscriptions/:subscriptionId/providers/Microsoft.SerialConsole/consoleServices/:default/enableConsoleEnables the Serial Console service for all VMs and VM scale sets in the provided subscription
SerialPorts
- GETSerialPorts_ListBySubscriptions
/subscriptions/:subscriptionId/providers/Microsoft.SerialConsole/serialPortsHandles requests to list all SerialPort resources in a subscription. - GETSerialPorts_List
/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/:resourceProviderNamespace/:parentResourceType/:parentResource/providers/Microsoft.SerialConsole/serialPortsLists all of the configured serial ports for a parent resource - GETSerialPorts_Get
/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/:resourceProviderNamespace/:parentResourceType/:parentResource/providers/Microsoft.SerialConsole/serialPorts/:serialPortGets the configured settings for a serial port - PUTSerialPorts_Create
/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/:resourceProviderNamespace/:parentResourceType/:parentResource/providers/Microsoft.SerialConsole/serialPorts/:serialPortCreates or updates a serial port - POSTSerialPorts_Connect
/subscriptions/:subscriptionId/resourcegroups/:resourceGroupName/providers/:resourceProviderNamespace/:parentResourceType/:parentResource/providers/Microsoft.SerialConsole/serialPorts/:serialPort/connectConnect to serial port of the target resource
API details
- Base URL
https://management.azure.com- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 9 operations on 8 pathsGET 5POST 3PUT 1
- Main resources
- SerialPorts 5SerialConsole 4
- Response formats
application/json- Description format
- Swagger 2.0, API version
2024-07-01 - Links
- OpenAPI document
How to test the Azure Serialconsole: Openapi in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Serialconsole: Openapi collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “ListOperations” (GET /providers/Microsoft.SerialConsole/operations), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Serialconsole: Openapi?
The Azure Serial Console allows you to access the serial console of a Virtual Machine or VM scale set instance It is listed under Developer tools and has 9 endpoints.
Who publishes the Azure Serialconsole: Openapi?
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 Serialconsole: Openapi?
Requests go to https://management.azure.com. Endpoint paths are added to this base URL.
How do I authenticate with the Azure Serialconsole: Openapi?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Serialconsole: Openapi have?
9 operations on 8 paths (5 GET, 3 POST, 1 PUT). The largest groups are SerialPorts, SerialConsole.
Is forking the Azure Serialconsole: Openapi free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.