Windows Virtual Desktop 用 PowerShell モジュールを設定するSet up the PowerShell module for Windows Virtual Desktop

重要

このコンテンツは、Azure Resource Manager との統合で Windows Virtual Desktop に適用されます。This content applies to Windows Virtual Desktop with Azure Resource Manager integration.

Windows Virtual Desktop PowerShell モジュールは、Azure PowerShell モジュールに統合されています。The Windows Virtual Desktop PowerShell module is integrated into the Azure PowerShell module. この記事では、Windows Virtual Desktop のコマンドレットを実行できるように PowerShell モジュールを設定する方法について説明します。This article will tell you how to set up the PowerShell module so you can run cmdlets for Windows Virtual Desktop.

PowerShell 環境をセットアップするSet up your PowerShell environment

モジュールの使用を開始するには、まず、最新バージョンの PowerShell Core をインストールします。To get started with using the module, first install the latest version of PowerShell Core. 現在、Windows Virtual Desktop のコマンドレットは PowerShell Core でのみ機能します。Windows Virtual Desktop cmdlets currently only work with PowerShell Core.

次に、PowerShell セッションで使用するために、DesktopVirtualization モジュールをインストールする必要があります。Next, you'll need to install the DesktopVirtualization module to use in your PowerShell session.

モジュールをインストールするには、管理者特権モードで次の PowerShell コマンドレットを実行します。Run the following PowerShell cmdlet in elevated mode to install the module:

Install-Module -Name Az.DesktopVirtualization

注意

このコマンドレットが動作しない場合は、管理者特権のアクセス許可を使用して、もう一度実行してみてください。If this cmdlet doesn't work, try running it again with elevated permissions.

その後、次のコマンドレットを実行して Azure に接続します。Next, run the following cmdlet to connect to Azure:

Connect-AzAccount

重要

US Gov ポータルに接続する場合は、代わりに次のコマンドレットを実行します。If you're connecting to the US Gov portal, run this cmdlet instead:

Connect-AzAccount -EnvironmentName AzureUSGovernment

Azure アカウントにサインインするには、Connect コマンドレットを実行するときに生成されるコードが必要です。Signing into your Azure account requires a code that's generated when you run the Connect cmdlet. サインインするには、https://microsoft.com/devicelogin に移動し、コードを入力してから、Azure 管理者の資格情報を使用してサインインします。To sign in, go to https://microsoft.com/devicelogin, enter the code, then sign in using your Azure admin credentials.

Account SubscriptionName TenantId Environment

------- ---------------- -------- -----------

Youradminupn subscriptionname AzureADTenantID AzureCloud

これにより、管理者の資格情報の既定値であるサブスクリプションに直接サインインします。This will sign you directly into the subscription that is default for your admin credentials.

既定のサブスクリプションを変更するChange the default subscription

サインイン後に既定のサブスクリプションを変更する場合は、次のコマンドレットを実行します。If you want to change the default subscription after you've signed in, run this cmdlet:

Select-AzSubscription -Subscription <preferredsubscriptionname>

次のように、Out-GridView コマンドレットを使用して、一覧から 1 つを選択することもできます。You can also select one from a list using the Out-GridView cmdlet:

Get-AzSubscription | Out-GridView -PassThru | Select-AzSubscription

使用する新しいサブスクリプションを選択する場合は、後で実行するコマンドレットで、そのサブスクリプションの ID を指定する必要はありません。When you select a new subscription to use, you don't need to specify that subscription's ID in cmdlets you run afterwards. たとえば、次のコマンドレットは、サブスクリプション ID を必要とせずに、特定のセッション ホストを取得します。For example, the following cmdlet retrieves a specific session host without needing the subscription ID:

Get-AzWvdSessionHost -HostPoolName <hostpoolname> -Name <sessionhostname> -ResourceGroupName <resourcegroupname>

また、必要なサブスクリプション名をパラメーターとして追加することで、コマンドレットごとにサブスクリプションを変更することもできます。You can also change subscriptions on a per-cmdlet basis by adding the desired subscription name as a parameter. 次のコマンドレットは前の例と同じですが、コマンドレットで使用するサブスクリプションを変更するためにパラメーターとしてサブスクリプション ID が追加されている点が異なります。The next cmdlet is the same as the previous example, except with the subscription ID added as a parameter to change which subscription the cmdlet uses.

Get-AzWvdSessionHost -HostPoolName <hostpoolname> -Name <sessionhostname> -ResourceGroupName <resourcegroupname> -SubscriptionId <subscriptionGUID>

場所を取得するGet locations

場所パラメーターは、新しいオブジェクトを作成するすべての New-AzWVD コマンドレットで必須です。The location parameter is mandatory for all New-AzWVD cmdlets that create new objects.

次のコマンドレットを実行して、自分のサブスクリプションでサポートされている場所の一覧を取得します。Run the following cmdlet to get a list of locations your subscription supports:

Get-AzLocation

Get-AzLocation の出力は、次のようになります。The output for Get-AzLocation will look like this:

Location : eastasia

DisplayName : East Asia

Providers : {Microsoft.RecoveryServices, Microsoft.ManagedIdentity,
Microsoft.SqlVirtualMachine, microsoft.insights…}

Location : southeastasia

DisplayName : Southeast Asia

Providers : {Microsoft.RecoveryServices, Microsoft.ManagedIdentity,
Microsoft.SqlVirtualMachine, microsoft.insights…}

Location : centralus

DisplayName : Central US

Providers : {Microsoft.RecoveryServices, Microsoft.DesktopVirtualization,
Microsoft.ManagedIdentity, Microsoft.SqlVirtualMachine…}

Location : eastus

DisplayName : East US

Providers : {Microsoft.RecoveryServices, Microsoft.DesktopVirtualization,
Microsoft.ManagedIdentity, Microsoft.SqlVirtualMachine…}

アカウントの場所を確認したら、コマンドレットで使用できます。Once you know your account's location, you can use it in a cmdlet. たとえば、"southeastasia" という場所にホスト プールを作成するコマンドレットを次に示します。For example, here's a cmdlet that creates a host pool in the "southeastasia" location:

New-AzWvdHostPool -ResourceGroupName <resourcegroupname> -Name <hostpoolname> -WorkspaceName <workspacename> -Location “southeastasia”

次のステップNext steps

PowerShell モジュールの設定が完了したので、コマンドレットを実行して Windows Virtual Desktop であらゆる処理を実行できます。Now that you've set up your PowerShell module, you can run cmdlets to do all sorts of things in Windows Virtual Desktop. モジュールを使用できるいくつかの場所を以下に示します。Here are some of the places you can use your module:

問題が発生した場合は、PowerShell のトラブルシューティングに関する記事を参照してください。If you run into any issues, check out our PowerShell troubleshooting article for help.