Session Hosts - Get

Service:: Desktop Virtualization

API-versie:: 2025-10-10

Vraag een sessiehost aan.

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

URI-parameters

Name	In	Vereist	Type	Description
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	De naam van de hostgroep binnen de opgegeven resourcegroep
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is hoofdletterongevoelig.
sessionHostName	path	True	string minLength: 3 maxLength: 48 pattern: ^[A-Za-z0-9@.\-_ ]*$	De naam van de sessiehost binnen de opgegeven hostgroep
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Antwoorden

Name	Type	Description
200 OK	SessionHost	Sessiehost succesvol opgehaald.
Other Status Codes	CloudError	Reactie op automatiseringsfout die beschrijft waarom de bewerking is mislukt.

Voorbeelden

SessionHost_Get

Voorbeeldaanvraag

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

Voorbeeldrespons

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"
        }
      }
    ]
  }
}

Definities

Name	Description
CloudError	Cloud error object.
CloudErrorProperties	Eigenschappen van Cloud Error Object.
createdByType	Het type identiteit waarmee de resource is gemaakt.
HealthCheckName	Vertegenwoordigt de naam van de uitgevoerde statuscontrole.
HealthCheckResult	Geeft de gezondheidstoestand weer van de gezondheidscontrole die we hebben uitgevoerd.
SessionHost	Vertegenwoordigt een SessionHost-definitie.
SessionHostHealthCheckFailureDetails	Bevat details over de fout.
SessionHostHealthCheckReport	Het rapport voor informatie over de sessiehost.
Status	Status voor een SessionHost.
systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
UpdateState	Werk de status van een SessionHost bij.

CloudError

Object

Cloud error object.

Name	Type	Description
error	CloudErrorProperties	Eigenschappen van Cloud Error Object.

CloudErrorProperties

Object

Eigenschappen van Cloud Error Object.

Name	Type	Description
code	string	Foutcode
message	string	Foutbericht dat aangeeft waarom de bewerking is mislukt.

createdByType

Opsomming

Het type identiteit waarmee de resource is gemaakt.

Waarde	Description
User
Application
ManagedIdentity
Key

HealthCheckName

Opsomming

Vertegenwoordigt de naam van de uitgevoerde statuscontrole.

