次の方法で共有

az devcenter admin devbox-definition

Note

このリファレンスは、Azure CLI (バージョン 2.67.0 以降) の 開発センター 拡張機能の一部です。 拡張機能は、az devcenter admin devbox-definition コマンド 初めて実行するときに自動的にインストールされます。 拡張機能の詳細については、 を参照してください。

開発ボックスの定義を管理します。

コマンド

名前 説明 型 状態
az devcenter admin devbox-definition create

開発ボックス定義を作成します。

 Extension GA
az devcenter admin devbox-definition delete

開発ボックス定義を削除します。

 Extension GA
az devcenter admin devbox-definition list

デベロッパー センターまたはプロジェクト用に構成された開発ボックス定義を一覧表示します。

 Extension GA
az devcenter admin devbox-definition show

デベロッパー センターまたはプロジェクト用に構成された開発ボックス定義を取得します。

 Extension GA
az devcenter admin devbox-definition update

開発ボックス定義を更新します。

 Extension GA
az devcenter admin devbox-definition wait

条件が満たされるまで CLI を待機状態にします。

 Extension GA

az devcenter admin devbox-definition create

開発ボックス定義を作成します。

az devcenter admin devbox-definition create --dev-center --dev-center-name
                                            --devbox-definition-name --name
                                            --image-reference
                                            --os-storage-type
                                            --resource-group
                                            --sku
                                            [--hibernate-support {Disabled, Enabled}]
                                            [--location]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--tags]

例

Create

az devcenter admin devbox-definition create --location "eastus" --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/1.0.0" --os-storage-type "ssd_1024gb" --sku name="general_a_8c32gb_v1" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

必須のパラメーター

--dev-center --dev-center-name -d

デベロッパー センターの名前。 az configure -d dev-center=<dev_center_name> を使用して既定値を構成します。

--devbox-definition-name --name -n

開発ボックス定義の名前。

--image-reference

画像参照情報。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
--os-storage-type

この定義を使用して作成された開発ボックスのオペレーティング システム ディスクに使用されるストレージの種類。

プロパティ 値
パラメーター グループ: Properties Arguments
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

--sku

この定義を使用して作成された開発ボックスの SKU。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--hibernate-support

この定義で作成された開発ボックスが休止状態にできるかどうかを示します。 すべてのイメージが休止状態をサポートできるわけではありません。 詳細については、https://aka.ms/devbox/hibernateを参照してください。

プロパティ 値
パラメーター グループ: Properties Arguments
指定可能な値: Disabled, Enabled
--location -l

リソースが存在する地理的な場所。 値のソース: az account list-locations az configure --defaults location=<location>を使用して、既定の場所を構成できます。 指定しない場合は、リソース グループの場所が使用されます。

プロパティ 値
パラメーター グループ: Body Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Body Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az devcenter admin devbox-definition delete

開発ボックス定義を削除します。

az devcenter admin devbox-definition delete [--dev-center --dev-center-name]
                                            [--devbox-definition-name --name]
                                            [--ids]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--resource-group]
                                            [--subscription]
                                            [--yes]

例

Delete

az devcenter admin devbox-definition delete --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--dev-center --dev-center-name -d

デベロッパー センターの名前。 az configure -d dev-center=<dev_center_name> を使用して既定値を構成します。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--devbox-definition-name --name -n

開発ボックス定義の名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--yes -y

確認を求めないでください。

プロパティ 値
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az devcenter admin devbox-definition list

デベロッパー センターまたはプロジェクト用に構成された開発ボックス定義を一覧表示します。

az devcenter admin devbox-definition list --resource-group
                                          [--dev-center --dev-center-name]
                                          [--max-items]
                                          [--next-token]
                                          [--project --project-name]

例

デベロッパー センター別に一覧表示する

az devcenter admin devbox-definition list --dev-center-name "Contoso" --resource-group "rg1"

プロジェクト別に一覧表示する

az devcenter admin devbox-definition list --project-name "ContosoProject" --resource-group "rg1"

必須のパラメーター

--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--dev-center --dev-center-name -d

デベロッパー センターの名前。 az configure -d dev-center=<dev_center_name> を使用して既定値を構成します。

--max-items

コマンドの出力で返される項目の合計数。 使用可能な項目の合計数が指定された値を超える場合は、コマンドの出力にトークンが提供されます。 改ページ位置の変更を再開するには、後続のコマンドの引数 --next-token トークン値を指定します。

プロパティ 値
パラメーター グループ: Pagination Arguments
--next-token

ページ分割を開始する場所を指定するトークン。 これは、以前に切り捨てられた応答からのトークン値です。

プロパティ 値
パラメーター グループ: Pagination Arguments
--project --project-name

プロジェクトの名前。 az configure -d project=<project_name> を使用して既定値を構成します。

グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az devcenter admin devbox-definition show

デベロッパー センターまたはプロジェクト用に構成された開発ボックス定義を取得します。

az devcenter admin devbox-definition show [--dev-center --dev-center-name]
                                          [--devbox-definition-name --name]
                                          [--ids]
                                          [--project --project-name]
                                          [--resource-group]
                                          [--subscription]

例

デベロッパー センターのデベロッパー ボックス定義を取得する

az devcenter admin devbox-definition show --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

プロジェクト開発ボックス定義を取得する

az devcenter admin devbox-definition show --name "WebDevBox" --project-name "ContosoProject" --resource-group "rg1"

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--dev-center --dev-center-name -d

デベロッパー センターの名前。 az configure -d dev-center=<dev_center_name> を使用して既定値を構成します。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--devbox-definition-name --name -n

