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 から継承