Skip to content

Send-AzWvdUserSessionMessage.md

Latest commit

 

History

History
364 lines (288 loc) · 9.11 KB

Send-AzWvdUserSessionMessage.md

File metadata and controls

364 lines (288 loc) · 9.11 KB
Raw
external help file
Module Name Az.DesktopVirtualization
online version https://learn.microsoft.com/powershell/module/az.desktopvirtualization/send-azwvdusersessionmessage
schema 2.0.0

Send-AzWvdUserSessionMessage

SYNOPSIS

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] [-Confirm] [-WhatIf] [<CommonParameters>]

SendViaIdentityExpanded

Send-AzWvdUserSessionMessage -InputObject <IDesktopVirtualizationIdentity> [-MessageBody <String>]
 [-MessageTitle <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]

SendViaIdentityHostPool

Send-AzWvdUserSessionMessage -HostPoolInputObject <IDesktopVirtualizationIdentity> -SessionHostName <String>
 -UserSessionId <String> -SendMessage <ISendMessage> [-DefaultProfile <PSObject>] [-PassThru] [-Confirm]
 [-WhatIf] [<CommonParameters>]

SendViaIdentityHostPoolExpanded

Send-AzWvdUserSessionMessage -HostPoolInputObject <IDesktopVirtualizationIdentity> -SessionHostName <String>
 -UserSessionId <String> [-MessageBody <String>] [-MessageTitle <String>] [-DefaultProfile <PSObject>]
 [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]

SendViaIdentitySessionHost

Send-AzWvdUserSessionMessage -SessionHostInputObject <IDesktopVirtualizationIdentity> -UserSessionId <String>
 -SendMessage <ISendMessage> [-DefaultProfile <PSObject>] [-PassThru] [-Confirm] [-WhatIf]
 [<CommonParameters>]

SendViaIdentitySessionHostExpanded

Send-AzWvdUserSessionMessage -SessionHostInputObject <IDesktopVirtualizationIdentity> -UserSessionId <String>
 [-MessageBody <String>] [-MessageTitle <String>] [-DefaultProfile <PSObject>] [-PassThru] [-Confirm]
 [-WhatIf] [<CommonParameters>]

SendViaJsonFilePath

Send-AzWvdUserSessionMessage -HostPoolName <String> -ResourceGroupName <String> -SessionHostName <String>
 -UserSessionId <String> -JsonFilePath <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>]
 [-PassThru] [-Confirm] [-WhatIf] [<CommonParameters>]

SendViaJsonString

Send-AzWvdUserSessionMessage -HostPoolName <String> -ResourceGroupName <String> -SessionHostName <String>
 -UserSessionId <String> -JsonString <String> [-SubscriptionId <String>] [-DefaultProfile <PSObject>]
 [-PassThru] [-Confirm] [-WhatIf] [<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

-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

-HostPoolInputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity
Parameter Sets: SendViaIdentityHostPool, SendViaIdentityHostPoolExpanded
Aliases:

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

-HostPoolName

The name of the host pool within the specified resource group

Type: System.String
Parameter Sets: SendExpanded, SendViaJsonFilePath, SendViaJsonString
Aliases:

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

-InputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity
Parameter Sets: SendViaIdentityExpanded
Aliases:

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

-JsonFilePath

Path of Json file supplied to the Send operation

Type: System.String
Parameter Sets: SendViaJsonFilePath
Aliases:

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

-JsonString

Json string supplied to the Send operation

Type: System.String
Parameter Sets: SendViaJsonString
Aliases:

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

-MessageBody

Body of message.

Type: System.String
Parameter Sets: SendExpanded, SendViaIdentityExpanded, SendViaIdentityHostPoolExpanded, SendViaIdentitySessionHostExpanded
Aliases:

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

-MessageTitle

Title of message.

Type: System.String
Parameter Sets: SendExpanded, SendViaIdentityExpanded, SendViaIdentityHostPoolExpanded, SendViaIdentitySessionHostExpanded
Aliases:

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

-PassThru

Returns true when the command succeeds

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

Required: False
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: SendExpanded, SendViaJsonFilePath, SendViaJsonString
Aliases:

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

-SendMessage

Represents message sent to a UserSession.

Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.ISendMessage
Parameter Sets: SendViaIdentityHostPool, SendViaIdentitySessionHost
Aliases:

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

-SessionHostInputObject

Identity Parameter

Type: Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.IDesktopVirtualizationIdentity
Parameter Sets: SendViaIdentitySessionHost, SendViaIdentitySessionHostExpanded
Aliases:

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

-SessionHostName

The name of the session host within the specified host pool

Type: System.String
Parameter Sets: SendExpanded, SendViaIdentityHostPool, SendViaIdentityHostPoolExpanded, SendViaJsonFilePath, SendViaJsonString
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: SendExpanded, SendViaJsonFilePath, SendViaJsonString
Aliases:

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

-UserSessionId

The name of the user session within the specified session host

Type: System.String
Parameter Sets: SendExpanded, SendViaIdentityHostPool, SendViaIdentityHostPoolExpanded, SendViaIdentitySessionHost, SendViaIdentitySessionHostExpanded, SendViaJsonFilePath, SendViaJsonString
Aliases:

Required: True
Position: Named
Default value: None
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.IDesktopVirtualizationIdentity

Microsoft.Azure.PowerShell.Cmdlets.DesktopVirtualization.Models.ISendMessage

OUTPUTS

System.Boolean

NOTES

RELATED LINKS