你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

MicrosoftSerialConsoleClient class

包:

@azure/arm-serialconsole

Extends

ServiceClient

构造函数

MicrosoftSerialConsoleClient(TokenCredential, string, MicrosoftSerialConsoleClientOptionalParams)

初始化 MicrosoftSerialConsoleClient 类的新实例。

属性

$host
apiVersion
serialPorts
subscriptionId

继承属性

pipeline

此客户端用于发出请求的管道

方法

disableConsole(string, DisableConsoleOptionalParams)	为提供订阅中的所有 VM 和 VM 规模集禁用串行控制台服务
enableConsole(string, EnableConsoleOptionalParams)	为所提供的订阅中的所有 VM 和 VM 规模集启用串行控制台服务
getConsoleStatus(string, GetConsoleStatusOptionalParams)	获取是否为给定订阅禁用串行控制台
listOperations(ListOperationsOptionalParams)	获取串行控制台 API 操作的列表。

继承的方法

sendOperationRequest<T>(OperationArguments, OperationSpec)	发送使用提供的 OperationSpec 填充的 HTTP 请求。
sendRequest(PipelineRequest)	发送提供的 httpRequest。

构造函数详细信息

MicrosoftSerialConsoleClient(TokenCredential, string, MicrosoftSerialConsoleClientOptionalParams)

初始化 MicrosoftSerialConsoleClient 类的新实例。

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

参数

credentials

TokenCredential

唯一标识客户端订阅的订阅凭据。

subscriptionId

string

唯一标识 Microsoft Azure 订阅的订阅 ID。 订阅 ID 构成了每个需要它的服务调用的 URI 的一部分。

options

MicrosoftSerialConsoleClientOptionalParams

参数选项

属性详细信息

$host

$host: string

属性值

string

apiVersion

apiVersion: string

属性值

string

serialPorts

serialPorts: SerialPorts

属性值

SerialPorts

subscriptionId

subscriptionId: string

属性值

string

继承属性详细信息

pipeline

此客户端用于发出请求的管道

pipeline: Pipeline

属性值

Pipeline

继承自 coreClient.ServiceClient.pipeline

方法详细信息

disableConsole(string, DisableConsoleOptionalParams)

为提供订阅中的所有 VM 和 VM 规模集禁用串行控制台服务

function disableConsole(defaultParam: string, options?: DisableConsoleOptionalParams): Promise<DisableSerialConsoleResult>

参数

defaultParam

string

默认参数。 将该值保留为“default”。

options

DisableConsoleOptionalParams

选项参数。

返回

Promise<DisableSerialConsoleResult>

enableConsole(string, EnableConsoleOptionalParams)

为所提供的订阅中的所有 VM 和 VM 规模集启用串行控制台服务

function enableConsole(defaultParam: string, options?: EnableConsoleOptionalParams): Promise<EnableSerialConsoleResult>

参数

defaultParam

string

默认参数。 将该值保留为“default”。

options

EnableConsoleOptionalParams

选项参数。

返回

Promise<EnableSerialConsoleResult>

getConsoleStatus(string, GetConsoleStatusOptionalParams)

获取是否为给定订阅禁用串行控制台

function getConsoleStatus(defaultParam: string, options?: GetConsoleStatusOptionalParams): Promise<SerialConsoleStatus>

参数

defaultParam

string

默认参数。 将该值保留为“default”。

options

GetConsoleStatusOptionalParams

选项参数。

返回

Promise<SerialConsoleStatus>

listOperations(ListOperationsOptionalParams)

获取串行控制台 API 操作的列表。

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

参数

options

ListOperationsOptionalParams

选项参数。

返回

Promise<SerialConsoleOperations>

继承的方法详细信息

sendOperationRequest<T>(OperationArguments, OperationSpec)

发送使用提供的 OperationSpec 填充的 HTTP 请求。

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

参数

operationArguments

OperationArguments

将从中填充 HTTP 请求的模板化值的参数。

operationSpec

OperationSpec

用于填充 httpRequest 的 OperationSpec。

返回

Promise<T>

继承自 coreClient.ServiceClient.sendOperationRequest

sendRequest(PipelineRequest)

发送提供的 httpRequest。

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

参数

request

PipelineRequest

返回

Promise<PipelineResponse>

继承自 coreClient.ServiceClient.sendRequest