Dev Boxes - List All Dev Boxes

リファレンス

サービス:: Dev Center

API バージョン:: 2024-02-01

呼び出し元が DevCenter でアクセスできる開発ボックスを一覧表示します。

GET {endpoint}/devboxes?api-version=2024-02-01

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	操作する DevCenter 固有の URI。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	PagedDevBox	要求は成功しました。
Other Status Codes	Azure.Core.Foundations.ErrorResponse	予期しないエラー応答。ヘッダー x-ms-error-code: string

名前

型

説明

200 OK

PagedDevBox

要求は成功しました。

Other Status Codes

Azure.Core.Foundations.ErrorResponse

予期しないエラー応答。

ヘッダー

x-ms-error-code: string

セキュリティ

OAuth2Auth

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

スコープ

名前	説明
https://devcenter.azure.com/.default

例

Lists Dev Boxes that the caller has access to in the DevCenter.

要求のサンプル

HTTP

GET https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/devboxes?api-version=2024-02-01

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "uri": "https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/b08e39b4-2ac6-4465-a35e-48322efb0f98/devboxes/MyDevBox",
      "name": "MyDevBox",
      "provisioningState": "Succeeded",
      "projectName": "ContosoProject",
      "poolName": "LargeDevWorkStationPool",
      "location": "centralus",
      "osType": "Windows",
      "user": "b08e39b4-2ac6-4465-a35e-48322efb0f98",
      "hardwareProfile": {
        "vCPUs": 8,
        "memoryGB": 32
      },
      "storageProfile": {
        "osDisk": {
          "diskSizeGB": 1024
        }
      },
      "hibernateSupport": "Enabled",
      "imageReference": {
        "name": "DevImage",
        "version": "1.0.0",
        "publishedDate": "2022-03-01T00:13:23.323Z"
      }
    }
  ]
}

定義

名前	説明
Azure.Core.Foundations.Error	エラーオブジェクト。
Azure.Core.Foundations.ErrorResponse	エラーの詳細を含む応答。
Azure.Core.Foundations.InnerError	エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
DevBox	開発ボックス。
DevBoxProvisioningState	Dev Box のプロビジョニング状態を示します。
HardwareProfile	Dev Box のハードウェア仕様。
HibernateSupport	オペレーティングシステムで休止状態がサポートされ、有効か無効か、サポートされていないかを示します。不明な休止状態のサポートは null として表されます。
ImageReference	使用するイメージに関する情報を指定します。
LocalAdminStatus	プール内の Dev Boxes の所有者が Dev Boxes のローカル管理者であるかどうかを示します。
OsDisk	オペレーティングシステムディスクの設定。
OsType	オペレーティングシステムの種類。
PagedDevBox	DevBox 項目のページコレクション
PowerState	Dev Box の電源状態。
SkuName	Dev Box コンピューティングを示します。
StorageProfile	Dev Box のディスクのストレージ設定。

Azure.Core.Foundations.Error

Object

エラーオブジェクト。

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
details	Azure.Core.Foundations.Error[]	この報告されたエラーの原因となった特定のエラーに関する詳細の配列。
innererror	Azure.Core.Foundations.InnerError	エラーに関する現在のオブジェクトよりも具体的な情報を含むオブジェクト。
message	string	エラーの人間が判読できる表現。
target	string	エラーのターゲット。

Azure.Core.Foundations.ErrorResponse

Object

エラーの詳細を含む応答。

名前	型	説明
error	Azure.Core.Foundations.Error	エラーオブジェクト。

Azure.Core.Foundations.InnerError

Object

エラーに関するより具体的な情報を含むオブジェクト。 Microsoft One API のガイドラインに従って - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

名前	型	説明
code	string	サーバー定義の一連のエラーコードの 1 つ。
innererror	Azure.Core.Foundations.InnerError	内部エラー。

DevBox

Object

開発ボックス。

