Edit

Share via

Get-AzWvdRegistrationInfo

Module:
Az.DesktopVirtualization Module

Get the Windows virtual desktop registration info.

Syntax

Default (Default) 

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.

Parameter properties

Type:PSObject
Default value:None
Supports wildcards:False
DontShow:False
Aliases:AzureRMContext, AzureCredential

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-HostPoolName

Host Pool Name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-ResourceGroupName

Resource Group Name

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SubscriptionId

Subscription Id

Parameter properties

Type:String
Default value:(Get-AzContext).Subscription.Id
Supports wildcards:False
DontShow:False

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

Outputs

RegistrationInfo