{resourceProviderNamespace} (stable:2023-01-01)

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

SerialPorts_List (new)
Description :  Lists all of the configured serial ports for a parent resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourceType}/{parentResource}/providers/Microsoft.SerialConsole/serialPorts
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets' ,
Required: True ,
}
string ,
parentResource:
{
Description: The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of serial ports. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the serial port. ,
Required: False ,
}
{
state:
{
Description: Specifies whether the port is enabled for a serial console connection. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
connectionState:
{
Description: Specifies whether the port is currently active. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 ,
]
,
}
,
}
SerialPorts_Get (new)
Description :  Gets the configured settings for a serial port
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourceType}/{parentResource}/providers/Microsoft.SerialConsole/serialPorts/{serialPort}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets' ,
Required: True ,
}
string ,
parentResource:
{
Description: The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine. ,
Required: True ,
}
string ,
serialPort:
{
Description: The name of the serial port to connect to. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the serial port. ,
Required: False ,
}
{
state:
{
Description: Specifies whether the port is enabled for a serial console connection. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
connectionState:
{
Description: Specifies whether the port is currently active. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
]
,
}
,
}
SerialPorts_Create (new)
Description :  Creates or updates a serial port
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourceType}/{parentResource}/providers/Microsoft.SerialConsole/serialPorts/{serialPort}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets' ,
Required: True ,
}
string ,
parentResource:
{
Description: The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine. ,
Required: True ,
}
string ,
serialPort:
{
Description: The name of the serial port to create. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create the serial port. ,
Required: True ,
}
{
properties:
{
Description: The properties of the serial port. ,
Required: False ,
}
{
state:
{
Description: Specifies whether the port is enabled for a serial console connection. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
connectionState:
{
Description: Specifies whether the port is currently active. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the serial port. ,
Required: False ,
}
{
state:
{
Description: Specifies whether the port is enabled for a serial console connection. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
connectionState:
{
Description: Specifies whether the port is currently active. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
]
,
}
,
}
SerialPorts_ListBySubscriptions (new)
Description :  Handles requests to list all SerialPort resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/serialPorts
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of serial ports. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the serial port. ,
Required: False ,
}
{
state:
{
Description: Specifies whether the port is enabled for a serial console connection. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
connectionState:
{
Description: Specifies whether the port is currently active. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 ,
]
,
}
,
}
SerialPorts_Connect (new)
Description :  Connect to serial port of the target resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourceType}/{parentResource}/providers/Microsoft.SerialConsole/serialPorts/{serialPort}/connect
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets' ,
Required: True ,
}
string ,
parentResource:
{
Description: The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine. ,
Required: True ,
}
string ,
serialPort:
{
Description: The name of the serial port to connect to. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
connectionString:
{
Description: Connection string to the serial port of the resource. ,
Required: False ,
}
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 ,
]
,
}
,
}
SerialPorts_List (removed)
Description :  Lists all of the configured serial ports for a parent resource
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourceType}/{parentResource}/providers/Microsoft.SerialConsole/serialPorts
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets' ,
Required: True ,
}
string ,
parentResource:
{
Description: The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of serial ports. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the serial port. ,
Required: False ,
}
{
state:
{
Description: Specifies whether the port is enabled for a serial console connection. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
connectionState:
{
Description: Specifies whether the port is currently active. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 ,
]
,
}
,
}
SerialPorts_Get (removed)
Description :  Gets the configured settings for a serial port
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourceType}/{parentResource}/providers/Microsoft.SerialConsole/serialPorts/{serialPort}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets' ,
Required: True ,
}
string ,
parentResource:
{
Description: The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine. ,
Required: True ,
}
string ,
serialPort:
{
Description: The name of the serial port to connect to. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
properties:
{
Description: The properties of the serial port. ,
Required: False ,
}
{
state:
{
Description: Specifies whether the port is enabled for a serial console connection. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
connectionState:
{
Description: Specifies whether the port is currently active. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
]
,
}
,
}
SerialPorts_Create (removed)
Description :  Creates or updates a serial port
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourceType}/{parentResource}/providers/Microsoft.SerialConsole/serialPorts/{serialPort}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets' ,
Required: True ,
}
string ,
parentResource:
{
Description: The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine. ,
Required: True ,
}
string ,
serialPort:
{
Description: The name of the serial port to create. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to create the serial port. ,
Required: True ,
}
{
properties:
{
Description: The properties of the serial port. ,
Required: False ,
}
{
state:
{
Description: Specifies whether the port is enabled for a serial console connection. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
connectionState:
{
Description: Specifies whether the port is currently active. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
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 ,
}

⚐ Response (201)

{
properties:
{
Description: The properties of the serial port. ,
Required: False ,
}
{
state:
{
Description: Specifies whether the port is enabled for a serial console connection. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
connectionState:
{
Description: Specifies whether the port is currently active. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
]
,
}
,
}
SerialPorts_ListBySubscriptions (removed)
Description :  Handles requests to list all SerialPort resources in a subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/serialPorts
{
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 ,
}

⚐ Response (200)

{
value:
{
Description: The list of serial ports. ,
Required: False ,
}
[
{
properties:
{
Description: The properties of the serial port. ,
Required: False ,
}
{
state:
{
Description: Specifies whether the port is enabled for a serial console connection. ,
Enum:
{
enabled: No description available. ,
disabled: No description available. ,
}
,
Required: False ,
}
enum ,
connectionState:
{
Description: Specifies whether the port is currently active. ,
Enum:
{
active: No description available. ,
inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
}

⚐ 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 ,
]
,
}
,
}
SerialPorts_Connect (removed)
Description :  Connect to serial port of the target resource
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourceType}/{parentResource}/providers/Microsoft.SerialConsole/serialPorts/{serialPort}/connect
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
resourceProviderNamespace:
{
Description: The namespace of the resource provider. ,
Required: True ,
}
string ,
parentResourceType:
{
Description: The resource type of the parent resource. For example: 'virtualMachines' or 'virtualMachineScaleSets' ,
Required: True ,
}
string ,
parentResource:
{
Description: The resource name, or subordinate path, for the parent of the serial port. For example: the name of the virtual machine. ,
Required: True ,
}
string ,
serialPort:
{
Description: The name of the serial port to connect to. ,
Required: True ,
}
string ,
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 ,
}

⚐ Response (200)

{
connectionString:
{
Description: Connection string to the serial port of the resource. ,
Required: False ,
}
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 ,
]
,
}
,
}