Session Hosts - Get

Dienst:: Desktop Virtualization

API-Version:: 2025-10-10

Holen Sie sich einen Sitzungshost.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}?api-version=2025-10-10

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. Für den 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)	Hierbei handelt es sich um die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	SessionHost	Sitzungshost erfolgreich abgerufen.
Other Status Codes	CloudError	Automatisierungsfehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

SessionHost_Get

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com?api-version=2025-10-10

Beispiel für eine Antwort

Statuscode:: 200

{
  "name": "sessionHost1.microsoft.com",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHosts/sessionHost1.microsoft.com",
  "type": "Microsoft.DesktopVirtualization/hostPools/sessionHosts",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "objectId": "7877fb31-4bde-49fd-9df3-c046e0ec5325",
    "lastHeartBeat": "2008-09-22T14:01:54.9571247Z",
    "sessions": 1,
    "agentVersion": "1.0.0.1391",
    "allowNewSession": true,
    "assignedUser": "user1@microsoft.com",
    "status": "Available",
    "statusTimestamp": "2008-09-22T14:01:54.9571247Z",
    "osVersion": "10.0.17763",
    "sxSStackVersion": "rdp-sxs190816002",
    "updateState": "Succeeded",
    "lastUpdateTime": "2008-09-22T14:01:54.9571247Z",
    "updateErrorMessage": "",
    "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef",
    "friendlyName": "friendly",
    "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1",
    "sessionHostHealthCheckResults": [
      {
        "healthCheckName": "DomainJoinedCheck",
        "healthCheckResult": "HealthCheckSucceeded",
        "additionalFailureDetails": {
          "message": "SessionHost healthy: is joined to domain ≤wvdarmtest1.net≥",
          "errorCode": 0,
          "lastHealthCheckDateTime": "2021-01-14T02:09:37.6236843Z"
        }
      }
    ]
  }
}

Definitionen

Name	Beschreibung
CloudError	Cloud-Fehlerobjekt.
CloudErrorProperties	Eigenschaften des Cloud-Fehlerobjekts.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
HealthCheckName	Stellt den Namen des ausgeführten Zustandsprüfungsvorgangs dar.
HealthCheckResult	Stellt den Integritätsstatus der von uns durchgeführten Zustandsprüfung dar.
SessionHost	Stellt eine SessionHost-Definition dar.
SessionHostHealthCheckFailureDetails	Enthält Details zum Fehler.
SessionHostHealthCheckReport	Der Bericht für Informationen zum Sitzungshost.
Status	Status für einen SessionHost.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UpdateState	Aktualisieren Sie den Status eines SessionHosts.

CloudError

Objekt

Cloud-Fehlerobjekt.

Name	Typ	Beschreibung
error	CloudErrorProperties	Eigenschaften des Cloud-Fehlerobjekts.

CloudErrorProperties

Objekt

Eigenschaften des Cloud-Fehlerobjekts.

Name	Typ	Beschreibung
code	string	Fehlercode
message	string	Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

HealthCheckName

Enumeration

Stellt den Namen des ausgeführten Zustandsprüfungsvorgangs dar.

