Session Hosts - Get

Tjänst:: Desktop Virtualization

API-version:: 2025-10-10

Skaffa en sessionsvärd.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Namnet på värdpoolen i den angivna resursgruppen
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
sessionHostName	path	True	string minLength: 3 maxLength: 48 pattern: ^[A-Za-z0-9@.\-_ ]*$	Namnet på sessionsvärden i den angivna värdpoolen
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Svar

Name	Typ	Description
200 OK	SessionHost	Hämtade sessionsvärd framgångsrikt.
Other Status Codes	CloudError	Svar på automationsfel som beskriver varför åtgärden misslyckades.

Exempel

SessionHost_Get

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
CloudError	Molnfelobjekt.
CloudErrorProperties	Egenskaper för molnfelobjekt.
createdByType	Den typ av identitet som skapade resursen.
HealthCheckName	Representerar namnet på den hälsokontrollåtgärd som utförs.
HealthCheckResult	Representerar hälsotillståndet för den hälsokontroll som vi utförde.
SessionHost	Representerar en SessionHost-definition.
SessionHostHealthCheckFailureDetails	Innehåller information om felet.
SessionHostHealthCheckReport	Rapporten för information om sessionsvärdar.
Status	Status för en SessionHost.
systemData	Metadata som rör skapande och senaste ändring av resursen.
UpdateState	Uppdatera tillståndet för en SessionHost.

CloudError

Objekt

Molnfelobjekt.

Name	Typ	Description
error	CloudErrorProperties	Egenskaper för molnfelobjekt.

CloudErrorProperties

Objekt

Egenskaper för molnfelobjekt.

Name	Typ	Description
code	string	Felkod
message	string	Felmeddelande som anger varför åtgärden misslyckades.

createdByType

Uppräkning

Den typ av identitet som skapade resursen.

Värde	Description
User
Application
ManagedIdentity
Key

HealthCheckName

Uppräkning

Representerar namnet på den hälsokontrollåtgärd som utförs.

