Send-AzWvdUserSessionMessage
Send a message to a user.
Send-AzWvdUserSessionMessage
-HostPoolName <String>
-ResourceGroupName <String>
-SessionHostName <String>
[-SubscriptionId <String>]
-UserSessionId <String>
[-MessageBody <String>]
[-MessageTitle <String>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Send-AzWvdUserSessionMessage
-HostPoolName <String>
-ResourceGroupName <String>
-SessionHostName <String>
[-SubscriptionId <String>]
-UserSessionId <String>
-JsonString <String>
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Send-AzWvdUserSessionMessage
-HostPoolName <String>
-ResourceGroupName <String>
-SessionHostName <String>
[-SubscriptionId <String>]
-UserSessionId <String>
-JsonFilePath <String>
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Send-AzWvdUserSessionMessage
-SessionHostName <String>
-UserSessionId <String>
-HostPoolInputObject <IDesktopVirtualizationIdentity>
[-MessageBody <String>]
[-MessageTitle <String>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Send-AzWvdUserSessionMessage
-SessionHostName <String>
-UserSessionId <String>
-HostPoolInputObject <IDesktopVirtualizationIdentity>
-SendMessage <ISendMessage>
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Send-AzWvdUserSessionMessage
-UserSessionId <String>
-SessionHostInputObject <IDesktopVirtualizationIdentity>
[-MessageBody <String>]
[-MessageTitle <String>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Send-AzWvdUserSessionMessage
-UserSessionId <String>
-SessionHostInputObject <IDesktopVirtualizationIdentity>
-SendMessage <ISendMessage>
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Send-AzWvdUserSessionMessage
-InputObject <IDesktopVirtualizationIdentity>
[-MessageBody <String>]
[-MessageTitle <String>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Send a message to a user.
Send-AzWvdUserSessionMessage -ResourceGroupName ResourceGroupName `
-HostPoolName HostPoolName `
-SessionHostName SessionHostName `
-UserSessionId 4 `
-MessageBody 'Some Message' `
-MessageTitle 'Some Title'
This command sends a message to a UserSession.
Prompts you for confirmation before running the cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The DefaultProfile parameter is not functional. Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
Type: | PSObject |
Aliases: | AzureRMContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Identity Parameter
Type: | IDesktopVirtualizationIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
The name of the host pool within the specified resource group
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Identity Parameter
Type: | IDesktopVirtualizationIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Path of Json file supplied to the Send operation
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Json string supplied to the Send operation
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Body of message.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Title of message.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Returns true when the command succeeds
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The name of the resource group. The name is case insensitive.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Represents message sent to a UserSession.
Type: | ISendMessage |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
Identity Parameter
Type: | IDesktopVirtualizationIdentity |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
The name of the session host within the specified host pool
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The ID of the target subscription. The value must be an UUID.
Type: | String |
Position: | Named |
Default value: | (Get-AzContext).Subscription.Id |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
The name of the user session within the specified session host
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Shows what would happen if the cmdlet runs. The cmdlet is not run.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Azure PowerShell feedback
Azure PowerShell is an open source project. Select a link to provide feedback: