Get-AzWvdRegistrationInfo

Reference

Module:: Az.DesktopVirtualization

Get the Windows virtual desktop registration info.

Syntax

Get-AzWvdRegistrationInfo
   -ResourceGroupName <String>
   -HostPoolName <String>
   [-SubscriptionId <String>]
   [-DefaultProfile <PSObject>]
   [<CommonParameters>]

Description

Get the Windows virtual desktop registration info.

Examples

Example 1: Get Existing Registration Info from Hostpool

Get-AzWvdRegistrationInfo -ResourceGroupName rgName -HostPoolName hpName

ExpirationTime        RegistrationTokenOperation Token
--------------        -------------------------- -----
5/10/2023 12:00:00 PM None                       <base64 encoded string>

Retrieves Registration Info for the chosen hostpool.

Example 2: Get Empty Registration Info from HostPool

Get-AzWvdRegistrationInfo -ResourceGroupName rgName -HostPoolname hpName

ExpirationTime RegistrationTokenOperation Token
-------------- -------------------------- -----
               None

Returns an empty Registration Info for the chosen Hostpool if the Hostpool doesn't have any Registration Info.

Parameters

-DefaultProfile

The credentials, account, tenant, and subscription used for communication with Azure.

Type:	PSObject
Aliases:	AzureRMContext, AzureCredential
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-HostPoolName

Host Pool Name

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-ResourceGroupName

Resource Group Name

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-SubscriptionId

Subscription Id

Type:	String
Position:	Named
Default value:	(Get-AzContext).Subscription.Id
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

Outputs

RegistrationInfo

Share via