Värde	Description
DomainJoinedCheck	Verifierar att SessionHost är ansluten till en domän. Om den här kontrollen misslyckas klassificeras den som allvarlig eftersom ingen anslutning kan lyckas om SessionHost inte är ansluten till domänen. (För närvarande aktiverat)
DomainTrustCheck	Verifierar att SessionHost inte har problem med domänförtroende som förhindrar autentisering på SessionHost vid anslutningstillfället när sessionen skapas. Om den här kontrollen misslyckas klassificeras den som allvarlig eftersom ingen anslutning kan lyckas om vi inte kan nå domänen för autentisering på SessionHost. (För närvarande aktiverat)
FSLogixHealthCheck	Verifierar att FSLogix-tjänsten är igång för att se till att användarnas profiler läses in i sessionen. Om den här kontrollen misslyckas klassificeras det som allvarligt eftersom även om anslutningen kan lyckas, är användarupplevelsen dålig eftersom användarprofilen inte kan läsas in och användaren får en tillfällig profil i sessionen. (För närvarande inaktiverad)
SxSStackListenerCheck	Verifierar att SxS-stacken är igång så att anslutningarna kan lyckas. Om den här kontrollen misslyckas klassificeras den som allvarlig eftersom ingen anslutning kan lyckas om SxS-stacken inte är klar. (För närvarande aktiverat)
UrlsAccessibleCheck	Verifierar att den WVD-tjänst som krävs och Genève-URL:er kan nås från SessionHost. Dessa URL:er är: RdTokenUri, RdBrokerURI, RdDiagnosticsUri och Storage Blob URL:er för agentövervakning (genève). Om den här kontrollen misslyckas är den inte dödlig och maskinen kan fortfarande serva anslutningar, huvudproblemet kan vara att övervakningsagenten inte kan lagra data om varma sökvägar (loggar, operationer ...). (För närvarande inaktiverad)
MonitoringAgentCheck	Verifierar att den nödvändiga Genève-agenten körs. Om den här kontrollen misslyckas är den inte dödlig och datorn kan fortfarande serva anslutningar, huvudproblemet kan vara att övervakningsagenten saknas eller kör (eventuellt) en äldre version. (För närvarande aktiverat)
DomainReachable	Verifierar att domänen som SessionHost är ansluten till fortfarande kan nås. Om den här kontrollen misslyckas klassificeras den som allvarlig eftersom ingen anslutning kan lyckas om domänen som SessionHost är ansluten till inte kan nås vid tidpunkten för anslutningen. (För närvarande inaktiverad)
WebRTCRedirectorCheck	Verifierar om WebRTCRedirector-komponenten är felfri. Komponenten WebRTCRedirector används för att optimera video- och ljudprestanda i Microsoft Teams. Detta kontrollerar om komponenten fortfarande körs och om det finns en högre version tillgänglig. Om den här kontrollen misslyckas är det inte dödligt och maskinen kan fortfarande serva anslutningar, huvudproblemet kan vara att WebRTCRedirector-komponenten måste startas om eller uppdateras. (För närvarande inaktiverad)
SupportedEncryptionCheck	Verifierar värdet för SecurityLayer-registreringsnyckeln. Om värdet är 0 (SecurityLayer.RDP) misslyckas den här kontrollen med Felkod = NativeMethodErrorCode.E_FAIL och är allvarlig. Om värdet är 1 (SecurityLayer.Negotiate) misslyckas den här kontrollen med Felkod = NativeMethodErrorCode.ERROR_SUCCESS och är inte allvarlig. (För närvarande inaktiverad)
MetaDataServiceCheck	Verifierar att metadatatjänsten är tillgänglig och returnerar beräkningsegenskaper. (För närvarande aktiverat)
AppAttachHealthCheck	Verifierar att AppAttachService är felfri (det uppstod inga problem under paketmellanlagringen). AppAttachService används för att möjliggöra staging/registrering (och slutlig avregistrering/detagging) av MSSIX-appar som har satts upp av hyresgästadministratören. Detta kontrollerar om komponenten haft några fel under paketstaging. Fel i mellanlagringen förhindrar att vissa MSIX-appar fungerar korrekt för slutanvändaren. Om den här kontrollen misslyckas är det inte dödligt och maskinen kan fortfarande serva anslutningar, huvudproblemet kan vara att vissa appar inte fungerar för slutanvändare. (För närvarande aktiverat)

HealthCheckResult

Uppräkning

Representerar hälsotillståndet för den hälsokontroll som vi utförde.

Värde	Description
Unknown	Resultatet av hälsokontrollen är för närvarande inte känt.
HealthCheckSucceeded	Hälsokontrollen godkänd.
HealthCheckFailed	Hälsokontrollen misslyckades.
SessionHostShutdown	Vi har fått ett meddelande om avstängning.

SessionHost

Objekt

Representerar en SessionHost-definition.

Name	Typ	Description
id	string (arm-id)	Fullständigt kvalificerat resurs-ID för resursen. Till exempel "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Namnet på resursen
properties.agentVersion	string	Version av agenten på SessionHost.
properties.allowNewSession	boolean	Tillåt en ny session.
properties.assignedUser	string	Användare tilldelad till SessionHost.
properties.friendlyName	string	Eget namn på SessionHost
properties.lastHeartBeat	string (date-time)	Sista hjärtslag från SessionHost.
properties.lastUpdateTime	string (date-time)	Tidsstämpeln för den senaste uppdateringen.
properties.objectId	string	ObjectId för SessionHost. (internt bruk)
properties.osVersion	string	Versionen av operativsystemet på sessionsvärden.
properties.resourceId	string	Resurs-ID för SessionHosts underliggande virtuella dator.
properties.sessionHostHealthCheckResults	SessionHostHealthCheckReport[]	Lista över SessionHostHealthCheckReports
properties.sessions	integer (int32)	Antal sessioner på SessionHost.
properties.status	Status	Status för en SessionHost.
properties.statusTimestamp	string (date-time)	Tidsstämpeln för statusen.
properties.sxSStackVersion	string	Versionen av sida vid sida-stacken på sessionsvärden.
properties.updateErrorMessage	string	Felmeddelandet.
properties.updateState	UpdateState	Uppdatera tillståndet för en SessionHost.
properties.virtualMachineId	string	Virtuellt dator-ID för SessionHosts underliggande virtuella dator.
systemData	systemData	Metadata som rör skapande och senaste ändring av resursen.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

