Session Hosts - Get

Szolgáltatás:: Desktop Virtualization

API-verzió:: 2025-10-10

Szerezzen be egy munkamenetgazdát.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	A gazdagépkészlet neve a megadott erőforráscsoporton belül
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
sessionHostName	path	True	string minLength: 3 maxLength: 48 pattern: ^[A-Za-z0-9@.\-_ ]*$	A munkamenetgazda neve a megadott gazdagépkészleten belül
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használandó API-verzió.

Válaszok

Name	Típus	Description
200 OK	SessionHost	Sikeresen lekértem a session hostot.
Other Status Codes	CloudError	Automatizálási hibaválasz, amely leírja a művelet sikertelenségét.

Példák

SessionHost_Get

Mintakérelem

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

Mintaválasz

Állapotkód:: 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"
        }
      }
    ]
  }
}

Definíciók

Name	Description
CloudError	Felhőhiba objektum.
CloudErrorProperties	Felhőhiba objektum tulajdonságai.
createdByType	Az erőforrást létrehozó identitás típusa.
HealthCheckName	A végrehajtott állapot-ellenőrzési művelet nevét jelöli.
HealthCheckResult	Az általunk elvégzett állapotfelmérés állapotát jelöli.
SessionHost	Egy SessionHost definíciót jelöl.
SessionHostHealthCheckFailureDetails	A hiba részleteit tartalmazza.
SessionHostHealthCheckReport	A munkamenetgazda adatait tartalmazó jelentés.
Status	A SessionHost állapota.
systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
UpdateState	SessionHost állapotának frissítése.

CloudError

Tárgy

Felhőhiba objektum.

Name	Típus	Description
error	CloudErrorProperties	Felhőhiba objektum tulajdonságai.

CloudErrorProperties

Tárgy

Felhőhiba objektum tulajdonságai.

Name	Típus	Description
code	string	Hibakód
message	string	A művelet sikertelen voltát jelző hibaüzenet.

createdByType

Felsorolás

Az erőforrást létrehozó identitás típusa.

Érték	Description
User
Application
ManagedIdentity
Key

HealthCheckName

Felsorolás

A végrehajtott állapot-ellenőrzési művelet nevét jelöli.