Waarde	Description
DomainJoinedCheck	Controleert of de SessionHost is gekoppeld aan een domein. Als deze controle mislukt, wordt deze geclassificeerd als fataal omdat er geen verbinding kan worden gemaakt als de SessionHost niet is verbonden met het domein. (Momenteel ingeschakeld)
DomainTrustCheck	Hiermee wordt gecontroleerd of de SessionHost geen problemen met domeinvertrouwen ondervindt die verificatie op SessionHost verhinderen op het moment van verbinding wanneer de sessie wordt gemaakt. Als deze controle mislukt, wordt deze geclassificeerd als fataal omdat er geen verbinding kan worden gemaakt als we het domein niet kunnen bereiken voor verificatie op de SessionHost. (Momenteel ingeschakeld)
FSLogixHealthCheck	Controleert of de FSLogix-service actief is om ervoor te zorgen dat de profielen van gebruikers in de sessie worden geladen. Als deze controle mislukt, wordt deze geclassificeerd als fataal, zelfs als de verbinding kan slagen, is de gebruikerservaring slecht omdat het gebruikersprofiel niet kan worden geladen en de gebruiker een tijdelijk profiel krijgt in de sessie. (Momenteel uitgeschakeld)
SxSStackListenerCheck	Controleert of de SxS-stack actief is, zodat verbindingen kunnen slagen. Als deze controle mislukt, wordt deze geclassificeerd als fataal omdat er geen verbinding kan slagen als de SxS-stack niet gereed is. (Momenteel ingeschakeld)
UrlsAccessibleCheck	Controleert of de vereiste WVD-service en URL's van Genève bereikbaar zijn via de SessionHost. Deze URL's zijn: RdTokenUri-, RdBrokerURI-, RdDiagnosticsUri- en opslagblob-URL's voor agentbewaking (genève). Als deze controle mislukt, is deze niet fataal en kan de machine nog steeds verbindingen onderhouden, het belangrijkste probleem kan zijn dat de bewakingsagent niet in staat is om warme padgegevens op te slaan (logboeken, bewerkingen ...). (Momenteel uitgeschakeld)
MonitoringAgentCheck	Controleert of de vereiste agent in Genève actief is. Als deze controle mislukt, is deze niet dodelijk en kan de machine nog steeds verbindingen onderhouden, het belangrijkste probleem kan zijn dat de bewakingsagent ontbreekt of (mogelijk) een oudere versie gebruikt. (Momenteel ingeschakeld)
DomainReachable	Controleert of het domein waarvan de SessionHost lid is, nog steeds bereikbaar is. Als deze controle mislukt, wordt deze geclassificeerd als fataal omdat er geen verbinding kan worden gemaakt als het domein waarvan de SessionHost is lid is, niet bereikbaar is op het moment van verbinding. (Momenteel uitgeschakeld)
WebRTCRedirectorCheck	Controleert of het onderdeel WebRTCRedirector in orde is. De component WebRTCRedirector wordt gebruikt om de video- en audioprestaties in Microsoft Teams te optimaliseren. Hiermee wordt gecontroleerd of het onderdeel nog draait en of er een hogere versie beschikbaar is. Als deze controle mislukt, is deze niet dodelijk en kan de machine nog steeds verbindingen onderhouden, het belangrijkste probleem kan zijn dat het WebRTCRedirector-onderdeel opnieuw moet worden opgestart of bijgewerkt. (Momenteel uitgeschakeld)
SupportedEncryptionCheck	Hiermee wordt de waarde van de SecurityLayer-registratiesleutel gecontroleerd. Als de waarde 0 is (SecurityLayer.RDP), mislukt deze controle met foutcode = NativeMethodErrorCode.E_FAIL en is deze fataal. Als de waarde 1 is (SecurityLayer.Negotiate), mislukt deze controle met foutcode = NativeMethodErrorCode.ERROR_SUCCESS en is deze niet dodelijk. (Momenteel uitgeschakeld)
MetaDataServiceCheck	Controleert of de metagegevensservice toegankelijk is en de rekeneigenschappen retourneert. (Momenteel ingeschakeld)
AppAttachHealthCheck	Controleert of de AppAttachService in orde is (er waren geen problemen tijdens het stagen van het pakket). De AppAttachService wordt gebruikt om de staging/registratie (en uiteindelijk deregistratie/detaging) van MSSIX-apps mogelijk te maken die door de tenant-beheerder zijn ingesteld. Dit controleert of het component fouten heeft gehad tijdens het stagingen van het pakket. Fouten in de staging zorgen ervoor dat sommige MISIX-apps niet goed werken voor de eindgebruiker. Als deze controle mislukt, is deze niet dodelijk en kan de machine nog steeds verbindingen onderhouden, het belangrijkste probleem kan zijn dat bepaalde apps niet werken voor eindgebruikers. (Momenteel ingeschakeld)

HealthCheckResult

Opsomming

Geeft de gezondheidstoestand weer van de gezondheidscontrole die we hebben uitgevoerd.

Waarde	Description
Unknown	Het resultaat van de gezondheidscontrole is momenteel niet bekend.
HealthCheckSucceeded	Gezondheidscheck geslaagd.
HealthCheckFailed	Gezondheidscontrole mislukt.
SessionHostShutdown	We hebben een melding ontvangen voor afsluiten.

SessionHost

Object

Vertegenwoordigt een SessionHost-definitie.

Name	Type	Description
id	string (arm-id)	Volledig gekwalificeerde resource-id voor de resource. Bijvoorbeeld /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceType}/{resourceName}"
name	string	De naam van de resource
properties.agentVersion	string	Versie van de agent op SessionHost.
properties.allowNewSession	boolean	Sta een nieuwe sessie toe.
properties.assignedUser	string	Gebruiker toegewezen aan SessionHost.
properties.friendlyName	string	Vriendelijke naam van SessionHost
properties.lastHeartBeat	string (date-time)	Laatste hartslag van SessionHost.
properties.lastUpdateTime	string (date-time)	Het tijdstempel van de laatste update.
properties.objectId	string	ObjectId van SessionHost. (intern gebruik)
properties.osVersion	string	De versie van het besturingssysteem op de sessiehost.
properties.resourceId	string	Resource-id van de onderliggende virtuele machine van SessionHost.
properties.sessionHostHealthCheckResults	SessionHostHealthCheckReport[]	Lijst met SessionHostHealthCheckReports
properties.sessions	integer (int32)	Aantal sessies op SessionHost.
properties.status	Status	Status voor een SessionHost.
properties.statusTimestamp	string (date-time)	De tijdstempel van de status.
properties.sxSStackVersion	string	De versie van de zij-aan-zij-stapel op de sessiehost.
properties.updateErrorMessage	string	Het foutbericht.
properties.updateState	UpdateState	Werk de status van een SessionHost bij.
properties.virtualMachineId	string	Virtuele machine-id van de onderliggende virtuele machine van SessionHost.
systemData	systemData	Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.
type	string	Het type bron. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

