Share via

az devcenter admin devbox-definition

  • リファレンス

Note

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

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

コマンド

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

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

 拡張 GA
az devcenter admin devbox-definition delete

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

 拡張 GA
az devcenter admin devbox-definition list

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

 拡張 GA
az devcenter admin devbox-definition show

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

 拡張 GA
az devcenter admin devbox-definition update

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

 拡張 GA
az devcenter admin devbox-definition wait

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

 拡張 GA

az devcenter admin devbox-definition create

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

az devcenter admin devbox-definition create --dev-center
                                            --devbox-definition-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]

例

作成

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 をサポートします。 詳細を表示するには、"??" を試してください。

--os-storage-type

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

--resource-group -g

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

--sku

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

省略可能のパラメーター

--hibernate-support
プレビュー

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

承認された値: Disabled, Enabled
--location -l

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

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--tags

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

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

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az devcenter admin devbox-definition delete

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

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

例

削除

az devcenter admin devbox-definition delete --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

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

--ids

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

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--resource-group -g

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

--subscription

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

--yes -y

確認のダイアログを表示しません。

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az devcenter admin devbox-definition list

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

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

例

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

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> を使用して、既定のグループを構成できます。

省略可能のパラメーター

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

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

--max-items

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

--next-token

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

--project --project-name

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

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

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az devcenter admin devbox-definition show

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

az devcenter admin devbox-definition show [--dev-center]
                                          [--devbox-definition-name]
                                          [--ids]
                                          [--project]
                                          [--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"

省略可能のパラメーター

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

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

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

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

--ids

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

--project --project-name

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

--resource-group -g

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

--subscription

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

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

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az devcenter admin devbox-definition update

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

az devcenter admin devbox-definition update [--add]
                                            [--dev-center]
                                            [--devbox-definition-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"

省略可能のパラメーター

--add

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

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

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

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

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

--force-string

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

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--hibernate-support
プレビュー

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

承認された値: Disabled, Enabled
--ids

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

--image-reference

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

--no-wait

実行時間の長い操作の終了を待機しません。

承認された値: 0, 1, f, false, n, no, t, true, y, yes
--os-storage-type

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

--remove

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

--resource-group -g

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

--set

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

--sku

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

--subscription

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

--tags

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

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

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。

az devcenter admin devbox-definition wait

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

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

省略可能のパラメーター

--created

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

既定値: False
--custom

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

--deleted

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

既定値: False
--dev-center --dev-center-name -d

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

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

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

--exists

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

既定値: False
--ids

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

--interval

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

既定値: 30
--resource-group -g

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

--subscription

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

--timeout

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

既定値: 3600
--updated

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

既定値: False
グローバル パラメーター
--debug

すべてのデバッグ ログを表示するようにログの詳細レベルを上げます。

--help -h

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

--only-show-errors

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

--output -o

出力形式。

承認された値: json, jsonc, none, table, tsv, yaml, yamlc
既定値: json
--query

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

--subscription

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

--verbose

ログの詳細レベルを上げます。 詳細なデバッグ ログを表示するには --debug を使います。