Edit

Share via

Send-AzureRemoteAppSessionMessage

  • Reference
Module:
Azure

Sends a message to a user.

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

Send-AzureRemoteAppSessionMessage
    [-CollectionName] <String>
    [-UserUpn] <String>
    [-Message] <String>
    [-Profile <AzureSMProfile>]
    [<CommonParameters>]

Description

The Send-AzureRemoteAppSessionMessage cmdlet sends a message to a user who is connected to an Azure RemoteApp session.

Examples

Example 1: Send a message to a user

PS C:\> Send-AzureRemoteAppSessionMessage -CollectionName "ContosoApps" -UserUpn "PattiFuller@contoso.com" -Message "The system will be going down for maintenance soon.  Please save your work and close your RemoteApps."

This command sends a message to the user whose UPN is PattiFuller@contoso.com.

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

-Message

Specifies the message to send.

Type:String
Position:3
Default value:None
Required:True
Accept pipeline input:False
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 example, PattiFuller@contoso.com.

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