Microsoft.SerialConsole (stable:2024-07-01)

2025/09/19 • 4 new, 4 deleted methods

ListOperations (new)
Description :  Gets a list of Serial Console API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.SerialConsole/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚐ Response (200)

{
value:
{
Description: A list of Serial Console operations ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
isDataAction:
{
Required: False ,
}
string ,
display:
{
Required: False ,
}
{
provider:
{
Required: False ,
}
string ,
resource:
{
Required: False ,
}
string ,
operation:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
GetConsoleStatus (new)
Description :  Gets whether or not Serial Console is disabled for a given subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID which uniquely identifies the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call requiring it. ,
Required: True ,
}
string ,
default:
{
Description: Default parameter. Leave the value as "default". ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
disabled:
{
Description: Whether or not Serial Console is disabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (404)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Subscription not found message ,
Required: False ,
}
string ,
}
DisableConsole (new)
Description :  Disables the Serial Console service for all VMs and VM scale sets in the provided subscription
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/disableConsole
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID which uniquely identifies the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call requiring it. ,
Required: True ,
}
string ,
default:
{
Description: Default parameter. Leave the value as "default". ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
disabled:
{
Description: Whether or not Serial Console is disabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (404)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Subscription not found message ,
Required: False ,
}
string ,
}
EnableConsole (new)
Description :  Enables the Serial Console service for all VMs and VM scale sets in the provided subscription
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/enableConsole
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID which uniquely identifies the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call requiring it. ,
Required: True ,
}
string ,
default:
{
Description: Default parameter. Leave the value as "default". ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
disabled:
{
Description: Whether or not Serial Console is disabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (404)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Subscription not found message ,
Required: False ,
}
string ,
}
ListOperations (removed)
Description :  Gets a list of Serial Console API operations.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.SerialConsole/operations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚐ Response (200)

{
value:
{
Description: A list of Serial Console operations ,
Required: False ,
}
[
{
name:
{
Required: False ,
}
string ,
isDataAction:
{
Required: False ,
}
string ,
display:
{
Required: False ,
}
{
provider:
{
Required: False ,
}
string ,
resource:
{
Required: False ,
}
string ,
operation:
{
Required: False ,
}
string ,
description:
{
Required: False ,
}
string ,
}
,
}
,
]
,
}
GetConsoleStatus (removed)
Description :  Gets whether or not Serial Console is disabled for a given subscription
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID which uniquely identifies the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call requiring it. ,
Required: True ,
}
string ,
default:
{
Description: Default parameter. Leave the value as "default". ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
disabled:
{
Description: Whether or not Serial Console is disabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (404)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Subscription not found message ,
Required: False ,
}
string ,
}
DisableConsole (removed)
Description :  Disables the Serial Console service for all VMs and VM scale sets in the provided subscription
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/disableConsole
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID which uniquely identifies the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call requiring it. ,
Required: True ,
}
string ,
default:
{
Description: Default parameter. Leave the value as "default". ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
disabled:
{
Description: Whether or not Serial Console is disabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (404)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Subscription not found message ,
Required: False ,
}
string ,
}
EnableConsole (removed)
Description :  Enables the Serial Console service for all VMs and VM scale sets in the provided subscription
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/enableConsole
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription ID which uniquely identifies the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call requiring it. ,
Required: True ,
}
string ,
default:
{
Description: Default parameter. Leave the value as "default". ,
Required: True ,
}
string ,
}

⚐ Response (default)

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

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
disabled:
{
Description: Whether or not Serial Console is disabled. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (404)

{
code:
{
Description: Error code ,
Required: False ,
}
string ,
message:
{
Description: Subscription not found message ,
Required: False ,
}
string ,
}