Send-RdsUserSessionMessage

Modulo:

Microsoft.RDInfra.RDPowershell Module

Invia un messaggio di sistema a una sessione utente.

Sintassi

Default (impostazione predefinita).

Send-RdsUserSessionMessage
    [-TenantName] <String>
    [-HostPoolName] <String>
    [-SessionHostName] <String>
    [-SessionId] <Int32>
    [-MessageTitle] <String>
    [-MessageBody] <String>
    [-NoUserPrompt]
    [<CommonParameters>]

Descrizione

Il cmdlet Send-RdsUserSessionmessage invia un messaggio di sistema a una sessione utente specificata. Poiché l'ID sessione utente è univoco solo nel contesto di un host di sessione, un server host di sessione diverso può condividere lo stesso ID sessione utente. L'host della sessione e l'ID sessione specificati utilizzando questo cmdlet identificano in modo univoco una sessione all'interno di un pool di host. Se l'ID sessione non è presente, il messaggio viene trasmesso a tutte le sessioni utente sull'host della sessione.

Esempio

Esempio 1: Inviare un messaggio a una sessione utente fornendo tutte le informazioni necessarie

PS C:\> Send-RdsUserSessionMessage -TenantName "contoso" -HostPoolName "contosoHostPool" -SessionHostName "sh1.contoso.com" -SessionId 1 -MessageTitle "Test announcement" -MessageBody "Test message."

Questo comando invia un messaggio alla sessione utente specificata. Questo comando richiede che l'utente abbia cercato la sessione utente in precedenza per fornire tutte le informazioni richieste. Eseguendo il cmdlet Send-RdsUserSessionMessage senza l'opzione NoUserPrompt, verrà chiesto di confermare l'invio del messaggio.

Esempio 2: Inviare un messaggio a un utente cercando la sua sessione utente

PS C:\> Get-RdsUserSession -TenantName "contoso" -HostPoolName "contosoHostPool" | where { $_.UserPrincipalName -eq "contoso\user1" } | Send-RdsUserSessionMessage -MessageTitle "Test announcement" -MessageBody "Test message." -NoUserPrompt

Questo comando utilizza il cmdlet Get-RdsUserSession per cercare la sessione dell'utente specifico, quindi lo reindirizza al cmdlet Send-RdsUserSessionMessage per inviare un messaggio alla sessione utente. Eseguendo il cmdlet Send-RdsUserSessionMessage con l'opzione NoUserPrompt, non si riceverà alcuna richiesta aggiuntiva per confermare l'invio del messaggio.

Parametri

-HostPoolName

Nome del pool di host.

Proprietà dei parametri

Tipo:	String
Valore predefinito:	None
Supporta i caratteri jolly:	False
DontShow:	False

Set di parametri

(All)

Posizione:	1
Obbligatorio:	True
Valore dalla pipeline:	True
Valore dalla pipeline in base al nome della proprietà:	True
Valore dagli argomenti rimanenti:	False

-MessageBody

Il corpo del messaggio che si desidera inviare alla sessione utente.

Proprietà dei parametri

Tipo:	String
Valore predefinito:	None
Supporta i caratteri jolly:	False
DontShow:	False

Set di parametri

(All)

Posizione:	5
Obbligatorio:	True
Valore dalla pipeline:	True
Valore dalla pipeline in base al nome della proprietà:	True
Valore dagli argomenti rimanenti:	False

-MessageTitle

Il titolo del messaggio che si desidera inviare alla sessione utente.

Proprietà dei parametri

Tipo:	String
Valore predefinito:	None
Supporta i caratteri jolly:	False
DontShow:	False

Set di parametri

(All)

Posizione:	4
Obbligatorio:	True
Valore dalla pipeline:	True
Valore dalla pipeline in base al nome della proprietà:	True
Valore dagli argomenti rimanenti:	False

-NoUserPrompt

L'interruttore indica che si desidera disconnettere l'utente senza alcuna conferma aggiuntiva.

Proprietà dei parametri

Tipo:	SwitchParameter
Valore predefinito:	None
Supporta i caratteri jolly:	False
DontShow:	False

Set di parametri

(All)

Posizione:	Named
Obbligatorio:	False
Valore dalla pipeline:	False
Valore dalla pipeline in base al nome della proprietà:	False
Valore dagli argomenti rimanenti:	False

-SessionHostName

Nome dell'host della sessione.

Proprietà dei parametri

Tipo:	String
Valore predefinito:	None
Supporta i caratteri jolly:	False
DontShow:	False

Set di parametri

(All)

Posizione:	2
Obbligatorio:	True
Valore dalla pipeline:	True
Valore dalla pipeline in base al nome della proprietà:	True
Valore dagli argomenti rimanenti:	False

-SessionId

L'ID sessione correlato alla sessione utente che riceverà il messaggio.

Proprietà dei parametri

Tipo:	Int32
Valore predefinito:	None
Supporta i caratteri jolly:	False
DontShow:	False

Set di parametri

(All)

Posizione:	3
Obbligatorio:	True
Valore dalla pipeline:	True
Valore dalla pipeline in base al nome della proprietà:	True
Valore dagli argomenti rimanenti:	False

-TenantName

Nome del tenant.

Proprietà dei parametri

Tipo:	String
Valore predefinito:	None
Supporta i caratteri jolly:	False
DontShow:	False

Set di parametri

(All)

Posizione:	0
Obbligatorio:	True
Valore dalla pipeline:	True
Valore dalla pipeline in base al nome della proprietà:	True
Valore dagli argomenti rimanenti:	False

CommonParameters

Questo cmdlet supporta i parametri comuni: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Per altre informazioni, vedi about_CommonParameters.

Input

System.String

System.Int32

Output

System.Object