Érték	Description
DomainJoinedCheck	Ellenőrzi, hogy a SessionHost csatlakozik-e egy tartományhoz. Ha ez az ellenőrzés sikertelen, a rendszer végzetesnek minősül, mivel nem lehet sikeres a kapcsolat, ha a SessionHost nincs csatlakoztatva a tartományhoz. (Jelenleg engedélyezve)
DomainTrustCheck	Ellenőrzi, hogy a SessionHost nem tapasztal-e olyan tartományi megbízhatósági problémákat, amelyek megakadályozzák a hitelesítést a SessionHost szolgáltatáson a munkamenet létrehozásakor a kapcsolattartáskor. Ha ez az ellenőrzés sikertelen, a rendszer végzetesnek minősül, mivel egyetlen kapcsolat sem lehet sikeres, ha nem tudjuk elérni a tartományt a SessionHost hitelesítéséhez. (Jelenleg engedélyezve)
FSLogixHealthCheck	Ellenőrzi, hogy az FSLogix szolgáltatás működik-e, és megbizonyosodjon arról, hogy a felhasználók profiljai betöltődnek a munkamenetben. Ha ez az ellenőrzés sikertelen, a rendszer végzetesnek minősül, mivel még ha a kapcsolat sikeres is, a felhasználói élmény rossz, mivel a felhasználói profil nem tölthető be, és a felhasználó ideiglenes profilt kap a munkamenetben. (Jelenleg letiltva)
SxSStackListenerCheck	Ellenőrzi, hogy az SxS-verem működik-e, így a kapcsolatok sikeresek lehetnek. Ha ez az ellenőrzés sikertelen, a rendszer végzetesnek minősül, mivel nem lehet sikeres a kapcsolat, ha az SxS-verem nem áll készen. (Jelenleg engedélyezve)
UrlsAccessibleCheck	Ellenőrzi, hogy a szükséges WVD-szolgáltatás és a genfi URL-címek elérhetők-e a SessionHostból. Ezek az URL-címek a következők: RdTokenUri, RdBrokerURI, RdDiagnosticsUri és tárolási blobok URL-címei az ügynökfigyeléshez (Genf). Ha ez az ellenőrzés sikertelen, akkor nem végzetes, és a gép továbbra is képes kiszolgálni a kapcsolatokat, a fő probléma az lehet, hogy a figyelési ügynök nem tudja tárolni a meleg elérési út adatait (naplók, műveletek ...). (Jelenleg letiltva)
MonitoringAgentCheck	Ellenőrzi, hogy a szükséges genfi ügynök fut-e. Ha ez az ellenőrzés sikertelen, nem végzetes, és a gép továbbra is képes kiszolgálni a kapcsolatokat, a fő probléma az lehet, hogy a figyelési ügynök hiányzik, vagy (esetleg) régebbi verziót futtat. (Jelenleg engedélyezve)
DomainReachable	Ellenőrzi, hogy a SessionHost továbbra is elérhető-e a tartomány, amelyhez a SessionHost csatlakozik. Ha ez az ellenőrzés sikertelen, a rendszer végzetesnek minősül, mivel a kapcsolat nem sikeres, ha a SessionHost tartománya nem érhető el a kapcsolat időpontjában. (Jelenleg letiltva)
WebRTCRedirectorCheck	Ellenőrzi, hogy a WebRTCRedirector összetevő kifogástalan állapotú-e. A WebRTCRedirector összetevő a video- és hangteljesítmény optimalizálására szolgál a Microsoft Teamsben. Ez ellenőrzi, hogy az összetevő fut-e még, és hogy van-e elérhető újabb verzió. Ha ez az ellenőrzés sikertelen, akkor nem végzetes, és a gép továbbra is képes kiszolgálni a kapcsolatokat, a fő probléma az lehet, hogy a WebRTCRedirector összetevőt újra kell indítani vagy frissíteni kell. (Jelenleg letiltva)
SupportedEncryptionCheck	Ellenőrzi a SecurityLayer regisztrációs kulcs értékét. Ha az érték 0 (SecurityLayer.RDP), ez az ellenőrzés meghiúsul a hibakód = NativeMethodErrorCode.E_FAIL értékkel, és végzetes. Ha az érték 1 (SecurityLayer.Negotiate), ez az ellenőrzés meghiúsul a hibakód = NativeMethodErrorCode.ERROR_SUCCESS értékkel, és nem végzetes. (Jelenleg letiltva)
MetaDataServiceCheck	Ellenőrzi, hogy a metaadat-szolgáltatás elérhető-e, és számítási tulajdonságokat ad vissza. (Jelenleg engedélyezve)
AppAttachHealthCheck	Ellenőrzi, hogy az AppAttachService kifogástalan állapotban van-e (a csomag előkészítése során nem volt probléma). Az AppAttachService lehetővé teszi az MSIX alkalmazások staging-jét, regisztrációját (és végső levonását/destaging-ét) a bérlő admin által beállított alkalmazások esetében. Ez ellenőrzi, hogy a komponensben volt-e hibák a csomag fokozatozása során. Az előkészítés hibái megakadályozzák, hogy egyes MSIX-alkalmazások megfelelően működjenek a végfelhasználó számára. Ha ez az ellenőrzés sikertelen, akkor nem végzetes, és a gép továbbra is képes kiszolgálni a kapcsolatokat, a fő probléma az lehet, hogy bizonyos alkalmazások nem működnek a végfelhasználók számára. (Jelenleg engedélyezve)

HealthCheckResult

Felsorolás

Az általunk elvégzett állapotfelmérés állapotát jelöli.

Érték	Description
Unknown	Az állapotfelmérés eredménye jelenleg nem ismert.
HealthCheckSucceeded	Állapotfelmérés sikerült.
HealthCheckFailed	Az állapot-ellenőrzés sikertelen.
SessionHostShutdown	Leállítási értesítést kaptunk.

SessionHost

Tárgy

Egy SessionHost definíciót jelöl.

Name	Típus	Description
id	string (arm-id)	Az erőforrás teljes erőforrás-azonosítója. Például: "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Az erőforrás neve
properties.agentVersion	string	Az ügynök verziója a SessionHoston.
properties.allowNewSession	boolean	Új munkamenet engedélyezése.
properties.assignedUser	string	A SessionHosthoz rendelt felhasználó.
properties.friendlyName	string	A SessionHost rövid neve
properties.lastHeartBeat	string (date-time)	Utolsó szívdobbanás a SessionHost-tól.
properties.lastUpdateTime	string (date-time)	Az utolsó frissítés időbélyegzője.
properties.objectId	string	SessionHost objektumazonosítója. (belső használatra)
properties.osVersion	string	Az operációs rendszer verziója a munkamenetgazdán.
properties.resourceId	string	A SessionHost mögöttes virtuális gépének erőforrás-azonosítója.
properties.sessionHostHealthCheckResults	SessionHostHealthCheckReport[]	A SessionHostHealthCheckReports listája
properties.sessions	integer (int32)	Munkamenetek száma a SessionHoston.
properties.status	Status	A SessionHost állapota.
properties.statusTimestamp	string (date-time)	Az állapot időbélyege.
properties.sxSStackVersion	string	A munkamenetgazda egymás melletti verem verziója.
properties.updateErrorMessage	string	A hibaüzenet.
properties.updateState	UpdateState	SessionHost állapotának frissítése.
properties.virtualMachineId	string	A SessionHost mögöttes virtuális gépének virtuálisgép-azonosítója.
systemData	systemData	Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

