az devcenter admin pool

  • リファレンス

Note

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

プールを管理します。

コマンド

名前 説明 型 Status
az devcenter admin pool create

プールを作成します。

 拡張子 GA
az devcenter admin pool delete

プールを削除する

 拡張子 GA
az devcenter admin pool list

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

 拡張子 GA
az devcenter admin pool run-health-check

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

 拡張子 GA
az devcenter admin pool show

プールを取得します。

 拡張子 GA
az devcenter admin pool update

プールを更新します。

 拡張子 GA
az devcenter admin pool wait

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

 拡張子 GA

az devcenter admin pool create

プールを作成します。

az devcenter admin pool create --devbox-definition-name
                               --local-administrator {Disabled, Enabled}
                               --name
                               --project
                               --resource-group
                               [--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]
                               [--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"

必須のパラメーター

--devbox-definition-name -d

このプールの親プロジェクトの開発ボックス定義の名前。

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

省略可能のパラメーター

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

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

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

グローバル パラメーター
--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]

例

Yammer の入手

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

省略可能のパラメーター

--ids

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

--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-name]
                               [--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]
                               [--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、または JSON 文字列>。

--devbox-definition-name -d

このプールの親プロジェクトの開発ボックス定義の名前。

--display-name

プールの表示名。

--force-string

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

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

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

--local-administrator

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

承認された値: Disabled, Enabled
--managed-virtual-network-regions -m

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

--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 OR --remove propertyToRemove。

--resource-group -g

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

--set

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

--single-sign-on-status

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

承認された値: Disabled, Enabled
--stop-on-disconnect
プレビュー

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

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

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

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