Dev Boxes - Get Dev Box Addon

サービス:

Dev Center

API バージョン:

2025-04-01-preview

Dev Box アドオン ID によって Dev Box アドオンを取得します。

GET {endpoint}/projects/{projectName}/users/{userId}/devboxes/{devBoxName}/addons/{addOnName}?api-version=2025-04-01-preview

URI パラメーター

名前	/	必須	型	説明
addOnName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	開発ボックス アドオンの名前。
devBoxName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	Dev Box の表示名。
endpoint	path	True	string (uri)	操作する DevCenter 固有の URI。
projectName	path	True	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	プロジェクトの名前。
userId	path	True	string minLength: 2 maxLength: 36 pattern: ^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$	ユーザーの AAD オブジェクト ID。 値が "me" の場合、ID は認証コンテキストから取得されます。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

応答

名前	型	説明
200 OK	DevBoxAddOn: DevBoxTunnel	要求は成功しました。
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

例

Gets a Dev Box addon by Dev Box addon ID.

要求のサンプル

HTTP

GET https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/me/devboxes/myDevBox/addons/devboxtunnel-sys-default?api-version=2025-04-01-preview

応答のサンプル

状態コード:

200

{
  "name": "devboxtunnel-sys-default",
  "kind": "DevBoxTunnel",
  "actionState": "Disabled",
  "status": "Disabled",
  "provisioningState": "Succeeded",
  "hostingResourceName": "Default",
  "codeTunnelName": "mdb-contoso-35268c5-e8da-8918-128b-d3a2c4645795",
  "codeTunnelUrl": "https://vscode.dev/tunnel/mdb-contoso-35268c5-e8da-8918-128b-d3a2c4645795"
}

定義

名前	説明
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.
DevBoxAddOnKind	Dev Box アドオンの種類。
DevBoxTunnel	Dev Box Tunnel アドオン。
DevBoxTunnelStatus	Dev Box Tunnel アドオンの詳細な状態。
ProvisioningState	一般的なプロビジョニング状態を示します。

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	内部エラー。

DevBoxAddOnKind

列挙

Dev Box アドオンの種類。

値	説明
DevBoxTunnel	Dev Box Tunnel アドオン。

DevBoxTunnel

Object

Dev Box Tunnel アドオン。

名前	型	説明
actionState	string	Dev Box アドオンの現在のアクションの状態。 この状態は、ユーザーが実行した以前のアクションに基づいています。
codeTunnelName	string	コード トンネル名。
codeTunnelUrl	string (uri)	コード トンネルの URL。
error	Azure.Core.Foundations.Error	作成、削除、またはアクション エラーの詳細。 エラー状態に対してのみ設定されます。
hostingResourceName	string	ホスト リソース名 (DevBox または HyperV)。 空のままにするか、DevBox 用の場合は Default 。
kind	string: DevBoxTunnel	Dev Box アドオンの種類。
name	string minLength: 3 maxLength: 63 pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$	開発ボックス アドオンの名前。
provisioningState	ProvisioningState	このアドオンのプロビジョニング状態。
status	DevBoxTunnelStatus	トンネルの状態。

DevBoxTunnelStatus

列挙

Dev Box Tunnel アドオンの詳細な状態。

値	説明
Disabled	トンネルは非アクティブであり、接続できません。
Enabled	トンネルはアクティブであり、接続できます。
Suspended	トンネルは休止状態またはその他の理由により中断されます。

ProvisioningState

列挙

一般的なプロビジョニング状態を示します。

値	説明
Creating	リソースが作成されています。
Deleting	リソースが削除されています。
Failed	リソースのプロビジョニングに失敗しました。
Succeeded	リソースが正常にプロビジョニングされました。
Updating	リソースが更新中です。