Enable Console - Enable Console

Service:

Serial Console

API Version:

2024-07-01

Enable Serial Console for a subscription
Enables the Serial Console service for all VMs and VM scale sets in the provided subscription

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/enableConsole?api-version=2024-07-01

URI Parameters

Name	In	Required	Type	Description
default	path	True	string	Default parameter. Leave the value as "default".
subscriptionId	path	True	string	Subscription ID which uniquely identifies the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call requiring it.
api-version	query	True	string	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	EnableSerialConsoleResult	OK - Serial Console disabled
404 Not Found	GetSerialConsoleSubscriptionNotFound	Subscription not found - returns a JSON object with error details
Other Status Codes	CloudError	Default response

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Enable Serial Console for a subscription

Sample request

HTTP

POST https://management.azure.com/subscriptions/00000000-00000-0000-0000-000000000000/providers/Microsoft.SerialConsole/consoleServices/default/enableConsole?api-version=2024-07-01

Sample response

Status code:

200

{
  "properties": {
    "disabled": false
  }
}

Status code:

404

{
  "code": "SubscriptionNotFound",
  "message": "The subscription '00000000-00000-0000-0000-000000000000' could not be found."
}

Definitions

Name	Description
CloudError	An error response from the service.
CloudErrorBody	An error response from the Batch service.
EnableSerialConsoleResult	Serial Console Enable Result
GetSerialConsoleSubscriptionNotFound	Serial Console subscription not found
Properties

CloudError

Object

An error response from the service.

Name	Type	Description
error	CloudErrorBody	Cloud error body.

CloudErrorBody

Object

An error response from the Batch service.

Name	Type	Description
code	string	An identifier for the error. Codes are invariant and are intended to be consumed programmatically.
details	CloudErrorBody[]	A list of additional details about the error.
message	string	A message describing the error, intended to be suitable for display in a user interface.
target	string	The target of the particular error. For example, the name of the property in error.

EnableSerialConsoleResult

Object

Serial Console Enable Result

Name	Type	Description
properties	Properties

GetSerialConsoleSubscriptionNotFound

Object

Serial Console subscription not found

Name	Type	Description
code	string	Error code
message	string	Subscription not found message

Properties

Object

Name	Type	Description
disabled	boolean	Whether or not Serial Console is disabled.