Freigeben über


Session Hosts - Get

Rufen Sie einen Sitzungshost ab.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
hostPoolName
path True

string

Der Name des Hostpools innerhalb der angegebenen Ressourcengruppe

resourceGroupName
path True

string

Der Name der Ressourcengruppe. Für den Namen wird die Groß-/Kleinschreibung nicht beachtet.

sessionHostName
path True

string

Der Name des Sitzungshosts innerhalb des angegebenen Hostpools

subscriptionId
path True

string

Hierbei handelt es sich um die ID des Zielabonnements.

api-version
query True

string

Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Antworten

Name Typ Beschreibung
200 OK

SessionHost

Sitzungshost wurde erfolgreich abgerufen.

Other Status Codes

CloudError

Automatisierungsfehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

SessionHost_Get

Beispielanforderung

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

Beispiel für eine Antwort

{
  "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

Cloudfehlerobjekt.

CloudErrorProperties

Eigenschaften des Cloudfehlerobjekts.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

HealthCheckName

Stellt den Namen des durchgeführten Integritätsprüfungsvorgangs dar.

HealthCheckResult

Stellt den Integritätsstatus der durchgeführten Integritätsprüfung dar.

SessionHost

Stellt eine SessionHost-Definition dar.

SessionHostHealthCheckFailureDetails

Enthält Details zum Fehler.

SessionHostHealthCheckReport

Der Bericht für Sitzungshostinformationen.

Status

Status für einen SessionHost.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

UpdateState

Aktualisieren des Status eines SessionHosts.

CloudError

Cloudfehlerobjekt.

Name Typ Beschreibung
error

CloudErrorProperties

Eigenschaften des Cloudfehlerobjekts.

CloudErrorProperties

Eigenschaften des Cloudfehlerobjekts.

Name Typ Beschreibung
code

string

Fehlercode

message

string

Eine Fehlermeldung, die angibt, warum der Vorgang fehlgeschlagen ist.

createdByType

Der Identitätstyp, der die Ressource erstellt hat.

Name Typ Beschreibung
Application

string

Key

string

ManagedIdentity

string

User

string

HealthCheckName

Stellt den Namen des durchgeführten Integritätsprüfungsvorgangs dar.

Name Typ Beschreibung
AppAttachHealthCheck

string

Überprüft, ob appAttachService fehlerfrei ist (während der Paketbereitstellung sind keine Probleme aufgetreten). Der AppAttachService wird verwendet, um das Staging/die Registrierung (und letztliche Deregistrierung/Destaging) von MSIX-Apps zu aktivieren, die vom Mandantenadministrator eingerichtet wurden. Dadurch wird überprüft, ob die Komponente während des Paket stagings Fehler aufgetreten ist. Fehler beim Staging verhindern, dass einige MSIX-Apps für den Endbenutzer ordnungsgemäß funktionieren. Wenn diese Überprüfung fehlschlägt, ist sie nicht schwerwiegend, und der Computer kann weiterhin Verbindungen warten. Standard Problem kann sein, dass Apps für Endbenutzer nicht funktionieren.

DomainJoinedCheck

string

Überprüft, ob der SessionHost mit einer Domäne verknüpft ist. Wenn diese Überprüfung fehlschlägt, wird als schwerwiegend klassifiziert, da keine Verbindung erfolgreich hergestellt werden kann, wenn der SessionHost nicht mit der Domäne verbunden ist.

DomainReachable

string

Überprüft, ob die Domäne, in die sessionHost eingebunden ist, weiterhin erreichbar ist. Wenn diese Überprüfung fehlschlägt, wird als schwerwiegend klassifiziert, da keine Verbindung hergestellt werden kann, wenn die Domäne, in die der SessionHost eingebunden ist, zum Zeitpunkt der Verbindung nicht erreichbar ist.

DomainTrustCheck

string

Überprüft, ob beim SessionHost keine Domänenvertrauensstellungsprobleme auftreten, die die Authentifizierung bei SessionHost zum Zeitpunkt der Verbindungserstellung verhindern. Wenn diese Überprüfung fehlschlägt, wird als schwerwiegend klassifiziert, da keine Verbindung erfolgreich hergestellt werden kann, wenn wir die Domäne für die Authentifizierung auf dem SessionHost nicht erreichen können.

FSLogixHealthCheck

string

Überprüft, ob der FSLogix-Dienst aktiv ist und ausgeführt wird, um sicherzustellen, dass die Benutzerprofile in der Sitzung geladen werden. Wenn diese Überprüfung fehlschlägt, wird als schwerwiegend klassifiziert, auch wenn die Verbindung erfolgreich hergestellt werden kann, ist die Benutzererfahrung schlecht, da das Benutzerprofil nicht geladen werden kann und der Benutzer ein temporäres Profil in der Sitzung erhält.

MetaDataServiceCheck

string

Überprüft, ob auf den Metadatendienst zugegriffen werden kann und Computeeigenschaften zurückgegeben werden.

MonitoringAgentCheck

string

Überprüft, ob der erforderliche Genfer Agent ausgeführt wird. Wenn diese Überprüfung fehlschlägt, ist sie nicht schwerwiegend, und der Computer kann weiterhin Verbindungen verwalten. Standard Problem kann sein, dass der Überwachungs-Agent fehlt oder (möglicherweise) eine ältere Version ausführt.

SupportedEncryptionCheck

string

Ü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 fatal. Wenn der Wert 1 (SecurityLayer.Negotiate) ist, schlägt diese Überprüfung mit Fehlercode = NativeMethodErrorCode.ERROR_SUCCESS fehl und ist nicht tödlich.

SxSStackListenerCheck

string

Überprüft, ob der SxS-Stapel ausgeführt wird, damit Verbindungen erfolgreich hergestellt werden können. Wenn diese Überprüfung fehlschlägt, wird als schwerwiegend klassifiziert, da keine Verbindung erfolgreich hergestellt werden kann, wenn der SxS-Stapel nicht bereit ist.

UrlsAccessibleCheck

string

Überprüft, ob der erforderliche WVD-Dienst und die Genfer URLs vom SessionHost aus erreichbar sind. Diese URLs sind: RdTokenUri, RdBrokerURI, RdDiagnosticsUri und Speicherblob-URLs für die Agentüberwachung (geneva). Wenn diese Überprüfung fehlschlägt, ist sie nicht schwerwiegend, und der Computer kann weiterhin Verbindungen verwalten, Standard Problem kann sein, dass der Überwachungs-Agent keine warmen Pfaddaten (Protokolle, Vorgänge ...) speichern kann.

WebRTCRedirectorCheck

string

Ü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 überprüft, ob die Komponente noch ausgeführt wird und ob eine höhere Version verfügbar ist. Wenn diese Überprüfung fehlschlägt, ist sie nicht schwerwiegend, und der Computer kann weiterhin Verbindungen verwalten. Standard Problem kann sein, dass die WebRTCRedirector-Komponente neu gestartet oder aktualisiert werden muss.

HealthCheckResult

Stellt den Integritätsstatus der durchgeführten Integritätsprüfung dar.

Name Typ Beschreibung
HealthCheckFailed

string

Fehler bei der Integritätsprüfung.

HealthCheckSucceeded

string

Integritätsprüfung erfolgreich.

SessionHostShutdown

string

Wir haben eine Benachrichtigung über das Herunterfahren erhalten.

Unknown

string

Das Ergebnis der Integritätsprüfung ist derzeit nicht bekannt.

SessionHost

Stellt eine SessionHost-Definition dar.

Name Typ Beschreibung
id

string

Vollqualifizierte Ressourcen-ID für die Ressource. Beispiel: /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

Lassen Sie eine neue Sitzung zu.

properties.assignedUser

string

Benutzer, der SessionHost zugewiesen ist.

properties.friendlyName

string

Anzeigename von SessionHost

properties.lastHeartBeat

string

Letzter Herzschlag von SessionHost.

properties.lastUpdateTime

string

Der Zeitstempel des letzten Updates.

properties.objectId

string

ObjectId von SessionHost. (interne Verwendung)

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

Anzahl der Sitzungen auf SessionHost.

properties.status

Status

Status für einen SessionHost.

properties.statusTimestamp

string

Der Zeitstempel des status.

properties.sxSStackVersion

string

Die Version des parallelen Stapels auf dem Sitzungshost.

properties.updateErrorMessage

string

Die Fehlermeldung.

properties.updateState

UpdateState

Aktualisieren des Status eines SessionHosts.

properties.virtualMachineId

string

VM-ID des zugrunde liegenden virtuellen Computers von SessionHost.

systemData

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

type

string

Der Typ der Ressource. Z.B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

SessionHostHealthCheckFailureDetails

Enthält Details zum Fehler.

Name Typ Beschreibung
errorCode

integer

Fehlercode für den Fehler.

lastHealthCheckDateTime

string

Der Zeitstempel des letzten Updates.

message

string

Fehlermeldung: Hinweise darauf, was falsch ist und wie wie wiederhergestellt werden kann.

SessionHostHealthCheckReport

Der Bericht für Sitzungshostinformationen.

Name Typ Beschreibung
additionalFailureDetails

SessionHostHealthCheckFailureDetails

Zusätzliche detaillierte Informationen zum Fehler.

healthCheckName

HealthCheckName

Stellt den Namen des durchgeführten Integritätsprüfungsvorgangs dar.

healthCheckResult

HealthCheckResult

Stellt den Integritätsstatus der durchgeführten Integritätsprüfung dar.

Status

Status für einen SessionHost.

Name Typ Beschreibung
Available

string

Der Sitzungshost hat alle Integritätsprüfungen bestanden und steht für die Verarbeitung von Verbindungen zur Verfügung.

Disconnected

string

Der Sitzungshost ist nicht verfügbar, da er derzeit getrennt ist.

DomainTrustRelationshipLost

string

Die Domänenvertrauensstellungsbeziehung von SessionHost ist verloren gegangen

FSLogixNotHealthy

string

FSLogix befindet sich auf dem Sitzungshost in einem fehlerhaften Zustand.

NeedsAssistance

string

Neue status, um Administratoren darüber zu informieren, dass die Integrität ihres Endpunkts behoben werden muss. Die Verbindungen schlagen möglicherweise nicht fehl, da diese Probleme nicht schwerwiegend sind.

NoHeartbeat

string

Der Sitzungshost schlägt nicht mit dem Herzen.

NotJoinedToDomain

string

SessionHost ist nicht mit der Domäne verbunden.

Shutdown

string

Sitzungshost wird heruntergefahren: Der vom RD-Agent gemeldete Sitzungshost wird beendet oder die Zuordnung aufgehoben.

SxSStackListenerNotReady

string

Der auf dem SessionHost installierte SxS-Stapel ist nicht bereit, Verbindungen zu empfangen.

Unavailable

string

Der Sitzungshost ist entweder deaktiviert oder hat einen Fehler bei kritischen Integritätsprüfungen, was dazu führt, dass der Dienst keine Verbindungen an diesen Sitzungshost weiterleiten kann. Beachten Sie, dass die vorherige "NoHeartBeat"-status ersetzt wird.

UpgradeFailed

string

Der Sitzungshost ist nicht verfügbar, da beim Upgrade der kritischen Komponente (Agent, paralleler Stapel usw.) ein Fehler aufgetreten ist.

Upgrading

string

Der Sitzungshost ist nicht verfügbar, da derzeit ein Upgrade des RDAgent-/parallelen Stapels ausgeführt wird. Hinweis: Dieser Zustand wird entfernt, sobald das Upgrade abgeschlossen ist und der Host Verbindungen akzeptieren kann.

systemData

Metadaten, die sich auf die Erstellung und letzte Änderung der Ressource beziehen.

Name Typ Beschreibung
createdAt

string

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

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

Aktualisieren des Status eines SessionHosts.

Name Typ Beschreibung
Failed

string

Initial

string

Pending

string

Started

string

Succeeded

string