次の方法で共有


Virtual Machines - List By Lab

ラボのすべての仮想マシンを取得します。
ラボのすべての仮想マシンの一覧を返します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?api-version=2023-06-07
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.LabServices/labs/{labName}/virtualMachines?api-version=2023-06-07&$filter={$filter}

URI パラメーター

名前 / 必須 説明
labName
path True

string

含まれるラボ 計画内で一意に識別するラボの名前。 リソース URI で使用されます。

resourceGroupName
path True

string

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

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

api-version
query True

string

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

$filter
query

string

操作に適用するフィルター。

応答

名前 説明
200 OK

PagedVirtualMachines

要求は成功しました。応答には、特定のラボのすべての仮想マシンが含まれます。

Other Status Codes

ErrorResponse

既定のエラー応答。

listVirtualMachine

要求のサンプル

GET https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/virtualMachines?api-version=2023-06-07

応答のサンプル

{
  "nextLink": null,
  "value": [
    {
      "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.LabServices/labs/testlab/virtualMachines/template",
      "name": "default",
      "type": "Microsoft.LabServices/VirtualMachine",
      "systemData": {
        "createdBy": "identity123",
        "createdByType": "User",
        "createdAt": "2020-05-01T10:00:00Z",
        "lastModifiedBy": "identity123",
        "lastModifiedByType": "User",
        "lastModifiedAt": "2020-06-01T09:12:28Z"
      },
      "properties": {
        "provisioningState": "Succeeded",
        "state": "Running",
        "connectionProfile": {
          "privateIpAddress": "192.168.2.1",
          "sshAuthority": "vm-42.contoso.com:22",
          "sshInBrowserUrl": "vm-42.contoso.com",
          "rdpAuthority": "vm-42.contoso.com:3389",
          "rdpInBrowserUrl": "vm-42.contoso.com",
          "adminUsername": "user123"
        },
        "claimedByUserId": "testuser567",
        "vmType": "Template"
      }
    }
  ]
}

定義

名前 説明
createdByType

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

ErrorAdditionalInfo

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

ErrorDetail

エラーの詳細。

ErrorResponse

エラー応答

PagedVirtualMachines

ラボ サービス仮想マシンのページ一覧。

ProvisioningState

仮想マシンの現在のプロビジョニング状態。

ResourceOperationError

このリソースでの最新の操作エラーのエラーの詳細

systemData

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

VirtualMachine

ラボ仮想マシン リソース。

VirtualMachineConnectionProfile

仮想マシンの接続情報

VirtualMachineState

仮想マシンの状態。

VirtualMachineType

ラボ仮想マシンの種類。

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 オブジェクト。

PagedVirtualMachines

ラボ サービス仮想マシンのページ一覧。

名前 説明
nextLink

string

仮想マシンの結果の次のページを取得するためのリンク。

value

VirtualMachine[]

仮想マシンの結果の配列ページ。

ProvisioningState

仮想マシンの現在のプロビジョニング状態。

名前 説明
Creating

string

リソースは作成中です。

Deleting

string

リソースは削除中です。

Failed

string

リソースに対する以前の操作で、リソースが異常な状態のままで失敗しました。

Locked

string

リソースはロックされており、変更は現在ブロックされています。 これは、メンテナンスまたはスケジュールされた操作が原因である可能性があります。 ロック操作が完了すると、状態は成功に戻ります。

Succeeded

string

リソースは、作成または更新操作後に正常な状態です。

Updating

string

新しいプロパティ値がリソースに適用されています。

ResourceOperationError

このリソースでの最新の操作エラーのエラーの詳細

名前 説明
action

string

失敗した操作アクション

code

string

操作エラーの種類に対応するコード

message

string

操作エラー メッセージ

timestamp

string

エラーが発生した日時

systemData

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

名前 説明
createdAt

string

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

createdBy

string

リソースを作成した ID。

createdByType

createdByType

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

lastModifiedAt

string

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

lastModifiedBy

string

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

lastModifiedByType

createdByType

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

VirtualMachine

ラボ仮想マシン リソース。

名前 説明
id

string

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

name

string

リソースの名前

properties.claimedByUserId

string

仮想マシンを要求したユーザーのラボ ユーザー ID (PUID ではありません)。

properties.connectionProfile

VirtualMachineConnectionProfile

仮想マシンへの接続に関する情報のプロファイル。

properties.provisioningState

ProvisioningState

仮想マシンの現在のプロビジョニング状態。

properties.resourceOperationError

ResourceOperationError

ラボ計画で最後に実行された操作のエラーの詳細。

properties.state

VirtualMachineState

仮想マシンの現在の状態

properties.vmType

VirtualMachineType

この VM リソースの種類

systemData

systemData

ラボ仮想マシンのシステム データ。

type

string

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

VirtualMachineConnectionProfile

仮想マシンの接続情報

名前 説明
adminUsername

string

管理者として仮想マシンにログオンするために使用されるユーザー名。

nonAdminUsername

string

管理者以外として仮想マシンにログオンするために使用されるユーザー名 (存在する場合)。

privateIpAddress

string

仮想マシンのプライベート IP アドレス。

rdpAuthority

string

RDP プロトコルを介して仮想マシンに接続するために、ポートとホスト名をセミコロンで区切って指定します。

rdpInBrowserUrl

string

ブラウザーで RDP プロトコルを使用して仮想マシンに接続するための URL。

sshAuthority

string

SSH プロトコルを介して仮想マシンに接続するためにセミコロンで区切られたポートとホスト名。

sshInBrowserUrl

string

ブラウザーで SSH プロトコルを使用して仮想マシンに接続するための URL。

VirtualMachineState

仮想マシンの状態。

名前 説明
Redeploying

string

VM が再デプロイされています。

Reimaging

string

VM が再イメージ化されています。

ResettingPassword

string

VM パスワードがリセットされています。

Running

string

VM が実行されています。

Starting

string

VM が起動しています。

Stopped

string

VM は現在停止しています。

Stopping

string

VM が停止しています。

VirtualMachineType

ラボ仮想マシンの種類。

名前 説明
Template

string

テンプレート VM

User

string

ユーザー VM