MicrosoftSerialConsoleClient class

Package:

@azure/arm-serialconsole

Extends

ServiceClient

Constructors

MicrosoftSerialConsoleClient(TokenCredential, string, MicrosoftSerialConsoleClientOptionalParams)

Initializes a new instance of the MicrosoftSerialConsoleClient class.

Properties

$host
apiVersion
serialPorts
subscriptionId

Inherited Properties

pipeline

The pipeline used by this client to make requests

Methods

disableConsole(string, DisableConsoleOptionalParams)	Disables the Serial Console service for all VMs and VM scale sets in the provided subscription
enableConsole(string, EnableConsoleOptionalParams)	Enables the Serial Console service for all VMs and VM scale sets in the provided subscription
getConsoleStatus(string, GetConsoleStatusOptionalParams)	Gets whether or not Serial Console is disabled for a given subscription
listOperations(ListOperationsOptionalParams)	Gets a list of Serial Console API operations.

Inherited Methods

sendOperationRequest<T>(OperationArguments, OperationSpec)	Send an HTTP request that is populated using the provided OperationSpec.
sendRequest(PipelineRequest)	Send the provided httpRequest.

Constructor Details

MicrosoftSerialConsoleClient(TokenCredential, string, MicrosoftSerialConsoleClientOptionalParams)

Initializes a new instance of the MicrosoftSerialConsoleClient class.

new MicrosoftSerialConsoleClient(credentials: TokenCredential, subscriptionId: string, options?: MicrosoftSerialConsoleClientOptionalParams)

Parameters

credentials

TokenCredential

Subscription credentials which uniquely identify client subscription.

subscriptionId

string

Subscription ID which uniquely identifies the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call requiring it.

options

MicrosoftSerialConsoleClientOptionalParams

The parameter options

Property Details

$host

$host: string

Property Value

string

apiVersion

apiVersion: string

Property Value

string

serialPorts

serialPorts: SerialPorts

Property Value

SerialPorts

subscriptionId

subscriptionId: string

Property Value

string

Inherited Property Details

pipeline

The pipeline used by this client to make requests

pipeline: Pipeline

Property Value

Pipeline

Inherited From coreClient.ServiceClient.pipeline

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

Default parameter. Leave the value as "default".

options

DisableConsoleOptionalParams

The options parameters.

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

Default parameter. Leave the value as "default".

options

EnableConsoleOptionalParams

The options parameters.

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

Default parameter. Leave the value as "default".

options

GetConsoleStatusOptionalParams

The options parameters.

Returns

Promise<SerialConsoleStatus>

listOperations(ListOperationsOptionalParams)

Gets a list of Serial Console API operations.

function listOperations(options?: ListOperationsOptionalParams): Promise<SerialConsoleOperations>

Parameters

options

ListOperationsOptionalParams

The options parameters.

Returns

Promise<SerialConsoleOperations>

Inherited Method Details

sendOperationRequest<T>(OperationArguments, OperationSpec)

Send an HTTP request that is populated using the provided OperationSpec.

function sendOperationRequest<T>(operationArguments: OperationArguments, operationSpec: OperationSpec): Promise<T>

Parameters

operationArguments

OperationArguments

The arguments that the HTTP request's templated values will be populated from.

operationSpec

OperationSpec

The OperationSpec to use to populate the httpRequest.

Returns

Promise<T>

Inherited From coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

Send the provided httpRequest.

function sendRequest(request: PipelineRequest): Promise<PipelineResponse>

Parameters

request

PipelineRequest

Returns

Promise<PipelineResponse>

Inherited From coreClient.ServiceClient.sendRequest