SessionHostHealthCheckFailureDetails

Objekt

Innehåller information om felet.

Name	Typ	Description
errorCode	integer (int32)	Felkod som motsvarar felet.
lastHealthCheckDateTime	string (date-time)	Tidsstämpeln för den senaste uppdateringen.
message	string	Felmeddelande: tips om vad som är fel och hur du återställer.

SessionHostHealthCheckReport

Objekt

Rapporten för information om sessionsvärdar.

Name	Typ	Description
additionalFailureDetails	SessionHostHealthCheckFailureDetails	Ytterligare detaljerad information om felet.
healthCheckName	HealthCheckName	Representerar namnet på den hälsokontrollåtgärd som utförs.
healthCheckResult	HealthCheckResult	Representerar hälsotillståndet för den hälsokontroll som vi utförde.

Status

Uppräkning

Status för en SessionHost.

Värde	Description
Available	Sessionsvärden har klarat alla hälsokontroller och är tillgänglig för att hantera anslutningar.
Unavailable	Sessionsvärden är antingen avstängd eller har misslyckats med kritiska hälsokontroller, vilket gör att tjänsten inte kan dirigera anslutningar till den här sessionsvärden. Observera att detta ersätter den tidigare statusen "NoHeartBeat".
Shutdown	Sessionsvärden stängs av – RD-agenten rapporterade att sessionsvärden ska stoppas eller frigöras.
Disconnected	Sessionsvärden är inte tillgänglig eftersom den för närvarande är frånkopplad.
Upgrading	Sessionsvärden är inte tillgänglig eftersom det för närvarande pågår en uppgradering av RDAgent/sida-vid-sida-stacken. Det här läget tas bort när uppgraderingen är klar och värden kan acceptera anslutningar.
UpgradeFailed	Sessionsvärden är inte tillgänglig eftersom uppgraderingen av den kritiska komponenten (agent, stacken sida vid sida osv.) misslyckades.
NoHeartbeat	Sessionsvärden är inte hjärtslående.
NotJoinedToDomain	SessionHost är inte ansluten till domänen.
DomainTrustRelationshipLost	SessionHosts domänförtroenderelation har förlorats
SxSStackListenerNotReady	SxS-stacken som är installerad på SessionHost är inte redo att ta emot anslutningar.
FSLogixNotHealthy	FSLogix är i ett feltillstånd på sessionsvärden.
NeedsAssistance	Ny status för att informera administratörer om att hälsotillståndet på deras slutpunkt måste åtgärdas. Anslutningarna kanske inte misslyckas, eftersom dessa problem inte är allvarliga.

systemData

Objekt

Metadata som rör skapande och senaste ändring av resursen.

Name	Typ	Description
createdAt	string (date-time)	Tidsstämpeln för resursskapande (UTC).
createdBy	string	Identiteten som skapade resursen.
createdByType	createdByType	Den typ av identitet som skapade resursen.
lastModifiedAt	string (date-time)	Tidsstämpeln för resursens senaste ändring (UTC)
lastModifiedBy	string	Identiteten som senast ändrade resursen.
lastModifiedByType	createdByType	Den typ av identitet som senast ändrade resursen.

UpdateState

Uppräkning

Uppdatera tillståndet för en SessionHost.

Värde	Description
Initial
Pending
Started
Succeeded
Failed

Dela via

Session Hosts - Get

URI-parametrar

Svar

Exempel

SessionHost_Get

Exempelbegäran

Exempelsvar

Definitioner

CloudError

CloudErrorProperties

createdByType

HealthCheckName

HealthCheckResult

SessionHost

SessionHostHealthCheckFailureDetails

SessionHostHealthCheckReport

Status

systemData

UpdateState