Wert	Beschreibung
DomainJoinedCheck	Überprüft, ob der SessionHost mit einer Domäne verbunden ist. Wenn diese Überprüfung fehlschlägt, wird dies als schwerwiegend eingestuft, da keine Verbindung hergestellt werden kann, wenn der SessionHost nicht mit der Domäne verbunden ist. (Derzeit aktiviert)
DomainTrustCheck	Überprüft, ob auf dem SessionHost keine Probleme mit der Domänenvertrauensstellung auftreten, die die Authentifizierung auf SessionHost zum Zeitpunkt der Verbindungserstellung verhindern. Wenn diese Überprüfung fehlschlägt, wird dies als schwerwiegend eingestuft, da keine Verbindung erfolgreich sein kann, wenn wir die Domäne für die Authentifizierung auf dem SessionHost nicht erreichen können. (Derzeit aktiviert)
FSLogixHealthCheck	Überprüft, ob der FSLogix-Dienst aktiv ist, um sicherzustellen, dass die Benutzerprofile in der Sitzung geladen werden. Wenn diese Überprüfung fehlschlägt, wird sie als schwerwiegend eingestuft, da selbst wenn die Verbindung erfolgreich hergestellt werden kann, die Benutzererfahrung schlecht ist, da das Benutzerprofil nicht geladen werden kann und der Benutzer in der Sitzung ein temporäres Profil erhält. (Derzeit deaktiviert)
SxSStackListenerCheck	Überprüft, ob der SxS-Stack betriebsbereit ist, damit Verbindungen erfolgreich hergestellt werden können. Wenn diese Prüfung fehlschlägt, wird dies als schwerwiegend eingestuft, da keine Verbindung hergestellt werden kann, wenn der SxS-Stack nicht bereit ist. (Derzeit aktiviert)
UrlsAccessibleCheck	Überprüft, ob der erforderliche WVD-Dienst und die Genf-URLs über den SessionHost erreichbar sind. Diese URLs sind: RdTokenUri, RdBrokerURI, RdDiagnosticsUri und Speicherblob-URLs für die Agent-Überwachung (Genf). Wenn diese Prüfung fehlschlägt, sie nicht schwerwiegend ist und der Computer weiterhin Verbindungen bedienen kann, kann das Hauptproblem darin bestehen, dass der Überwachungsagent keine Warmpfaddaten (Protokolle, Vorgänge ...) speichern kann. (Derzeit deaktiviert)
MonitoringAgentCheck	Überprüft, ob der erforderliche Geneva-Agent ausgeführt wird. Wenn diese Prüfung fehlschlägt, ist sie nicht schwerwiegend und der Computer kann weiterhin Verbindungen bedienen. Das Hauptproblem kann darin bestehen, dass der Überwachungsagent fehlt oder (möglicherweise) eine ältere Version ausführt. (Derzeit aktiviert)
DomainReachable	Überprüft, ob die Domäne, der der SessionHost beigetreten ist, weiterhin erreichbar ist. Wenn diese Überprüfung fehlschlägt, wird dies als schwerwiegend eingestuft, da keine Verbindung hergestellt werden kann, wenn die Domäne, der der SessionHost beigetreten ist, zum Zeitpunkt der Verbindung nicht erreichbar ist. (Derzeit deaktiviert)
WebRTCRedirectorCheck	Überprüft, ob die WebRTCRedirector-Komponente fehlerfrei ist. Die WebRTCRedirector-Komponente wird verwendet, um die Video- und Audioleistung in Microsoft Teams zu optimieren. Dadurch wird geprüft, ob die Komponente noch läuft und ob eine höhere Version verfügbar ist. Wenn diese Prüfung fehlschlägt, sie nicht schwerwiegend ist und der Computer weiterhin Verbindungen bedienen kann, besteht das Hauptproblem möglicherweise darin, dass die WebRTCRedirector-Komponente neu gestartet oder aktualisiert werden muss. (Derzeit deaktiviert)
SupportedEncryptionCheck	Überprüft den Wert des SecurityLayer-Registrierungsschlüssels. Wenn der Wert 0 (SecurityLayer.RDP) ist, schlägt diese Überprüfung mit Fehlercode = NativeMethodErrorCode.E_FAIL fehl und ist schwerwiegend. Wenn der Wert 1 (SecurityLayer.Negotiate) ist, schlägt diese Überprüfung mit Fehlercode = NativeMethodErrorCode.ERROR_SUCCESS fehl und ist nicht schwerwiegend. (Derzeit deaktiviert)
MetaDataServiceCheck	Überprüft, ob auf den Metadatendienst zugegriffen werden kann, und gibt Computeeigenschaften zurück. (Derzeit aktiviert)
AppAttachHealthCheck	Überprüft, ob der AppAttachService fehlerfrei ist (es gab keine Probleme beim Paketstaging). Der AppAttachService wird verwendet, um das Staging/Registrierung (und gegebenenfalls die Deregistrierung/Detaging) von vom Mieteradministrator eingerichteten MSIX-Apps zu ermöglichen. Dies prüft, ob die Komponente während des Paketstagings Fehler hatte. Fehler beim Staging verhindern, dass einige MSIX-Apps für den Endbenutzer ordnungsgemäß funktionieren. Wenn diese Prüfung fehlschlägt, ist sie nicht schwerwiegend und der Computer kann weiterhin Verbindungen bedienen, kann das Hauptproblem darin bestehen, dass bestimmte Apps für Endbenutzer nicht funktionieren. (Derzeit aktiviert)

HealthCheckResult

Enumeration

Stellt den Integritätsstatus der von uns durchgeführten Zustandsprüfung dar.

Wert	Beschreibung
Unknown	Das Ergebnis der Gesundheitsprüfung ist derzeit nicht bekannt.
HealthCheckSucceeded	Gesundheitscheck bestanden.
HealthCheckFailed	Fehler bei der Zustandsprüfung.
SessionHostShutdown	Wir haben eine Benachrichtigung über das Herunterfahren erhalten.

SessionHost

Objekt

