Azure Virtual Desktop 用の Azure CLI 拡張機能とAzure PowerShell モジュールがあり、このモジュールを使用して、Azure portalを使用する代わりに Azure Virtual Desktop サービス オブジェクトの作成、更新、削除、操作を行うことができます。 これらは Azure CLI とAzure PowerShellの一部であり、幅広い Azure サービスをカバーしています。
この記事では、Azure CLI 拡張機能と Azure PowerShell モジュールを使用する方法について説明し、便利なコマンドの例をいくつか示します。
Azure CLI 拡張機能とAzure PowerShell モジュール
Azure CLI 拡張機能と Azure PowerShell モジュールの名前と、リファレンス ドキュメントへのリンクを次に示します。
Azure CLI:
az desktopvirtualization
Azure PowerShell:
Az.DesktopVirtualization
Azure CLI とAzure PowerShellはどちらも、インストールなしでAzure portalで Azure Cloud Shellネイティブに使用できます。また、Windows、macOS、Linux 用のデバイスにローカルにインストールすることもできます。
サポートされているすべてのプラットフォームに Azure CLI とAzure PowerShellをインストールする方法については、次のリンクを参照してください。
Azure CLI: Azure CLI をインストールする方法
Azure PowerShell: Azure Az PowerShell モジュールをインストールする
コマンドの例
役に立つ可能性がある Azure Virtual Desktop リソースに関する情報と値を取得するために使用できるコマンドの例を次に示します。 シナリオに関連するタブを選択します。
重要
次の例では、独自の <placeholder>
値を変更する必要があります。
使用可能な Azure リージョン
create
を含む CLI コマンドのいずれかを使用して Azure Virtual Desktop サービス オブジェクトを作成する場合は、作成する Azure リージョンを指定する必要があります。
--___location
パラメーターで使用する Azure リージョンの名前を見つけるには、次のコマンドを実行し、Location
列の値を使用します。
az account list-locations --query "sort_by([].{DisplayName:displayName, Location:name}, &Location)" -o table
ホスト プール、ワークスペース、アプリケーション グループ、またはアプリケーションのオブジェクト ID を取得する
ホスト プールのオブジェクト ID を取得するには、次のコマンドを実行します。
az desktopvirtualization hostpool show \ --name <Name> \ --resource-group <ResourceGroupName> \ --query objectId --output tsv
ワークスペースのオブジェクト ID を取得するには、次のコマンドを実行します。
az desktopvirtualization workspace show \ --name <Name> \ --resource-group <ResourceGroupName> \ --query objectId --output tsv
アプリケーション グループのオブジェクト ID を取得するには、次のコマンドを実行します。
az desktopvirtualization applicationgroup show \ --name <Name> \ --resource-group <ResourceGroupName> \ --query objectId --output tsv
ヒント
Azure Virtual Desktop 用の Azure CLI 拡張機能には、アプリケーション用のコマンドがありません。 代わりに Azure PowerShell を使用します。
次の手順
Azure VIRTUAL Desktop で Azure CLI とAzure PowerShellを使用する方法を確認したら、それらを使用するいくつかの記事を次に示します。
- PowerShell または Azure CLI を使用して Azure Virtual Desktop ホスト プールを作成する
- PowerShell または Azure CLI を使用してアプリケーション グループを管理する
- 完全な PowerShell リファレンス ドキュメントについては、「 Az.DesktopVirtualization」を参照してください。