ホスト プールのリモート デスクトップ プロトコル (RDP) プロパティをカスタマイズするCustomize Remote Desktop Protocol (RDP) properties for a host pool

重要

このコンテンツは、Azure Resource Manager Windows Virtual Desktop オブジェクトを含む Windows Virtual Desktop に適用されます。This content applies to Windows Virtual Desktop with Azure Resource Manager Windows Virtual Desktop objects. Azure Resource Manager オブジェクトを使用しない Windows Virtual Desktop (クラシック) を使用している場合は、こちらの記事を参照してください。If you're using Windows Virtual Desktop (classic) without Azure Resource Manager objects, see this article.

マルチ モニター エクスペリエンスやオーディオ リダイレクトなど、ホスト プールのリモート デスクトップ プロトコル (RDP) のプロパティをカスタマイズすると、ニーズに基づいてユーザーに最適なエクスペリエンスを提供できます。Customizing a host pool's Remote Desktop Protocol (RDP) properties, such as multi-monitor experience and audio redirection, lets you deliver an optimal experience for your users based on their needs. Azure portal を使用するか、Update-AzWvdHostPool コマンドレットで -CustomRdpProperty パラメーターを使用して、Windows Virtual Desktop の RDP プロパティをカスタマイズできます。You can customize RDP properties in Windows Virtual Desktop by either using the Azure portal or by using the -CustomRdpProperty parameter in the Update-AzWvdHostPool cmdlet.

サポートされているプロパティとその既定値の全リストについては、「サポートされるリモート デスクトップ RDP ファイルの設定」を参照してください。See supported RDP file settings for a full list of supported properties and their default values.

既定の RDP ファイルのプロパティDefault RDP file properties

RDP ファイルには、既定で次のプロパティがあります。RDP files have the following properties by default:

RDP プロパティRDP property デスクトップ上On Desktop RemoteApp としてAs a RemoteApp
マルチモニター モードMulti-monitor mode 無効Disabled EnabledEnabled
ドライブ リダイレクト有効Drive redirections enabled ドライブ、クリップボード、プリンター、COM ポート、およびスマート カードDrives, clipboard, printers, COM ports, and smart cards ドライブ、クリップボード、プリンターDrives, clipboard, and printers
リモート オーディオ モードRemote audio mode ローカルで再生Play locally ローカルで再生Play locally

前提条件Prerequisites

作業を開始する前に、Windows Virtual Desktop PowerShell モジュールの設定に関するページの手順に従って、PowerShell モジュールを設定し、Azure にサインインしてください。Before you begin, follow the instructions in Set up the Windows Virtual Desktop PowerShell module to set up your PowerShell module and sign in to Azure.

Azure portal で RDP プロパティを構成するConfigure RDP properties in the Azure portal

Azure portal で RDP プロパティを構成するにはTo configure RDP properties in the Azure portal:

  1. https://portal.azure.com で Azure にサインインします。Sign in to Azure at https://portal.azure.com.
  2. 検索バーに「windows virtual desktop」と入力します。Enter windows virtual desktop into the search bar.
  3. サービスの下で [Windows Virtual Desktop] を選択します。Under Services, select Windows Virtual Desktop.
  4. [Windows Virtual Desktop] ページで、画面の左側にあるメニューの [ホスト プール] を選択します。At the Windows Virtual Desktop page, select host pools in the menu on the left side of the screen.
  5. 更新するホスト プールの名前を選択します。Select the name of the host pool you want to update.
  6. 画面の左側にあるメニューで [RDP プロパティ] を選択します。Select RDP Properties in the menu on the left side of the screen.
  7. 必要なプロパティを設定します。Set the property you want.
    • または、 [詳細] タブを開き、次のセクションの PowerShell の例のように、セミコロンで区切られた形式で RDP プロパティを追加できます。Alternatively, you can open the Advanced tab and add your RDP properties in a semicolon-separated format like the PowerShell examples in the following sections.
  8. 完了したら、 [保存] を選択して変更を保存します。When you're done, select Save to save your changes.

次のセクションでは、PowerShell でカスタム RDP プロパティを手動で編集する方法について説明します。The next sections will tell you how to edit custom RDP properties manually in PowerShell.