名前	型	説明
actionState	string	Dev Box の現在のアクションの状態。これは、ユーザーが実行した以前のアクションに基づく状態です。
createdTime	string (date-time)	この Dev Box の作成時間 (RFC3339形式)。
error	Azure.Core.Foundations.Error	プロビジョニングまたはアクションのエラーの詳細。エラー状態に対してのみ設定されます。
hardwareProfile	HardwareProfile	Dev Box のハードウェアリソースに関する情報。
hibernateSupport	HibernateSupport	休止状態が有効か無効か不明かを示します。
imageReference	ImageReference	この Dev Box に使用されるイメージに関する情報。
localAdministrator	LocalAdminStatus	Dev Box の所有者がローカル管理者であるかどうかを示します。
location	string	この Dev Box がある Azure リージョン。これは、接続されている仮想ネットワークと同じリージョンになります。
name	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	Dev Box の表示名。
osType	OsType	この Dev Box のオペレーティングシステムの種類。
poolName	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	このマシンが属する Dev Box プールの名前。
powerState	PowerState	Dev Box の現在の電源状態。
projectName	string	この Dev Box が属するプロジェクトの名前。
provisioningState	DevBoxProvisioningState	Dev Box の現在のプロビジョニング状態。
storageProfile	StorageProfile	この Dev Box のストレージ設定。
uniqueId	string (uuid)	Dev Box の一意識別子。これは GUID 形式の文字列です (例: 000000000-0000-0000-0000-000000000000)。
uri	string (uri)	開発ボックスの一意の URI。
user	string (uuid)	この Dev Box が割り当てられているユーザーの AAD オブジェクト ID。

DevBoxProvisioningState

列挙

Dev Box のプロビジョニング状態を示します。

値	説明
Canceled	Dev Box のプロビジョニングが取り消されました。
Creating	Dev Box が作成されています。
Deleting	Dev Box が削除されています。
Failed	Dev Box のプロビジョニングに失敗しました。
InGracePeriod	Dev Box は猶予期間です。
NotProvisioned	Dev Box はプロビジョニングされていません。
ProvisionedWithWarning	Dev Box が警告付きでプロビジョニングされました。
Provisioning	Dev Box はプロビジョニング中です。
Starting	Dev Box が開始中です。
Stopping	Dev Box が停止しています。
Succeeded	Dev Box が正常にプロビジョニングされました。
Updating	Dev Box が更新中です。

HardwareProfile

Object

Dev Box のハードウェア仕様。

名前	型	説明
memoryGB	integer (int32)	Dev Box で使用できるメモリの量。
skuName	SkuName	SKU の名前。
vCPUs	integer (int32)	Dev Box で使用できる vCPU の数。

HibernateSupport

列挙

オペレーティングシステムで休止状態がサポートされ、有効か無効か、サポートされていないかを示します。不明な休止状態のサポートは null として表されます。

値	説明
Disabled	休止状態が有効になっていません。
Enabled	休止状態が有効になっています。
OsUnsupported	休止状態は、オペレーティングシステムではサポートされていません。

ImageReference

Object

使用するイメージに関する情報を指定します。

名前	型	説明
name	string	使用されるイメージの名前。
operatingSystem	string	イメージのオペレーティングシステム。
osBuildNumber	string	イメージのオペレーティングシステムのビルド番号。
publishedDate	string (date-time)	バッキングイメージバージョンが発行された日時 (RFC3339形式)。
version	string	イメージのバージョン。

LocalAdminStatus

列挙

プール内の Dev Boxes の所有者が Dev Boxes のローカル管理者であるかどうかを示します。

値	説明
Disabled	プール内の Dev Boxes の所有者は、Dev Boxes のローカル管理者ではありません。
Enabled	プール内の Dev Boxes の所有者は、Dev Boxes のローカル管理者です。

OsDisk

Object

オペレーティングシステムディスクの設定。

名前	型	説明
diskSizeGB	integer (int32)	OS ディスクのサイズ (ギガバイト単位)。

OsType

列挙

オペレーティングシステムの種類。

