MicrosoftSerialConsoleClient class
Constructors
| Microsoft |
|
| Microsoft |
Properties
| pipeline | The pipeline used by this client to make requests |
| serial |
The operation groups for serialPorts |
Methods
| disable |
Disables the Serial Console service for all VMs and VM scale sets in the provided subscription |
| enable |
Enables the Serial Console service for all VMs and VM scale sets in the provided subscription |
| get |
Gets whether or not Serial Console is disabled for a given subscription |
| list |
Gets a list of Serial Console API operations. |
Constructor Details
MicrosoftSerialConsoleClient(TokenCredential, MicrosoftSerialConsoleClientOptionalParams)
new MicrosoftSerialConsoleClient(credential: TokenCredential, options?: MicrosoftSerialConsoleClientOptionalParams)Parameters
- credential
- TokenCredential
MicrosoftSerialConsoleClient(TokenCredential, string, MicrosoftSerialConsoleClientOptionalParams)
new MicrosoftSerialConsoleClient(credential: TokenCredential, subscriptionId: string, options?: MicrosoftSerialConsoleClientOptionalParams)Parameters
- credential
- TokenCredential
- subscriptionId
-
string
Property Details
pipeline
serialPorts
The operation groups for serialPorts
serialPorts: SerialPortsOperationsProperty Value
Method Details
disableConsole(string, DisableConsoleOptionalParams)
Disables the Serial Console service for all VMs and VM scale sets in the provided subscription
function disableConsole(defaultParam: string, options?: DisableConsoleOptionalParams): Promise<DisableSerialConsoleResult>Parameters
- defaultParam
-
string
- options
- DisableConsoleOptionalParams
Returns
Promise<DisableSerialConsoleResult>
enableConsole(string, EnableConsoleOptionalParams)
Enables the Serial Console service for all VMs and VM scale sets in the provided subscription
function enableConsole(defaultParam: string, options?: EnableConsoleOptionalParams): Promise<EnableSerialConsoleResult>Parameters
- defaultParam
-
string
- options
- EnableConsoleOptionalParams
Returns
Promise<EnableSerialConsoleResult>
getConsoleStatus(string, GetConsoleStatusOptionalParams)
Gets whether or not Serial Console is disabled for a given subscription
function getConsoleStatus(defaultParam: string, options?: GetConsoleStatusOptionalParams): Promise<SerialConsoleStatus>Parameters
- defaultParam
-
string
- options
- GetConsoleStatusOptionalParams
Returns
Promise<SerialConsoleStatus>
listOperations(ListOperationsOptionalParams)
Gets a list of Serial Console API operations.
function listOperations(options?: ListOperationsOptionalParams): Promise<SerialConsoleOperations>Parameters
- options
- ListOperationsOptionalParams
Returns
Promise<SerialConsoleOperations>