Skip to content

Get-AzWvdSessionHostSingleRegistrationToken.md

Latest commit

 

History

History
249 lines (195 loc) · 5.96 KB

Get-AzWvdSessionHostSingleRegistrationToken.md

File metadata and controls

249 lines (195 loc) · 5.96 KB
Raw
external help file
Module Name Az.DesktopVirtualization
online version https://learn.microsoft.com/powershell/module/az.desktopvirtualization/get-azwvdsessionhostsingleregistrationtoken
schema 2.0.0

Get-AzWvdSessionHostSingleRegistrationToken

SYNOPSIS

Operation to list the scoped RegistrationTokens associated with the SessionHost.

SYNTAX

ListExpanded (Default)

Get-AzWvdSessionHostSingleRegistrationToken -HostPoolName <String> -ResourceGroupName <String>
 -SessionHostName <String> -ExpirationTimeInUtc <DateTime> [-SubscriptionId <String[]>]
 [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]

List

Get-AzWvdSessionHostSingleRegistrationToken -HostPoolName <String> -ResourceGroupName <String>
 -SessionHostName <String> -Body <IScopedRegistrationTokenProperties> [-SubscriptionId <String[]>]
 [-DefaultProfile <PSObject>] [-Confirm] [-WhatIf] [<CommonParameters>]

ListViaJsonFilePath

Get-AzWvdSessionHostSingleRegistrationToken -HostPoolName <String> -ResourceGroupName <String>
 -SessionHostName <String> -JsonFilePath <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>]
 [-Confirm] [-WhatIf] [<CommonParameters>]

ListViaJsonString

Get-AzWvdSessionHostSingleRegistrationToken -HostPoolName <String> -ResourceGroupName <String>
 -SessionHostName <String> -JsonString <String> [-SubscriptionId <String[]>] [-DefaultProfile <PSObject>]
 [-Confirm] [-WhatIf] [<CommonParameters>]

DESCRIPTION

Operation to list the scoped RegistrationTokens associated with the SessionHost.

EXAMPLES

Example 1: Get a scoped registration token for a SessionHost

Get-AzWvdSessionHostSingleRegistrationToken -ResourceGroupName resourceGroup1 `
                                             -HostPoolName hostPool1 `
                                             -SessionHostName sessionHost1.microsoft.com `
                                             -ExpirationTimeInUtc (Get-Date).ToUniversalTime().AddHours(2)
ExpirationTime              Token
--------------              -----
9/22/2008 2:01:54 PM        <registration token>

This command lists the scoped registration tokens associated with an Azure Virtual Desktop SessionHost, with a specified expiration time.

PARAMETERS

-Body

Request body for listing scoped registration tokens for a session host.

Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IScopedRegistrationTokenProperties
Parameter Sets: List
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-DefaultProfile

The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.

Type: System.Management.Automation.PSObject
Parameter Sets: (All)
Aliases: AzureRMContext, AzureCredential

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

-ExpirationTimeInUtc

Expiration time of the registration token in UTC.

Type: System.DateTime
Parameter Sets: ListExpanded
Aliases:

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

-HostPoolName

The name of the host pool within the specified resource group

Type: System.String
Parameter Sets: (All)
Aliases:

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

-JsonFilePath

Path of Json file supplied to the List operation

Type: System.String
Parameter Sets: ListViaJsonFilePath
Aliases:

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

-JsonString

Json string supplied to the List operation

Type: System.String
Parameter Sets: ListViaJsonString
Aliases:

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

-ResourceGroupName

The name of the resource group. The name is case insensitive.

Type: System.String
Parameter Sets: (All)
Aliases:

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

-SessionHostName

The name of the session host within the specified host pool

Type: System.String
Parameter Sets: (All)
Aliases:

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

-SubscriptionId

The ID of the target subscription. The value must be an UUID.

Type: System.String[]
Parameter Sets: (All)
Aliases:

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: cf

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Type: System.Management.Automation.SwitchParameter
Parameter Sets: (All)
Aliases: wi

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

CommonParameters

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

INPUTS

Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IScopedRegistrationTokenProperties

OUTPUTS

Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IRegistrationTokenList

NOTES

RELATED LINKS