開発ボックス定義の名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--project --project-name

プロジェクトの名前。 az configure -d project=<project_name> を使用して既定値を構成します。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ 値
パラメーター グループ: Resource Id Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az devcenter admin devbox-definition update

開発ボックス定義を更新します。

az devcenter admin devbox-definition update [--add]
                                            [--dev-center --dev-center-name]
                                            [--devbox-definition-name --name]
                                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--hibernate-support {Disabled, Enabled}]
                                            [--ids]
                                            [--image-reference]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--os-storage-type]
                                            [--remove]
                                            [--resource-group]
                                            [--set]
                                            [--sku]
                                            [--subscription]
                                            [--tags]

例

Update

az devcenter admin devbox-definition update --image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/Example/providers/Microsoft.DevCenter/devcenters/Contoso/galleries/contosogallery/images/exampleImage/version/2.0.0" --name "WebDevBox" --dev-center-name "Contoso" --resource-group "rg1"

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--add

パスとキー値のペアを指定して、オブジェクトの一覧にオブジェクトを追加します。 例: --add property.listProperty <key=value, string or JSON string>。

プロパティ 値
パラメーター グループ: Generic Update Arguments
--dev-center --dev-center-name -d

デベロッパー センターの名前。 az configure -d dev-center=<dev_center_name> を使用して既定値を構成します。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--devbox-definition-name --name -n

開発ボックス定義の名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--force-string

'set' または 'add' を使用する場合は、JSON に変換するのではなく、文字列リテラルを保持します。

プロパティ 値
パラメーター グループ: Generic Update Arguments
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--hibernate-support

この定義で作成された開発ボックスが休止状態にできるかどうかを示します。 すべてのイメージが休止状態をサポートできるわけではありません。 詳細については、https://aka.ms/devbox/hibernateを参照してください。

プロパティ 値
パラメーター グループ: Properties Arguments
指定可能な値: Disabled, Enabled
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--image-reference

画像参照情報。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
--no-wait

実行時間の長い操作が完了するまで待つ必要はありません。

プロパティ 値
指定可能な値: 0, 1, f, false, n, no, t, true, y, yes
--os-storage-type

この定義を使用して作成された開発ボックスのオペレーティング システム ディスクに使用されるストレージの種類。

プロパティ 値
パラメーター グループ: Properties Arguments
--remove

リストからプロパティまたは要素を削除します。 例: --remove property.list <indexToRemove> OR --remove propertyToRemove。

プロパティ 値
パラメーター グループ: Generic Update Arguments
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--set

設定するプロパティ パスと値を指定して、オブジェクトを更新します。 例: --set property1.property2=<value>。

プロパティ 値
パラメーター グループ: Generic Update Arguments
--sku

この定義を使用して作成された開発ボックスの SKU。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Properties Arguments
--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--tags

リソース タグ。 短縮構文、json-file、yaml-file をサポートします。 詳細を表示するには、"??" を試してください。

プロパティ 値
パラメーター グループ: Body Arguments
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False

az devcenter admin devbox-definition wait

条件が満たされるまで CLI を待機状態にします。

az devcenter admin devbox-definition wait [--created]
                                          [--custom]
                                          [--deleted]
                                          [--dev-center --dev-center-name]
                                          [--devbox-definition-name --name]
                                          [--exists]
                                          [--ids]
                                          [--interval]
                                          [--resource-group]
                                          [--subscription]
                                          [--timeout]
                                          [--updated]

オプションのパラメーター

次のパラメーターは省略可能ですが、コマンドを正常に実行するには、状況に応じて 1 つ以上が必要になる場合があります。

--created

'provisioningState' が 'Succeeded' で作成されるまで待ちます。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--custom

条件がカスタム JMESPath クエリを満たすまで待ちます。 例: provisioningState!='InProgress'、instanceView.statuses[?code=='PowerState/running']。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
--deleted

削除されるまで待ちます。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--dev-center --dev-center-name -d

デベロッパー センターの名前。 az configure -d dev-center=<dev_center_name> を使用して既定値を構成します。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--devbox-definition-name --name -n

開発ボックス定義の名前。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--exists

リソースが存在するまで待ちます。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
--ids

1 つ以上のリソース ID (スペース区切り)。 これは、'Resource Id' 引数のすべての情報を含む完全なリソース ID である必要があります。 --ids または他の 'Resource Id' 引数を指定する必要があります。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--interval

ポーリング間隔 (秒単位)。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: 30
--resource-group -g

リソース グループの名前。 az configure --defaults group=<name>を使用して既定のグループを構成できます。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--subscription

サブスクリプションの名前または ID。 az account set -s NAME_OR_IDを使用して既定のサブスクリプションを構成できます。

プロパティ 値
パラメーター グループ: Resource Id Arguments
--timeout

最大待機時間 (秒単位)。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: 3600
--updated

provisioningState が 'Succeeded' で更新されるまで待ちます。

プロパティ 値
パラメーター グループ: Wait Condition Arguments
規定値: False
グローバル パラメーター
--debug

ログの詳細度を上げて、すべてのデバッグ ログを表示します。

プロパティ 値
規定値: False
--help -h

このヘルプ メッセージを表示して終了します。

--only-show-errors

エラーのみを表示し、警告を抑制します。

プロパティ 値
規定値: False
--output -o

出力フォーマット。

プロパティ 値
規定値: json
指定可能な値: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath クエリ文字列。 詳細と例については、http://jmespath.org/ を参照してください。

--verbose

ログの詳細度を高める。 完全なデバッグ ログには --debug を使用します。

プロパティ 値
規定値: False