SessionHostHealthCheckFailureDetails

Tárgy

A hiba részleteit tartalmazza.

Name	Típus	Description
errorCode	integer (int32)	A hibának megfelelő hibakód.
lastHealthCheckDateTime	string (date-time)	Az utolsó frissítés időbélyegzője.
message	string	Hibaüzenet: tippek a baj és a helyreállítás módjára.

SessionHostHealthCheckReport

Tárgy

A munkamenetgazda adatait tartalmazó jelentés.

Name	Típus	Description
additionalFailureDetails	SessionHostHealthCheckFailureDetails	További részletes információk a hibáról.
healthCheckName	HealthCheckName	A végrehajtott állapot-ellenőrzési művelet nevét jelöli.
healthCheckResult	HealthCheckResult	Az általunk elvégzett állapotfelmérés állapotát jelöli.

Status

Felsorolás

A SessionHost állapota.

Érték	Description
Available	A munkamenetgazda megfelelt az összes állapotellenőrzésen, és elérhető a kapcsolatok kezelésére.
Unavailable	A munkamenetgazda ki van kapcsolva, vagy nem sikerült a kritikus állapot-ellenőrzés, ami miatt a szolgáltatás nem tudja átirányítani a kapcsolatokat ehhez a munkamenetgazdához. Vegye figyelembe, hogy ez felváltja a korábbi "NoHeartBeat" állapotot.
Shutdown	A munkamenetgazda le van állítva – A Távoli asztali ügynök azt jelentette, hogy a munkamenetgazda le van állítva vagy felszabadítva.
Disconnected	A munkamenetgazda nem érhető el, mert jelenleg nincs csatlakoztatva.
Upgrading	A munkamenetgazda nem érhető el, mert jelenleg az RDAgent/side-by-side verem frissítése folyamatban van. Megjegyzés: ez az állapot törlődik, amint a frissítés befejeződött, és a gazdagép képes fogadni a kapcsolatokat.
UpgradeFailed	A munkamenetgazda nem érhető el, mert a kritikus összetevők (ügynök, egymás melletti verem stb.) frissítése meghiúsult.
NoHeartbeat	A Session Host nem dobog a szíve.
NotJoinedToDomain	A SessionHost nincs csatlakoztatva a tartományhoz.
DomainTrustRelationshipLost	A SessionHost tartományi megbízhatósági kapcsolata megszakadt
SxSStackListenerNotReady	A SessionHostra telepített SxS-verem nem áll készen a kapcsolatok fogadására.
FSLogixNotHealthy	Az FSLogix nem megfelelő állapotban van a munkamenetgazdán.
NeedsAssistance	Új állapot, amely tájékoztatja a rendszergazdákat arról, hogy a végpont állapotát ki kell javítani. Előfordulhat, hogy a kapcsolatok nem hibásodnak meg, mivel ezek a problémák nem végzetesek.

systemData

Tárgy

Az erőforrás létrehozásával és utolsó módosításával kapcsolatos metaadatok.

Name	Típus	Description
createdAt	string (date-time)	Az erőforrás-létrehozás időbélyege (UTC).
createdBy	string	Az erőforrást létrehozó identitás.
createdByType	createdByType	Az erőforrást létrehozó identitás típusa.
lastModifiedAt	string (date-time)	Az erőforrás utolsó módosításának időbélyege (UTC)
lastModifiedBy	string	Az erőforrást legutóbb módosító identitás.
lastModifiedByType	createdByType	Az erőforrást legutóbb módosító identitás típusa.

UpdateState

Felsorolás

SessionHost állapotának frissítése.

Érték	Description
Initial
Pending
Started
Succeeded
Failed

Megosztás a következőn keresztül:

Session Hosts - Get

URI-paraméterek

Válaszok

Példák

SessionHost_Get

Mintakérelem

Mintaválasz

Definíciók

CloudError

CloudErrorProperties

createdByType

HealthCheckName

HealthCheckResult

SessionHost

SessionHostHealthCheckFailureDetails

SessionHostHealthCheckReport

Status

systemData

UpdateState