Freigeben über


User Sessions - Send Message

Senden sie eine Nachricht an einen Benutzer.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage?api-version=2024-04-03

URI-Parameter

Name In Erforderlich Typ Beschreibung
hostPoolName
path True

string

minLength: 3
maxLength: 64
pattern: ^[A-Za-z0-9@.\-_ ]*$

Der Name des Hostpools innerhalb der angegebenen Ressourcengruppe

resourceGroupName
path True

string

minLength: 1
maxLength: 90

Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.

sessionHostName
path True

string

minLength: 3
maxLength: 48
pattern: ^[A-Za-z0-9@.\-_ ]*$

Der Name des Sitzungshosts innerhalb des angegebenen Hostpools

subscriptionId
path True

string (uuid)

Die ID des Zielabonnements. Der Wert muss eine UUID sein.

userSessionId
path True

string

minLength: 1
maxLength: 24

Der Name der Benutzersitzung innerhalb des angegebenen Sitzungshosts

api-version
query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungstext

Name Typ Beschreibung
messageBody

string

Nachrichtentext.

messageTitle

string

Der Titel der Nachricht.

Antworten

Name Typ Beschreibung
200 OK

Nachricht erfolgreich an Benutzersitzung gesendet.

Other Status Codes

CloudError

Automatisierungsfehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

UserSession_SendMessage_Post

Beispielanforderung

POST https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com/userSessions/1/sendMessage?api-version=2024-04-03

{
  "messageTitle": "title",
  "messageBody": "body"
}

Beispiel für eine Antwort

Definitionen

Name Beschreibung
CloudError

Cloudfehlerobjekt.

CloudErrorProperties

Eigenschaften des Cloudfehlerobjekts.

SendMessage

Stellt die an eine UserSession gesendete Nachricht dar.

CloudError

Cloudfehlerobjekt.

Name Typ Beschreibung
error

CloudErrorProperties

Eigenschaften des Cloudfehlerobjekts.

CloudErrorProperties

Eigenschaften des Cloudfehlerobjekts.

Name Typ Beschreibung
code

string

Fehlercode

message

string

Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

SendMessage

Stellt die an eine UserSession gesendete Nachricht dar.

Name Typ Beschreibung
messageBody

string

Nachrichtentext.

messageTitle

string

Der Titel der Nachricht.