Edit

Share via

Get-AzureRemoteAppSession

  • Reference
Module:
Azure

Lists all active and disconnected Azure RemoteApp sessions for a collection.

Note

The cmdlets referenced in this documentation are for managing legacy Azure resources that use Azure Service Manager (ASM) APIs. This legacy PowerShell module isn't recommended when creating new resources since ASM is scheduled for retirement. For more information, see Azure Service Manager retirement.

The Az PowerShell module is the recommended PowerShell module for managing Azure Resource Manager (ARM) resources with PowerShell.

Syntax

Get-AzureRemoteAppSession
   [-CollectionName] <String>
   [[-UserUpn] <String>]
   [-Profile <AzureSMProfile>]
   [<CommonParameters>]

Description

The Get-AzureRemoteAppSession cmdlet lists all active and disconnected Azure RemoteApp sessions for an Azure RemoteApp collection.

Examples

Example 1: List all the sessions in a collection

PS C:\> Get-AzureRemoteAppSession -CollectionName "ContosoApps"

This command lists all sessions in the Azure RemoteApp collection named ContosoApps.

Parameters

-CollectionName

Specifies the name of the Azure RemoteApp collection.

Type:String
Aliases:Name
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Profile

Specifies the Azure profile from which this cmdlet reads. If you do not specify a profile, this cmdlet reads from the local default profile.

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

-UserUpn

Specifies the user Principal Name (UPN) of a user for which to get Azure RemoteApp sessions. For example, the UPN can be in the following format: [email protected].

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