openapi-directory/api/azure.com/serialconsole.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"The Azure Serial Console allows you to access the serial console of a Virtual Machine or VM scale set instance","title":"MicrosoftSerialConsoleClient","version":"2018-05-01","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/serialconsole/resource-manager/Microsoft.SerialConsole/stable/2018-05-01/serialconsole.json","version":"2.0"}],"x-providerName":"azure.com","x-serviceName":"serialconsole","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/providers/Microsoft.SerialConsole/operations":{"get":{"description":"Gets a list of Serial Console API operations.","operationId":"ListOperations","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"}],"responses":{"200":{"description":"OK - returns a JSON object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerialConsoleOperations"},"examples":{"List all Serial Console management operations supported by Serial Console RP":{"$ref":"#/components/examples/List_all_Serial_Console_management_operations_supported_by_Serial_Console_RP"}}}}}},"tags":["SerialConsole"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}":{"get":{"description":"Gets whether or not Serial Console is disabled for a given subscription","operationId":"GetConsoleStatus","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/defaultParameter"}],"responses":{"200":{"description":"OK - Returns a JSON object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SerialConsoleStatus"},"examples":{"Get the Serial Console disabled status for a subscription":{"$ref":"#/components/examples/Get_the_Serial_Console_disabled_status_for_a_subscription"}}}}},"404":{"description":"Subscription not found - returns a JSON object with error details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSerialConsoleSubscriptionNotFound"},"examples":{"Get the Serial Console disabled status for a subscription":{"$ref":"#/components/examples/Get_the_Serial_Console_disabled_status_for_a_subscription"}}}}}},"summary":"Get the disabled status for a subscription","tags":["SerialConsole"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/disableConsole":{"post":{"description":"Disables the Serial Console service for all VMs and VM scale sets in the provided subscription","operationId":"DisableConsole","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/defaultParameter"}],"responses":{"200":{"description":"OK - Returns a JSON object","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisableSerialConsoleResult"},"examples":{"Disable Serial Console for a subscription":{"$ref":"#/components/examples/Disable_Serial_Console_for_a_subscription"}}}}},"404":{"description":"Subscription not found - returns a JSON object with error details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSerialConsoleSubscriptionNotFound"},"examples":{"Disable Serial Console for a subscription":{"$ref":"#/components/examples/Disable_Serial_Console_for_a_subscription"}}}}}},"summary":"Disable Serial Console for a subscription","tags":["SerialConsole"]}},"/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/enableConsole":{"post":{"description":"Enables the Serial Console service for all VMs and VM scale sets in the provided subscription","operationId":"EnableConsole","parameters":[{"$ref":"#/components/parameters/ApiVersionParameter"},{"$ref":"#/components/parameters/SubscriptionIdParameter"},{"$ref":"#/components/parameters/defaultParameter"}],"responses":{"200":{"description":"OK - Serial Console disabled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnableSerialConsoleResult"},"examples":{"Enable Serial Console for a subscription":{"$ref":"#/components/examples/Enable_Serial_Console_for_a_subscription"}}}}},"404":{"description":"Subscription not found - returns a JSON object with error details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetSerialConsoleSubscriptionNotFound"},"examples":{"Enable Serial Console for a subscription":{"$ref":"#/components/examples/Enable_Serial_Console_for_a_subscription"}}}}}},"summary":"Enable Serial Console for a subscription","tags":["SerialConsole"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"examples":{"List_all_Serial_Console_management_operations_supported_by_Serial_Console_RP":{"value":{"value":[{"display":{"description":"Retrieves the current subscription state","operation":"Default","provider":"Microsoft.SerialConsole","resource":"Serial Console instance"},"isDataAction":"false","name":"Microsoft.SerialConsole/consoleServices/read"},{"display":{"description":"Disable Serial Console for a subscription","operation":"Disable Console","provider":"Microsoft.SerialConsole","resource":"Serial Console instance"},"isDataAction":"false","name":"Microsoft.SerialConsole/consoleServices/disableConsole/action"},{"display":{"description":"Enable Serial Console for a subscription","operation":"Enable Console","provider":"Microsoft.SerialConsole","resource":"Serial Console instance"},"isDataAction":"false","name":"Microsoft.SerialConsole/consoleServices/enableConsole/action"}]}},"Get_the_Serial_Console_disabled_status_for_a_subscription":{"value":{"code":"SubscriptionNotFound","message":"The subscription '00000000-00000-0000-0000-000000000000' could not be found."}},"Disable_Serial_Console_for_a_subscription":{"value":{"code":"SubscriptionNotFound","message":"The subscription '00000000-00000-0000-0000-000000000000' could not be found."}},"Enable_Serial_Console_for_a_subscription":{"value":{"code":"SubscriptionNotFound","message":"The subscription '00000000-00000-0000-0000-000000000000' could not be found."}}},"parameters":{"ApiVersionParameter":{"description":"The API version to use for this operation.","in":"query","name":"api-version","required":true,"schema":{"type":"string"},"examples":{"List all Serial Console management operations supported by Serial Console RP":{"value":"2018-05-01"},"Get the Serial Console disabled status for a subscription":{"value":"2018-05-01"},"Disable Serial Console for a subscription":{"value":"2018-05-01"},"Enable Serial Console for a subscription":{"value":"2018-05-01"}}},"SubscriptionIdParameter":{"description":"Subscription ID which uniquely identifies the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call requiring it.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"},"examples":{"Get the Serial Console disabled status for a subscription":{"value":"00000000-00000-0000-0000-000000000000"},"Disable Serial Console for a subscription":{"value":"00000000-00000-0000-0000-000000000000"},"Enable Serial Console for a subscription":{"value":"00000000-00000-0000-0000-000000000000"}}},"defaultParameter":{"description":"Default parameter. Leave the value as \"default\".","in":"path","name":"default","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"},"examples":{"Get the Serial Console disabled status for a subscription":{"value":"default"},"Disable Serial Console for a subscription":{"value":"default"},"Enable Serial Console for a subscription":{"value":"default"}}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"DisableSerialConsoleResult":{"description":"Returns whether or not Serial Console is disabled.","properties":{"disabled":{"description":"Whether or not Serial Console is disabled.","type":"boolean"}},"title":"Serial Console Disable Result","type":"object"},"EnableSerialConsoleResult":{"description":"Returns whether or not Serial Console is disabled (enabled).","properties":{"disabled":{"description":"Whether or not Serial Console is disabled (enabled).","type":"boolean"}},"title":"Serial Console Enable Result","type":"object"},"GetSerialConsoleSubscriptionNotFound":{"description":"Error saying that the provided subscription could not be found","properties":{"code":{"description":"Error code","type":"string"},"message":{"description":"Subscription not found message","type":"string"}},"title":"Serial Console subscription not found","type":"object"},"SerialConsoleOperations":{"description":"Serial Console operations","properties":{"value":{"description":"A list of Serial Console operations","items":{"properties":{"display":{"properties":{"description":{"type":"string"},"operation":{"type":"string"},"provider":{"type":"string"},"resource":{"type":"string"}},"type":"object"},"isDataAction":{"type":"string"},"name":{"type":"string"}},"type":"object"},"type":"array"}},"title":"Serial Console operations","type":"object"},"SerialConsoleStatus":{"description":"Returns whether or not Serial Console is disabled.","properties":{"disabled":{"description":"Whether or not Serial Console is disabled.","type":"boolean"}},"title":"Serial Console GET Result","type":"object"}}}}