SessionHostHealthCheckFailureDetails

Object

Bevat details over de fout.

Name	Type	Description
errorCode	integer (int32)	Foutcode die overeenkomt met de fout.
lastHealthCheckDateTime	string (date-time)	Het tijdstempel van de laatste update.
message	string	Foutmelding: hints over wat er mis is en hoe te herstellen.

SessionHostHealthCheckReport

Object

Het rapport voor informatie over de sessiehost.

Name	Type	Description
additionalFailureDetails	SessionHostHealthCheckFailureDetails	Aanvullende gedetailleerde informatie over de storing.
healthCheckName	HealthCheckName	Vertegenwoordigt de naam van de uitgevoerde statuscontrole.
healthCheckResult	HealthCheckResult	Geeft de gezondheidstoestand weer van de gezondheidscontrole die we hebben uitgevoerd.

Status

Opsomming

Status voor een SessionHost.

Waarde	Description
Available	Session Host heeft alle statuscontroles doorstaan en is beschikbaar om verbindingen af te handelen.
Unavailable	Sessiehost is uitgeschakeld of heeft kritieke statuscontroles niet doorstaan, waardoor de service geen verbindingen naar deze sessiehost kan routeren. Houd er rekening mee dat dit de vorige 'NoHeartBeat'-status vervangt.
Shutdown	Sessiehost wordt afgesloten: RD-agent heeft gemeld dat de sessiehost is gestopt of ongedaan is gemaakt.
Disconnected	De sessiehost is niet beschikbaar omdat de verbinding momenteel is verbroken.
Upgrading	Session Host is niet beschikbaar omdat er momenteel een upgrade van RDAgent/side-by-side stack wordt uitgevoerd. Opmerking: deze status wordt verwijderd zodra de upgrade is voltooid en de host verbindingen kan accepteren.
UpgradeFailed	Session Host is niet beschikbaar omdat de upgrade van kritieke onderdelen (agent, side-by-side stack, enzovoort) is mislukt.
NoHeartbeat	Het hart van de Session Host klopt niet.
NotJoinedToDomain	SessionHost is niet lid van het domein.
DomainTrustRelationshipLost	De domeinvertrouwensrelatie van SessionHost is verloren
SxSStackListenerNotReady	De SxS-stack die op de SessionHost is geïnstalleerd, is niet klaar om verbindingen te ontvangen.
FSLogixNotHealthy	FSLogix bevindt zich in een beschadigde staat op de sessiehost.
NeedsAssistance	Nieuwe status om beheerders te informeren dat de status op hun eindpunt moet worden opgelost. De verbindingen mogen niet falen, omdat deze problemen niet fataal zijn.

systemData

Object

Metagegevens met betrekking tot het maken en de laatste wijziging van de resource.

Name	Type	Description
createdAt	string (date-time)	De tijdstempel van het maken van resources (UTC).
createdBy	string	De identiteit waarmee de resource is gemaakt.
createdByType	createdByType	Het type identiteit waarmee de resource is gemaakt.
lastModifiedAt	string (date-time)	De tijdstempel van de laatste wijziging van de resource (UTC)
lastModifiedBy	string	De identiteit die de resource voor het laatst heeft gewijzigd.
lastModifiedByType	createdByType	Het type identiteit dat de resource voor het laatst heeft gewijzigd.

UpdateState

Opsomming

Werk de status van een SessionHost bij.

Waarde	Description
Initial
Pending
Started
Succeeded
Failed

Delen via

Session Hosts - Get

URI-parameters

Antwoorden

Voorbeelden

SessionHost_Get

Voorbeeldaanvraag

Voorbeeldrespons

Definities

CloudError

CloudErrorProperties

createdByType

HealthCheckName

HealthCheckResult

SessionHost

SessionHostHealthCheckFailureDetails

SessionHostHealthCheckReport

Status

systemData

UpdateState