az desktopvirtualization hostpool

Note

このリファレンスは、Azure CLI (バージョン 2.55.0 以降) のデスクトップ仮想化拡張機能の一部です。 拡張機能は、az desktopvirtualization hostpool コマンドを初めて実行するときに自動的にインストールされます。 拡張機能の詳細をご覧ください。

デスクトップ仮想化ホスト プールを管理します。

コマンド

名前	説明	型	Status
az desktopvirtualization hostpool create	ホスト プールを作成する	拡張機能	GA
az desktopvirtualization hostpool delete	ホスト プールを削除します。	拡張機能	GA
az desktopvirtualization hostpool list	ホスト プールを一覧表示します。	拡張機能	GA
az desktopvirtualization hostpool retrieve-registration-token	ホスト プールの登録トークン。	拡張機能	GA
az desktopvirtualization hostpool show	ホスト プールを表示します。	拡張機能	GA
az desktopvirtualization hostpool update	ホスト プールを更新します。	拡張機能	GA

az desktopvirtualization hostpool create

ホスト プールを作成する

az desktopvirtualization hostpool create --host-pool-type {BYODesktop, Personal, Pooled}
                                         --load-balancer-type {BreadthFirst, DepthFirst, Persistent}
                                         --name
                                         --preferred-app-group-type {Desktop, None, RailApplications}
                                         --resource-group
                                         [--custom-rdp-property]
                                         [--description]
                                         [--friendly-name]
                                         [--location]
                                         [--max-session-limit]
                                         [--personal-desktop-assignment-type {Automatic, Direct}]
                                         [--registration-info]
                                         [--ring]
                                         [--sso-client-id]
                                         [--sso-client-secret-key-vault-path]
                                         [--sso-secret-type {Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault}]
                                         [--ssoadfs-authority]
                                         [--start-vm-on-connect {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--tags]
                                         [--validation-environment {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--vm-template]

例

ホスト プールの作成

az desktopvirtualization hostpool create -g rg -n hostpool-name --friendly-name friendly --host-pool-type Pooled --load-balancer-type BreadthFirst --max-session-limit 999999 --personal-desktop-assignment-type Automatic --preferred-app-group-type Desktop --registration-info expiration-time="yyyy-mm-ddT08:38:08.189Z" registration-token-operation=Update --sso-client-id client --sso-client-secret-key-vault-path https://keyvault/secret --sso-secret-type SharedKey --start-vm-on-connect false

必須のパラメーター

--host-pool-type

デスクトップのホスト プールの種類。

承認された値: BYODesktop, Personal, Pooled

--load-balancer-type

ロード バランサーの種類。

承認された値: BreadthFirst, DepthFirst, Persistent

--name -n

指定したリソース グループ内のホスト プールの名前。

--preferred-app-group-type -t

優先アプリケーション グループの種類。既定ではデスクトップ アプリケーション グループです。

承認された値: Desktop, None, RailApplications

--resource-group -g

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

省略可能のパラメーター

--custom-rdp-property

ホスト プールのカスタム rdp プロパティ。

--description

HostPool の説明。

--friendly-name

HostPool のフレンドリ名。

--location -l

リソースが存在する地理的な場所。

--max-session-limit

HostPool の最大セッション制限。

--personal-desktop-assignment-type

HostPool の PersonalDesktopAssignment 型。

承認された値: Automatic, Direct

--registration-info

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

--ring

HostPool のリング番号。

--sso-client-id

WVD SSO 証明書の発行に使用される登録済み証明書利用者の ClientId。

--sso-client-secret-key-vault-path -p

ADFS への通信に使用されるシークレットを格納する Azure KeyVault へのパス。

--sso-secret-type

シークレットの種類に対するシングル サインオンの種類。

承認された値: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault

--ssoadfs-authority

WVD SSO 証明書に署名するための顧客 ADFS サーバーへの URL。

--start-vm-on-connect

StartVMOnConnect 機能のオン/オフを切り替えるフラグ。

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

--tags

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

--validation-environment

検証環境です。

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

--vm-template

hostpool 内の sessionhosts 構成用の VM テンプレート。

グローバル パラメーター

--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 desktopvirtualization hostpool delete

ホスト プールを削除します。

az desktopvirtualization hostpool delete [--force {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--ids]
                                         [--name]
                                         [--resource-group]
                                         [--subscription]
                                         [--yes]

例

ホスト プールの削除

az desktopvirtualization hostpool delete -g rg -n hostpool-name

省略可能のパラメーター

--force

sessionHost を強制的に削除するようにフラグを設定します。

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

--ids

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

--name -n

指定したリソース グループ内のホスト プールの名前。

--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 desktopvirtualization hostpool list

ホスト プールを一覧表示します。

az desktopvirtualization hostpool list [--max-items]
                                       [--next-token]
                                       [--resource-group]

例

ホスト プールを一覧表示する

az desktopvirtualization hostpool list -g rg

省略可能のパラメーター

--max-items

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

--next-token

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

--resource-group -g

リソース グループの名前。 az configure --defaults group=<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 desktopvirtualization hostpool retrieve-registration-token

ホスト プールの登録トークン。

az desktopvirtualization hostpool retrieve-registration-token [--ids]
                                                              [--name]
                                                              [--resource-group]
                                                              [--subscription]

例

ホスト プールの登録トークン。

az desktopvirtualization hostpool retrieve-registration-token -n hostpool-name -g rg

省略可能のパラメーター

--ids

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

--name -n

指定したリソース グループ内のホスト プールの名前。

--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 desktopvirtualization hostpool show

ホスト プールを表示します。

az desktopvirtualization hostpool show [--ids]
                                       [--name]
                                       [--resource-group]
                                       [--subscription]

例

ホスト プールを表示する

az desktopvirtualization hostpool show -g rg -n hostpool-name

省略可能のパラメーター

--ids

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

--name -n

指定したリソース グループ内のホスト プールの名前。

--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 desktopvirtualization hostpool update

ホスト プールを更新します。

az desktopvirtualization hostpool update [--add]
                                         [--custom-rdp-property]
                                         [--description]
                                         [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--friendly-name]
                                         [--ids]
                                         [--load-balancer-type {BreadthFirst, DepthFirst, Persistent}]
                                         [--max-session-limit]
                                         [--name]
                                         [--personal-desktop-assignment-type {Automatic, Direct}]
                                         [--preferred-app-group-type {Desktop, None, RailApplications}]
                                         [--registration-info]
                                         [--remove]
                                         [--resource-group]
                                         [--ring]
                                         [--set]
                                         [--sso-client-id]
                                         [--sso-client-secret-key-vault-path]
                                         [--sso-secret-type {Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault}]
                                         [--ssoadfs-authority]
                                         [--start-vm-on-connect {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--subscription]
                                         [--tags]
                                         [--validation-environment {0, 1, f, false, n, no, t, true, y, yes}]
                                         [--vm-template]

例

ホスト プールを更新する

az desktopvirtualization hostpool update -g rg -n hostpool-name --tags tag=test

省略可能のパラメーター

--add

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

--custom-rdp-property

ホスト プールのカスタム rdp プロパティ。

--description

HostPool の説明。

--force-string

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

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

--friendly-name

HostPool のフレンドリ名。

--ids

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

--load-balancer-type

ロード バランサーの種類。

承認された値: BreadthFirst, DepthFirst, Persistent

--max-session-limit

HostPool の最大セッション制限。

--name -n

指定したリソース グループ内のホスト プールの名前。

--personal-desktop-assignment-type

HostPool の PersonalDesktopAssignment 型。

承認された値: Automatic, Direct

--preferred-app-group-type -t

優先アプリケーション グループの種類。既定ではデスクトップ アプリケーション グループです。

承認された値: Desktop, None, RailApplications

--registration-info

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

--remove

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

--resource-group -g

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

--ring

HostPool のリング番号。

--set

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

--sso-client-id

WVD SSO 証明書の発行に使用される登録済み証明書利用者の ClientId。

--sso-client-secret-key-vault-path -p

ADFS への通信に使用されるシークレットを格納する Azure KeyVault へのパス。

--sso-secret-type

シークレットの種類に対するシングル サインオンの種類。

承認された値: Certificate, CertificateInKeyVault, SharedKey, SharedKeyInKeyVault

--ssoadfs-authority

WVD SSO 証明書に署名するための顧客 ADFS サーバーへの URL。

--start-vm-on-connect

StartVMOnConnect 機能のオン/オフを切り替えるフラグ。

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

--subscription

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

--tags

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

--validation-environment

検証環境です。

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

--vm-template

hostpool 内の sessionhosts 構成用の VM テンプレート。

グローバル パラメーター

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