Stellt eine SessionHost-Definition dar.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Der Name der Ressource
properties.agentVersion	string	Version des Agents auf SessionHost.
properties.allowNewSession	boolean	Erlauben Sie eine neue Sitzung.
properties.assignedUser	string	Benutzer, der SessionHost zugewiesen ist.
properties.friendlyName	string	Anzeigename von SessionHost
properties.lastHeartBeat	string (date-time)	Letzter Herzschlag von SessionHost.
properties.lastUpdateTime	string (date-time)	Der Zeitstempel der letzten Aktualisierung.
properties.objectId	string	ObjectId von SessionHost. (interne Anwendung)
properties.osVersion	string	Die Version des Betriebssystems auf dem Sitzungshost.
properties.resourceId	string	Ressourcen-ID des zugrunde liegenden virtuellen Computers von SessionHost.
properties.sessionHostHealthCheckResults	SessionHostHealthCheckReport[]	Liste der SessionHostHealthCheckReports
properties.sessions	integer (int32)	Anzahl der Sitzungen auf SessionHost.
properties.status	Status	Status für einen SessionHost.
properties.statusTimestamp	string (date-time)	Der Zeitstempel des Status.
properties.sxSStackVersion	string	Die Version des parallelen Stacks auf dem Sitzungshost.
properties.updateErrorMessage	string	Die Fehlermeldung.
properties.updateState	UpdateState	Aktualisieren Sie den Status eines SessionHosts.
properties.virtualMachineId	string	VM-ID des zugrunde liegenden virtuellen Computers von SessionHost.
systemData	systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SessionHostHealthCheckFailureDetails

Objekt

Enthält Details zum Fehler.

Name	Typ	Beschreibung
errorCode	integer (int32)	Fehlercode, der dem Fehler entspricht.
lastHealthCheckDateTime	string (date-time)	Der Zeitstempel der letzten Aktualisierung.
message	string	Fehlermeldung: Hinweise darauf, was falsch ist und wie eine Wiederherstellung möglich ist.

SessionHostHealthCheckReport

Objekt

Der Bericht für Informationen zum Sitzungshost.

Name	Typ	Beschreibung
additionalFailureDetails	SessionHostHealthCheckFailureDetails	Zusätzliche detaillierte Informationen zum Fehler.
healthCheckName	HealthCheckName	Stellt den Namen des ausgeführten Zustandsprüfungsvorgangs dar.
healthCheckResult	HealthCheckResult	Stellt den Integritätsstatus der von uns durchgeführten Zustandsprüfung dar.

Status

Enumeration

Status für einen SessionHost.

Wert	Beschreibung
Available	Session Host hat alle Zustandsprüfungen bestanden und steht für die Verarbeitung von Verbindungen zur Verfügung.
Unavailable	Der Sitzungshost ist entweder ausgeschaltet oder hat kritische Zustandsprüfungen nicht bestanden, was dazu führt, dass der Dienst keine Verbindungen zu diesem Sitzungshost weiterleiten kann. Beachten Sie, dass dies den vorherigen Status "NoHeartBeat" ersetzt.
Shutdown	Sitzungshost wird heruntergefahren – Der RD-Agent hat gemeldet, dass der Sitzungshost beendet oder die Zuordnung aufgehoben wurde.
Disconnected	Der Sitzungshost ist nicht verfügbar, da er derzeit nicht verbunden ist.
Upgrading	Der Sitzungshost ist nicht verfügbar, da derzeit ein Upgrade von RDAgent/Side-by-Side-Stack ausgeführt wird. Hinweis: Dieser Status wird entfernt, sobald das Upgrade abgeschlossen ist und der Host Verbindungen akzeptieren kann.
UpgradeFailed	Der Sitzungshost ist nicht verfügbar, da das Upgrade der kritischen Komponente (Agent, Side-by-Side-Stack usw.) fehlgeschlagen ist.
NoHeartbeat	Der Session Host schlägt nicht mit Herz.
NotJoinedToDomain	SessionHost ist nicht mit der Domäne verbunden.
DomainTrustRelationshipLost	Die Domänenvertrauensstellung von SessionHost geht verloren
SxSStackListenerNotReady	Der auf dem SessionHost installierte SxS-Stack ist nicht bereit, Verbindungen zu empfangen.
FSLogixNotHealthy	FSLogix befindet sich auf dem Sitzungshost in einem fehlerhaften Zustand.
NeedsAssistance	Neuer Status, um Administratoren darüber zu informieren, dass der Zustand auf ihrem Endpunkt behoben werden muss. Die Verbindungen schlagen möglicherweise nicht fehl, da diese Probleme nicht schwerwiegend sind.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UpdateState

Enumeration

Aktualisieren Sie den Status eines SessionHosts.

Wert	Beschreibung
Initial
Pending
Started
Succeeded
Failed

Freigeben über

Session Hosts - Get

URI-Parameter

Antworten

Beispiele

SessionHost_Get

Beispielanforderung

Beispiel für eine Antwort

Definitionen

CloudError

CloudErrorProperties

createdByType

HealthCheckName

HealthCheckResult

SessionHost

SessionHostHealthCheckFailureDetails

SessionHostHealthCheckReport

Status

systemData

UpdateState