Send-AzWvdUserSessionMessage
Send a message to a user.
Syntax
SendExpanded (Default)
Send-AzWvdUserSessionMessage
-HostPoolName <String>
-ResourceGroupName <String>
-SessionHostName <String>
-UserSessionId <String>
[-SubscriptionId <String>]
[-MessageBody <String>]
[-MessageTitle <String>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SendViaJsonString
Send-AzWvdUserSessionMessage
-HostPoolName <String>
-ResourceGroupName <String>
-SessionHostName <String>
-UserSessionId <String>
-JsonString <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SendViaJsonFilePath
Send-AzWvdUserSessionMessage
-HostPoolName <String>
-ResourceGroupName <String>
-SessionHostName <String>
-UserSessionId <String>
-JsonFilePath <String>
[-SubscriptionId <String>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SendViaIdentityHostPoolExpanded
Send-AzWvdUserSessionMessage
-SessionHostName <String>
-UserSessionId <String>
-HostPoolInputObject <IDesktopVirtualizationIdentity>
[-MessageBody <String>]
[-MessageTitle <String>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SendViaIdentityHostPool
Send-AzWvdUserSessionMessage
-SessionHostName <String>
-UserSessionId <String>
-HostPoolInputObject <IDesktopVirtualizationIdentity>
-SendMessage <ISendMessage>
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SendViaIdentitySessionHostExpanded
Send-AzWvdUserSessionMessage
-UserSessionId <String>
-SessionHostInputObject <IDesktopVirtualizationIdentity>
[-MessageBody <String>]
[-MessageTitle <String>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SendViaIdentitySessionHost
Send-AzWvdUserSessionMessage
-UserSessionId <String>
-SessionHostInputObject <IDesktopVirtualizationIdentity>
-SendMessage <ISendMessage>
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SendViaIdentityExpanded
Send-AzWvdUserSessionMessage
-InputObject <IDesktopVirtualizationIdentity>
[-MessageBody <String>]
[-MessageTitle <String>]
[-DefaultProfile <PSObject>]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Send a message to a user.
Examples
Example 1: Send a message to UserSession
Send-AzWvdUserSessionMessage -ResourceGroupName ResourceGroupName `
-HostPoolName HostPoolName `
-SessionHostName SessionHostName `
-UserSessionId 4 `
-MessageBody 'Some Message' `
-MessageTitle 'Some Title'
This command sends a message to a UserSession.
Parameters
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: cf
Parameter sets
(All)
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-DefaultProfile
The DefaultProfile parameter is not functional.
Use the SubscriptionId parameter when available if executing the cmdlet against a different subscription.
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
Identity Parameter
SendViaIdentityHostPoolExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentityHostPool
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-HostPoolName
The name of the host pool within the specified resource group
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SendExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
SendViaIdentityExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-JsonFilePath
Path of Json file supplied to the Send operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SendViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-JsonString
Json string supplied to the Send operation
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SendViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MessageBody
Body of message.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SendExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentityHostPoolExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentitySessionHostExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-MessageTitle
Title of message.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SendExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentityHostPoolExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentitySessionHostExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentityExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-PassThru
Returns true when the command succeeds
Parameter properties
Type: SwitchParameter
Default value: None 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
-ResourceGroupName
The name of the resource group.
The name is case insensitive.
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SendExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SendMessage
Represents message sent to a UserSession.
Parameter properties
Type: ISendMessage
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SendViaIdentityHostPool
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentitySessionHost
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
Identity Parameter
SendViaIdentitySessionHostExpanded
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentitySessionHost
Position: Named Mandatory: True Value from pipeline: True Value from pipeline by property name: False Value from remaining arguments: False
-SessionHostName
The name of the session host within the specified host pool
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SendExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentityHostPoolExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentityHostPool
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-SubscriptionId
The ID of the target subscription.
The value must be an UUID.
Parameter properties
Type: String
Default value: (Get-AzContext).Subscription.Id Supports wildcards: False DontShow: False
Parameter sets
SendExpanded
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaJsonString
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaJsonFilePath
Position: Named Mandatory: False Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-UserSessionId
The name of the user session within the specified session host
Parameter properties
Type: String
Default value: None Supports wildcards: False DontShow: False
Parameter sets
SendExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaJsonString
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaJsonFilePath
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentityHostPoolExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentityHostPool
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentitySessionHostExpanded
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
SendViaIdentitySessionHost
Position: Named Mandatory: True Value from pipeline: False Value from pipeline by property name: False Value from remaining arguments: False
-WhatIf
Shows what would happen if the cmdlet runs.
The cmdlet is not run.
Parameter properties
Type: SwitchParameter
Default value: None Supports wildcards: False DontShow: False Aliases: wi
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