az devcenter admin pool

リファレンス

手記

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

プールを管理します。

コマンド

名前	説明	型	状態
az devcenter admin pool create	プールを作成します。	延長	ジョージア州
az devcenter admin pool delete	プールを削除します。	延長	ジョージア州
az devcenter admin pool list	プロジェクトのプールを一覧表示します。	延長	ジョージア州
az devcenter admin pool run-health-check	プールの状態の更新をトリガーします。	延長	ジョージア州
az devcenter admin pool show	プールを取得します。	延長	ジョージア州
az devcenter admin pool update	プールを更新します。	延長	ジョージア州
az devcenter admin pool wait	条件が満たされるまで CLI を待機状態にします。	延長	ジョージア州

az devcenter admin pool create

プールを作成します。

az devcenter admin pool create --local-administrator {Disabled, Enabled}
                               --name
                               --project
                               --resource-group
                               [--devbox-definition-image-reference]
                               [--devbox-definition-name]
                               [--devbox-definition-sku]
                               [--devbox-definition-type {Reference, Value}]
                               [--display-name]
                               [--location]
                               [--managed-virtual-network-regions]
                               [--network-connection-name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--single-sign-on-status {Disabled, Enabled}]
                               [--stop-on-disconnect]
                               [--stop-on-no-connect]
                               [--tags]
                               [--virtual-network-type {Managed, Unmanaged}]

例

アンマネージドネットワークを使用してプールを作成する

az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" --virtual-network-type "Unmanaged" --single-sign-on-status "Enabled"

マネージドネットワークを使用してプールを作成する

az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" --virtual-network-type "Managed" --managed-virtual-network-region ["westus3"] --single-sign-on-status "Enabled"

切断時に停止が有効になっているプールを作成する

az devcenter admin pool create --location "eastus" --devbox-definition-name "WebDevBox" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" --virtual-network-type "Unmanaged" --single-sign-on-status "Enabled" --stop-on-disconnect status="Enabled" grace-period-minutes="60"

イメージ定義を使用してプールを作成する

az devcenter admin pool create --location "eastus" --network-connection-name "Network1-westus2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --local-administrator "Enabled" --virtual-network-type "Unmanaged" --single-sign-on-status "Enabled" --devbox-definition-type "Value" --devbox-definition-image-reference id="/subscriptions/0ac520ee-14c0-480f-b6c9-0a90c58ffff/resourceGroups/rg1/providers/Microsoft.DevCenter/projects/DevProject/images/~Catalog~image2~project-sample-2" --devbox-definition-sku name=""general_i_8c32gb256ssd_v2"

必須のパラメーター

--local-administrator

このプール内の開発ボックスの所有者を開発ボックスのローカル管理者として追加するかどうかを示します。

指定可能な値: Disabled, Enabled

--name --pool-name -n

プールの名前。

--project --project-name

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

--resource-group -g

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

省略可能のパラメーター

--devbox-definition-image-reference -i

プレビュー

このプールから作成されたマシンの定義のイメージ参照情報。パラメーター devbox-definition-type が Reference の場合、または指定されていない場合は無視されます。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--devbox-definition-name -d

このプールの親プロジェクトの開発ボックス定義の名前。パラメーター devbox-definition-type が Value の場合は無視されます。

--devbox-definition-sku -s

プレビュー

プールから作成された開発ボックスの SKU。パラメーター devbox-definition-type が Reference の場合、または指定されていない場合は無視されます。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--devbox-definition-type -t

プールが既存の Dev Box 定義から作成されるか、直接提供されるかを示します。

指定可能な値: Reference, Value

--display-name

プールの表示名。

--location -l

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

--managed-virtual-network-regions -m

マネージド仮想ネットワークのリージョン (managedNetworkType が Managed の場合に必要)。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--network-connection-name -c

このプールの親プロジェクト内のネットワーク接続の名前。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--single-sign-on-status

このプール内の Dev Boxes がシングルサインオンを有効にして作成されるかどうかを示します。また、テナントでシングルサインオンを有効にする必要もあります。

指定可能な値: Disabled, Enabled

--stop-on-disconnect

このプールで作成された開発ボックスの構成設定の切断を停止します。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--stop-on-no-connect

プレビュー

このプールで作成された Dev Boxes の接続構成設定がない場合に停止します。短縮構文、json-file、yaml-file をサポートします。詳細を表示するには、"??" を試してください。

--tags

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

--virtual-network-type

プールが Microsoft によって管理されている仮想ネットワークを使用するか、顧客が指定したネットワークを使用するかを示します。

指定可能な値: Managed, Unmanaged

グローバルパラメーター

--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 pool delete

プールを削除します。

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

例

削除

az devcenter admin pool delete --name "DevPool" --project-name "DevProject" --resource-group "rg1"

省略可能のパラメーター

--ids

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

