Session Hosts - Get
Haal een sessiehost op.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}?api-version=2024-04-03
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
host
|
path | True |
string minLength: 3maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$ |
De naam van de hostgroep binnen de opgegeven resourcegroep |
resource
|
path | True |
string minLength: 1maxLength: 90 |
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig. |
session
|
path | True |
string minLength: 3maxLength: 48 pattern: ^[A-Za-z0-9@.\-_ ]*$ |
De naam van de sessiehost binnen de opgegeven hostgroep |
subscription
|
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 |
De sessiehost is opgehaald. |
|
Other Status Codes |
Automatiseringsfoutreactie waarin wordt beschreven waarom de bewerking is mislukt. |
Voorbeelden
SessionHost_Get
Voorbeeldaanvraag
Voorbeeldrespons
{
"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 |
---|---|
Cloud |
Cloudfoutobject. |
Cloud |
Eigenschappen van cloudfoutobjecten. |
created |
Het type identiteit waarmee de resource is gemaakt. |
Health |
Vertegenwoordigt de naam van de uitgevoerde statuscontrolebewerking. |
Health |
Vertegenwoordigt de status van de status van de statuscontrole die we hebben uitgevoerd. |
Session |
Vertegenwoordigt een SessionHost-definitie. |
Session |
Bevat details over de fout. |
Session |
Het rapport voor sessiehostgegevens. |
Status |
Status voor een SessionHost. |
system |
Metagegevens met betrekking tot het maken en de laatste wijziging van de resource. |
Update |
Werk de status van een SessionHost bij. |
CloudError
Cloudfoutobject.
Name | Type | Description |
---|---|---|
error |
Eigenschappen van cloudfoutobjecten. |
CloudErrorProperties
Eigenschappen van cloudfoutobjecten.
Name | Type | Description |
---|---|---|
code |
string |
Foutcode |
message |
string |
Foutbericht dat aangeeft waarom de bewerking is mislukt. |
createdByType
Het type identiteit waarmee de resource is gemaakt.
Waarde | Description |
---|---|
Application | |
Key | |
ManagedIdentity | |
User |
HealthCheckName
Vertegenwoordigt de naam van de uitgevoerde statuscontrolebewerking.
Waarde | Description |
---|---|
AppAttachHealthCheck |
Controleert of de AppAttachService in orde is (er zijn geen problemen tijdens het faseren van pakketten). De AppAttachService wordt gebruikt om de fasering/registratie (en uiteindelijke deregistratie/destaging) van MSIX-apps in te schakelen die zijn ingesteld door de tenantbeheerder. Hiermee wordt gecontroleerd of het onderdeel fouten had tijdens de fasering van het pakket. Fouten in fasering verhinderen dat sommige MSIX-apps goed werken voor de eindgebruiker. Als deze controle mislukt, is deze niet fataal en kan de machine nog steeds serviceverbindingen uitvoeren. Het belangrijkste probleem kan zijn dat bepaalde apps niet werken voor eindgebruikers. (Momenteel ingeschakeld) |
DomainJoinedCheck |
Controleert of SessionHost lid is van een domein. Als deze controle mislukt, wordt geclassificeerd als onherstelbare, omdat er geen verbinding kan worden gemaakt als de SessionHost niet is toegevoegd aan het domein. (Momenteel ingeschakeld) |
DomainReachable |
Controleert of het domein waaraan SessionHost is toegevoegd nog steeds bereikbaar is. Als deze controle mislukt, wordt geclassificeerd als onherstelbaar omdat er geen verbinding kan worden gemaakt als het domein dat de SessionHost is toegevoegd, niet bereikbaar is op het moment van de verbinding. (Momenteel uitgeschakeld) |
DomainTrustCheck |
Controleert of sessionHost geen problemen ondervindt met domeinvertrouwen die verificatie op SessionHost tijdens het maken van de sessie verhinderen. Als deze controle mislukt, wordt geclassificeerd als fataal omdat er geen verbinding kan worden gemaakt als het domein niet kan worden bereikt 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 geclassificeerd als onherstelbaar, zelfs als de verbinding kan slagen, is de gebruikerservaring slecht omdat het gebruikersprofiel niet kan worden geladen en de gebruiker een tijdelijk profiel in de sessie krijgt. (Momenteel uitgeschakeld) |
MetaDataServiceCheck |
Controleert of de metagegevensservice toegankelijk is en rekeneigenschappen retourneert. (Momenteel ingeschakeld) |
MonitoringAgentCheck |
Controleert of de vereiste Genève-agent wordt uitgevoerd. Als deze controle mislukt, is deze niet fataal en kan de machine nog steeds serviceverbindingen uitvoeren. Het belangrijkste probleem kan zijn dat de bewakingsagent ontbreekt of een oudere versie uitvoert (mogelijk). (Momenteel ingeschakeld) |
SupportedEncryptionCheck |
Controleert de waarde van de SecurityLayer-registratiesleutel. Als de waarde 0 (SecurityLayer.RDP) is, mislukt deze controle met foutcode = NativeMethodErrorCode.E_FAIL en is deze onherstelbare waarde. Als de waarde 1 (SecurityLayer.Negotiate) is, mislukt deze controle met foutcode = NativeMethodErrorCode.ERROR_SUCCESS en is deze niet fataal. (Momenteel uitgeschakeld) |
SxSStackListenerCheck |
Controleert of de SxS-stack actief is, zodat verbindingen kunnen slagen. Als deze controle mislukt, wordt geclassificeerd als fataal omdat er geen verbinding kan worden uitgevoerd als de SxS-stack niet gereed is. (Momenteel ingeschakeld) |
UrlsAccessibleCheck |
Controleert of de vereiste WVD-service en De URL's van Genève bereikbaar zijn vanaf 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 serviceverbindingen uitvoeren. Het belangrijkste probleem kan zijn dat de bewakingsagent geen warme padgegevens kan opslaan (logboeken, bewerkingen...). (Momenteel uitgeschakeld) |
WebRTCRedirectorCheck |
Controleert of het webRTCRedirector-onderdeel in orde is. Het WebRTCRedirector-onderdeel wordt gebruikt om de video- en audioprestaties in Microsoft Teams te optimaliseren. Hiermee wordt gecontroleerd of het onderdeel nog steeds wordt uitgevoerd en of er een hogere versie beschikbaar is. Als deze controle mislukt, is deze niet fataal en kan de machine nog steeds serviceverbindingen uitvoeren. Het belangrijkste probleem kan zijn dat het webRTCRedirector-onderdeel opnieuw moet worden opgestart of bijgewerkt. (Momenteel uitgeschakeld) |
HealthCheckResult
Vertegenwoordigt de status van de status van de statuscontrole die we hebben uitgevoerd.
Waarde | Description |
---|---|
HealthCheckFailed |
Statuscontrole is mislukt. |
HealthCheckSucceeded |
Statuscontrole geslaagd. |
SessionHostShutdown |
We hebben een afsluitmelding ontvangen. |
Unknown |
Het resultaat van de statuscontrole is momenteel niet bekend. |
SessionHost
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 agent op SessionHost. |
properties.allowNewSession |
boolean |
Een nieuwe sessie toestaan. |
properties.assignedUser |
string |
Gebruiker toegewezen aan SessionHost. |
properties.friendlyName |
string |
Beschrijvende naam van SessionHost |
properties.lastHeartBeat |
string (date-time) |
Laatste hartslag van SessionHost. |
properties.lastUpdateTime |
string (date-time) |
De 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 |
Lijst met SessionHostHealthCheckReports |
|
properties.sessions |
integer (int32) |
Aantal sessies op SessionHost. |
properties.status |
Status voor een SessionHost. |
|
properties.statusTimestamp |
string (date-time) |
De tijdstempel van de status. |
properties.sxSStackVersion |
string |
De versie van de side-by-side stack op de sessiehost. |
properties.updateErrorMessage |
string |
Het foutbericht. |
properties.updateState |
Werk de status van een SessionHost bij. |
|
properties.virtualMachineId |
string |
Id van de onderliggende virtuele machine van SessionHost. |
systemData |
Metagegevens met betrekking tot het maken en de laatste wijziging van de resource. |
|
type |
string |
Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts' |
SessionHostHealthCheckFailureDetails
Bevat details over de fout.
Name | Type | Description |
---|---|---|
errorCode |
integer (int32) |
Foutcode die overeenkomt met de fout. |
lastHealthCheckDateTime |
string (date-time) |
De tijdstempel van de laatste update. |
message |
string |
Foutbericht: hints over wat er mis is en hoe u kunt herstellen. |
SessionHostHealthCheckReport
Het rapport voor sessiehostgegevens.
Name | Type | Description |
---|---|---|
additionalFailureDetails |
Aanvullende gedetailleerde informatie over de fout. |
|
healthCheckName |
Vertegenwoordigt de naam van de uitgevoerde statuscontrolebewerking. |
|
healthCheckResult |
Vertegenwoordigt de status van de status van de statuscontrole die we hebben uitgevoerd. |
Status
Status voor een SessionHost.
Waarde | Description |
---|---|
Available |
Sessiehost heeft alle statuscontroles doorstaan en is beschikbaar voor het afhandelen van verbindingen. |
Disconnected |
De sessiehost is niet beschikbaar omdat de verbinding momenteel is verbroken. |
DomainTrustRelationshipLost |
De vertrouwensrelatie van SessionHost voor domein is verloren gegaan |
FSLogixNotHealthy |
FSLogix heeft een slechte status op de sessiehost. |
NeedsAssistance |
Nieuwe status om beheerders te informeren dat de status op hun eindpunt moet worden opgelost. De verbindingen mislukken mogelijk niet, omdat deze problemen niet fataal zijn. |
NoHeartbeat |
De sessiehost klopt niet. |
NotJoinedToDomain |
SessionHost is niet gekoppeld aan een domein. |
Shutdown |
Sessiehost wordt afgesloten- RD Agent gerapporteerde sessiehost die moet worden gestopt of de toewijzing ervan ongedaan wordt gemaakt. |
SxSStackListenerNotReady |
SxS-stack geïnstalleerd op SessionHost is niet gereed voor het ontvangen van verbindingen. |
Unavailable |
Sessiehost is uitgeschakeld of heeft kritieke statuscontroles mislukt waardoor de service geen verbindingen naar deze sessiehost kan routeren. Houd er rekening mee dat hiermee de vorige status 'NoHeartBeat' wordt vervangen. |
UpgradeFailed |
Sessiehost is niet beschikbaar omdat de upgrade van het kritieke onderdeel (agent, side-by-side stack, enzovoort) is mislukt. |
Upgrading |
Sessiehost is niet beschikbaar omdat 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. |
systemData
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 |
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 |
Het type identiteit dat de resource voor het laatst heeft gewijzigd. |
UpdateState
Werk de status van een SessionHost bij.
Waarde | Description |
---|---|
Failed | |
Initial | |
Pending | |
Started | |
Succeeded |