Enable Console - Enable Console

サービス:

Serial Console

API バージョン:

2024-07-01

サブスクリプションのシリアル コンソールを有効にする
指定されたサブスクリプション内のすべての VM と VM スケール セットに対してシリアル コンソール サービスを有効にします

POST https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.SerialConsole/consoleServices/{default}/enableConsole?api-version=2024-07-01

URI パラメーター

名前	/	必須	型	説明
default	path	True	string	既定のパラメーター。 値は "default" のままにします。
subscriptionId	path	True	string	Microsoft Azure サブスクリプションを一意に識別するサブスクリプション ID。 サブスクリプション ID は、それを必要とするすべてのサービス呼び出しの URI の一部を形成します。
api-version	query	True	string	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	EnableSerialConsoleResult	OK - シリアル コンソールが無効
404 Not Found	GetSerialConsoleSubscriptionNotFound	サブスクリプションが見つかりません - エラーの詳細を含む JSON オブジェクトを返します
Other Status Codes	CloudError	既定の応答

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザー アカウントを偽装する

例

Enable Serial Console for a subscription

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/00000000-00000-0000-0000-000000000000/providers/Microsoft.SerialConsole/consoleServices/default/enableConsole?api-version=2024-07-01

応答のサンプル

状態コード:

200

{
  "properties": {
    "disabled": false
  }
}

状態コード:

404

{
  "code": "SubscriptionNotFound",
  "message": "The subscription '00000000-00000-0000-0000-000000000000' could not be found."
}

定義

名前	説明
CloudError	サービスからのエラー応答。
CloudErrorBody	Batch サービスからのエラー応答。
EnableSerialConsoleResult	シリアル コンソールの有効化の結果
GetSerialConsoleSubscriptionNotFound	シリアル コンソール サブスクリプションが見つかりません
Properties

CloudError

Object

サービスからのエラー応答。

名前	型	説明
error	CloudErrorBody	クラウド エラー本文。

CloudErrorBody

Object

Batch サービスからのエラー応答。

名前	型	説明
code	string	エラーの識別子。 コードは不変であり、プログラムで使用することを目的としています。
details	CloudErrorBody[]	エラーに関する追加の詳細の一覧。
message	string	ユーザー インターフェイスでの表示に適したエラーを説明するメッセージ。
target	string	特定のエラーのターゲット。 たとえば、エラーが発生したプロパティの名前です。

EnableSerialConsoleResult

Object

シリアル コンソールの有効化の結果

名前	型	説明
properties	Properties

GetSerialConsoleSubscriptionNotFound

Object

シリアル コンソール サブスクリプションが見つかりません

名前	型	説明
code	string	エラー コード
message	string	サブスクリプションが見つかりませんというメッセージ

Properties

Object

名前	型	説明
disabled	boolean	シリアル コンソールが無効かどうか。