値	説明
Windows	Windows オペレーティングシステム。

PagedDevBox

Object

DevBox 項目のページコレクション

名前	型	説明
nextLink	string (uri)	アイテムの次のページへのリンク
value	DevBox[]	このページの DevBox 項目

PowerState

列挙

Dev Box の電源状態。

値	説明
Deallocated	Dev Box の割り当てが解除されます。
Hibernated	Dev Box は休止状態です。
PoweredOff	Dev Box の電源がオフになっています。
Running	Dev Box が実行されています。
Unknown	Dev Box の電源状態が不明です。

SkuName

列挙

Dev Box コンピューティングを示します。

値	説明
general_a_16c64gb1024ssd_v2	AMD、16 vCPU、64 GB RAM、1024 GB ストレージ。
general_a_16c64gb2048ssd_v2	AMD、16 vCPU、64 GB RAM、2048 GB ストレージ。
general_a_16c64gb256ssd_v2	AMD、16 vCPU、64 GB RAM、256 GB ストレージ。
general_a_16c64gb512ssd_v2	AMD、16 vCPU、64 GB RAM、512 GB ストレージ。
general_a_32c128gb1024ssd_v2	AMD、32 vCPU、128 GB RAM、1024 GB ストレージ。
general_a_32c128gb2048ssd_v2	AMD、32 vCPU、128 GB RAM、2048 GB ストレージ。
general_a_32c128gb512ssd_v2	AMD、32 vCPU、128 GB RAM、512 GB ストレージ。
general_a_8c32gb1024ssd_v2	AMD、8 vCPU、32 GB RAM、1024 GB ストレージ。
general_a_8c32gb2048ssd_v2	AMD、8 vCPU、32 GB RAM、2048 GB ストレージ。
general_a_8c32gb256ssd_v2	AMD、8 vCPU、32 GB RAM、256 GB ストレージ。
general_a_8c32gb512ssd_v2	AMD、8 vCPU、32 GB RAM、512 GB ストレージ。
general_i_16c64gb1024ssd_v2	Intel、16 vCPU、64 GB RAM、1024 GB ストレージ。
general_i_16c64gb2048ssd_v2	Intel、16 vCPU、64 GB RAM、2048 GB ストレージ。
general_i_16c64gb256ssd_v2	Intel、16 vCPU、64 GB RAM、256 GB ストレージ。
general_i_16c64gb512ssd_v2	Intel、16 vCPU、64 GB RAM、512 GB ストレージ。
general_i_32c128gb1024ssd_v2	Intel、32 vCPU、128 GB RAM、1024 GB ストレージ。
general_i_32c128gb2048ssd_v2	Intel、32 vCPU、128 GB RAM、2048 GB ストレージ。
general_i_32c128gb512ssd_v2	Intel、32 vCPU、128 GB RAM、512 GB ストレージ。
general_i_8c32gb1024ssd_v2	Intel、8 vCPU、32 GB RAM、1024 GB ストレージ。
general_i_8c32gb2048ssd_v2	Intel、8 vCPU、32 GB RAM、2048 GB ストレージ。
general_i_8c32gb256ssd_v2	Intel、8 vCPU、32 GB RAM、256 GB ストレージ。
general_i_8c32gb512ssd_v2	Intel、8 vCPU、32 GB RAM、512 GB ストレージ。

StorageProfile

Object

Dev Box のディスクのストレージ設定。

名前	型	説明
osDisk	OsDisk	オペレーティングシステムディスクの設定。

次の方法で共有

Dev Boxes - List All Dev Boxes

URI パラメーター

応答

セキュリティ

OAuth2Auth

スコープ

例

Lists Dev Boxes that the caller has access to in the DevCenter.

要求のサンプル

応答のサンプル

定義

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

DevBox

DevBoxProvisioningState

HardwareProfile

HibernateSupport

ImageReference

LocalAdminStatus

OsDisk

OsType

PagedDevBox

PowerState

SkuName

StorageProfile