--name --pool-name -n

プールの名前。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--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を使用して既定のサブスクリプションを構成できます。

--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 pool list

プロジェクトのプールを一覧表示します。

az devcenter admin pool list --project
                             --resource-group
                             [--max-items]
                             [--next-token]

例

リスト

az devcenter admin pool list --project-name "DevProject" --resource-group "rg1"

必須のパラメーター

--project --project-name

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

--resource-group -g

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

省略可能のパラメーター

--max-items

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

--next-token

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

グローバルパラメーター

--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 pool run-health-check

プールの状態の更新をトリガーします。

az devcenter admin pool run-health-check [--ids]
                                         [--name]
                                         [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--project]
                                         [--resource-group]
                                         [--subscription]

例

正常性チェックを実行する

az devcenter admin pool run-health-check --name "DevPool" --project-name "DevProject" --resource-group "rg1"

省略可能のパラメーター

--ids

--name --pool-name -n

プールの名前。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--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 pool show

プールを取得します。

az devcenter admin pool show [--ids]
                             [--name]
                             [--project]
                             [--resource-group]
                             [--subscription]

例

取得

az admin pool show --name "DevPool" --project-name "DevProject" --resource-group "rg1"

省略可能のパラメーター

--ids

--name --pool-name -n

プールの名前。

--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 pool update

プールを更新します。

az devcenter admin pool update [--add]
                               [--devbox-definition-image-reference]
                               [--devbox-definition-name]
                               [--devbox-definition-sku]
                               [--devbox-definition-type {Reference, Value}]
                               [--display-name]
                               [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                               [--ids]
                               [--local-administrator {Disabled, Enabled}]
                               [--managed-virtual-network-regions]
                               [--name]
                               [--network-connection-name]
                               [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                               [--project]
                               [--remove]
                               [--resource-group]
                               [--set]
                               [--single-sign-on-status {Disabled, Enabled}]
                               [--stop-on-disconnect]
                               [--stop-on-no-connect]
                               [--subscription]
                               [--tags]
                               [--virtual-network-type {Managed, Unmanaged}]

例

更新

az devcenter admin pool update --devbox-definition-name "WebDevBox2" --pool-name "DevPool" --project-name "DevProject" --resource-group "rg1" --stop-on-disconnect status="Disabled"

省略可能のパラメーター

--add

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

--devbox-definition-image-reference -i

プレビュー

--devbox-definition-name -d

このプールの親プロジェクトの開発ボックス定義の名前。パラメーター devbox-definition-type が Value の場合は無視されます。

--devbox-definition-sku -s

プレビュー

--devbox-definition-type -t

プールが既存の Dev Box 定義から作成されるか、直接提供されるかを示します。

指定可能な値: Reference, Value

--display-name

プールの表示名。

--force-string

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--ids

--local-administrator

このプール内の開発ボックスの所有者を開発ボックスのローカル管理者として追加するかどうかを示します。

指定可能な値: Disabled, Enabled

--managed-virtual-network-regions -m

--name --pool-name -n

プールの名前。

--network-connection-name -c

このプールの親プロジェクト内のネットワーク接続の名前。

--no-wait

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

指定可能な値: 0, 1, f, false, n, no, t, true, y, yes

--project --project-name

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

--remove

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

--resource-group -g

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

--set

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

--single-sign-on-status

指定可能な値: Disabled, Enabled

--stop-on-disconnect

--stop-on-no-connect

プレビュー

--subscription

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

--tags

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

--virtual-network-type

プールが Microsoft によって管理されている仮想ネットワークを使用するか、顧客が指定したネットワークを使用するかを示します。

指定可能な値: Managed, Unmanaged

グローバルパラメーター

--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 pool wait

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

az devcenter admin pool wait [--created]
                             [--custom]
                             [--deleted]
                             [--exists]
                             [--ids]
                             [--interval]
                             [--name]
                             [--project]
                             [--resource-group]
                             [--subscription]
                             [--timeout]
                             [--updated]

省略可能のパラメーター

--created

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

規定値: False

--custom

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

--deleted

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

規定値: False

--exists

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

規定値: False

--ids

--interval

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

規定値: 30

--name --pool-name -n

プールの名前。

--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を使用して既定のサブスクリプションを構成できます。

--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 を使用します。

次の方法で共有

az devcenter admin pool

コマンド

az devcenter admin pool create

例

必須のパラメーター

省略可能のパラメーター

az devcenter admin pool delete

例

省略可能のパラメーター

az devcenter admin pool list

例

必須のパラメーター

省略可能のパラメーター

az devcenter admin pool run-health-check

例

省略可能のパラメーター

az devcenter admin pool show

例

省略可能のパラメーター

az devcenter admin pool update

例

省略可能のパラメーター

az devcenter admin pool wait

省略可能のパラメーター

その他のリソース