単一のカスタム RDP プロパティを追加または編集するAdd or edit a single custom RDP property

単一のカスタム RDP プロパティを追加または編集するには、次の PowerShell コマンドレットを実行します。To add or edit a single custom RDP property, run the following PowerShell cmdlet:

Update-AzWvdHostPool -ResourceGroupName <resourcegroupname> -Name <hostpoolname> -CustomRdpProperty <property>

実行したコマンドレットでプロパティを更新したかどうかを確認するには、次のコマンドレットを実行します。To check if the cmdlet you just ran updated the property, run this cmdlet:

Get-AzWvdHostPool -ResourceGroupName <resourcegroupname> -Name <hostpoolname> | format-list Name, CustomRdpProperty

Name              : <hostpoolname>
CustomRdpProperty : <customRDPpropertystring>

たとえば、0301HP という名前のホスト プールで "audiocapturemode" プロパティを確認している場合は、次のコマンドレットを入力します。For example, if you were checking for the "audiocapturemode" property on a host pool named 0301HP, you'd enter this cmdlet:

Get-AzWvdHostPool -ResourceGroupName 0301rg -Name 0301hp | format-list Name, CustomRdpProperty

Name              : 0301HP
CustomRdpProperty : audiocapturemode:i:1;

複数のカスタム RDP プロパティを追加または編集するAdd or edit multiple custom RDP properties

複数のカスタム RDP プロパティを追加または編集するには、カスタム RDP プロパティをセミコロンで区切った文字列として指定して、次の PowerShell コマンドレットを実行します。To add or edit multiple custom RDP properties, run the following PowerShell cmdlets by providing the custom RDP properties as a semicolon-separated string:

$properties="<property1>;<property2>;<property3>"
Update-AzWvdHostPool -ResourceGroupName <resourcegroupname> -Name <hostpoolname> -CustomRdpProperty $properties

次のコマンドレットを実行して、RDP プロパティが追加されたことを確認できます。You can check to make sure the RDP property was added by running the following cmdlet:

Get-AzWvdHostPool -ResourceGroupName <resourcegroupname> -Name <hostpoolname> | format-list Name, CustomRdpProperty

Name              : <hostpoolname>
CustomRdpProperty : <customRDPpropertystring>

前のコマンドレットの例に基づいて、0301HP ホスト プールに複数の RDP プロパティを設定した場合、コマンドレットは次のようになります。Based on our earlier cmdlet example, if you set up multiple RDP properties on the 0301HP host pool, your cmdlet would look like this:

Get-AzWvdHostPool -ResourceGroupName 0301rg -Name 0301hp | format-list Name, CustomRdpProperty

Name              : 0301HP
CustomRdpProperty : audiocapturemode:i:1;audiomode:i:0;

すべてのカスタム RDP プロパティをリセットするReset all custom RDP properties

単一のカスタム RDP プロパティを追加または編集する」の手順に従って個々のカスタム RDP プロパティを既定値にリセットすることも、次の PowerShell コマンドレットを実行してホスト プールのすべてのカスタム RDP プロパティをリセットすることもできます。You can reset individual custom RDP properties to their default values by following the instructions in Add or edit a single custom RDP property, or you can reset all custom RDP properties for a host pool by running the following PowerShell cmdlet:

Update-AzWvdHostPool -ResourceGroupName <resourcegroupname> -Name <hostpoolname> -CustomRdpProperty ""

設定が正常に削除されたことを確認するには、次のコマンドレットを入力します。To make sure you've successfully removed the setting, enter this cmdlet:

Get-AzWvdHostPool -ResourceGroupName <resourcegroupname> -Name <hostpoolname> | format-list Name, CustomRdpProperty

Name              : <hostpoolname>
CustomRdpProperty : <CustomRDPpropertystring>

次のステップNext steps

特定のホスト プールの RDP プロパティをカスタマイズしたので、Windows Virtual Desktop クライアントにサインインして、それらをユーザー セッションの一部としてテストできます。Now that you've customized the RDP properties for a given host pool, you can sign in to a Windows Virtual Desktop client to test them as part of a user session. 次の攻略ガイドでは、選択したクライアントを使用してセッションに接続する方法を説明します。These next how-to guides will tell you how to connect to a session using the client of your choice: