次の方法で共有


Consoles - Get

仮想マシン コンソールを取得します。
指定された仮想マシン コンソールのプロパティを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.NetworkCloud/virtualMachines/{virtualMachineName}/consoles/{consoleName}?api-version=2023-07-01

URI パラメーター

名前 / 必須 説明
consoleName
path True

string

仮想マシン コンソールの名前。

正規表現パターン: ^default$

resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

subscriptionId
path True

string

uuid

ターゲット サブスクリプションの ID。 値は UUID である必要があります。

virtualMachineName
path True

string

仮想マシンの名前。

正規表現パターン: ^([a-zA-Z0-9][a-zA-Z0-9]{0,62}[a-zA-Z0-9])$

api-version
query True

string

この操作に使用する API バージョン。

応答

名前 説明
200 OK

Console

OK

Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

名前 説明
user_impersonation ユーザー アカウントの借用

Get virtual machine console

要求のサンプル

GET https://management.azure.com/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default?api-version=2023-07-01

応答のサンプル

{
  "id": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.NetworkCloud/virtualMachines/virtualMachineName/consoles/default",
  "name": "default",
  "systemData": {
    "createdAt": "2021-01-22T13:27:03.008Z",
    "createdBy": "identityA",
    "createdByType": "Application",
    "lastModifiedAt": "2021-01-22T13:29:03.001Z",
    "lastModifiedBy": "identityB",
    "lastModifiedByType": "User"
  },
  "type": "Microsoft.NetworkCloud/virtualMachines/consoles",
  "location": "location",
  "tags": {
    "key1": "myvalue1",
    "key2": "myvalue2"
  },
  "extendedLocation": {
    "type": "CustomLocation",
    "name": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.ExtendedLocation/customLocations/clusterManagerExtendedLocationName"
  },
  "properties": {
    "sshPublicKey": {
      "keyData": "ssh-rsa AAtsE3njSONzDYRIZv/WLjVuMfrUSByHp+jfaaOLHTIIB4fJvo6dQUZxE20w2iDHV3tEkmnTo84eba97VMueQD6OzJPEyWZMRpz8UYWOd0IXeRqiFu1lawNblZhwNT/ojNZfpB3af/YDzwQCZgTcTRyNNhL4o/blKUmug0daSsSXISTRnIDpcf5qytjs1Xo+yYyJMvzLL59mhAyb3p/cD+Y3/s3WhAx+l0XOKpzXnblrv9d3q4c2tWmm/SyFqthaqd0= admin@vm"
    },
    "enabled": "True",
    "expiration": "2022-06-01T01:27:03.008Z",
    "provisioningState": "Succeeded",
    "privateLinkServiceId": "/subscriptions/123e4567-e89b-12d3-a456-426655440000/resourceGroups/resourceGroupName/providers/Microsoft.Network/privateLinkServices/console-pls",
    "virtualMachineAccessId": "VirtualMachineAccessId",
    "detailedStatus": "Ready",
    "detailedStatusMessage": "Console is ready for use"
  }
}

定義

名前 説明
Console

コンソールは、オンプレミスのネットワーク クラウド仮想マシンのコンソールを表します。

ConsoleDetailedStatus

コンソールのより詳細な状態。

ConsoleEnabled

コンソール アクセスが有効になっているかどうかを示すインジケーター。

ConsoleProvisioningState

仮想マシン コンソールのプロビジョニング状態。

createdByType

リソースを作成した ID の種類。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

ExtendedLocation

ExtendedLocation は、リソースが作成される Azure カスタムの場所を表します。

SshPublicKey

SshPublicKey は、SSH 経由でリソースで認証するために使用される公開キーを表します。

systemData

リソースの作成と最後の変更に関連するメタデータ。

Console

コンソールは、オンプレミスのネットワーク クラウド仮想マシンのコンソールを表します。

名前 説明
extendedLocation

ExtendedLocation

ExtendedLocation は、リソースが作成される Azure カスタムの場所を表します。
この仮想マシンが作成されるクラスターに関連付けられているクラスター マネージャーの拡張場所。

id

string

リソースの完全修飾リソース ID。 例: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"

location

string

リソースが保存されている地理的な場所

name

string

リソースの名前

properties.detailedStatus

ConsoleDetailedStatus

コンソールのより詳細な状態。

properties.detailedStatusMessage

string

現在の詳細な状態に関する説明メッセージ。

properties.enabled

ConsoleEnabled

コンソール アクセスが有効になっているかどうかを示すインジケーター。

properties.expiration

string

キーがアクセスを許可しない日付と時刻。

properties.privateLinkServiceId

string

仮想マシン コンソールへのアクセスを提供するために使用されるプライベート リンク サービスのリソース ID。

properties.provisioningState

ConsoleProvisioningState

仮想マシン コンソールのプロビジョニング状態。

properties.sshPublicKey

SshPublicKey

SshPublicKey は、SSH 経由でリソースで認証するために使用される公開キーを表します。
ユーザー アクセス用にプロビジョニングされる SSH 公開キー。 ユーザーには、ログイン用の対応する SSH 秘密キーが必要です。

properties.virtualMachineAccessId

string

コンソールへのアクセスに使用される仮想マシンの一意識別子。

systemData

systemData

createdBy および modifiedBy 情報を含む Azure Resource Manager メタデータ。

tags

object

リソース タグ。

type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ConsoleDetailedStatus

コンソールのより詳細な状態。

名前 説明
Error

string

Ready

string

ConsoleEnabled

コンソール アクセスが有効になっているかどうかを示すインジケーター。

名前 説明
False

string

True

string

ConsoleProvisioningState

仮想マシン コンソールのプロビジョニング状態。

名前 説明
Accepted

string

Canceled

string

Failed

string

Provisioning

string

Succeeded

string

createdByType

リソースを作成した ID の種類。

名前 説明
Application

string

Key

string

ManagedIdentity

string

User

string

ErrorAdditionalInfo

リソース管理エラーの追加情報。

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorDetail

エラーの詳細。

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorDetail[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

ErrorResponse

エラー応答

名前 説明
error

ErrorDetail

error オブジェクト。

ExtendedLocation

ExtendedLocation は、リソースが作成される Azure カスタムの場所を表します。

名前 説明
name

string

リソースが作成される拡張場所のリソース ID。

type

string

拡張場所の種類 (CustomLocation など)。

SshPublicKey

SshPublicKey は、SSH 経由でリソースで認証するために使用される公開キーを表します。

名前 説明
keyData

string

SSH 公開キー データ。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 説明
createdAt

string

リソース作成のタイムスタンプ (UTC)。

createdBy

string

リソースを作成した ID。

createdByType

createdByType

リソースを作成した ID の種類。

lastModifiedAt

string

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。