Dela via


Session Hosts - Get

Hämta en sessionsvärd.

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

URI-parametrar

Name I Obligatorisk Typ Description
hostPoolName
path True

string

Namnet på värdpoolen i den angivna resursgruppen

Reguljärt uttrycksmönster: ^[A-Za-z0-9@.\-_ ]*$

resourceGroupName
path True

string

Namnet på resursgruppen. Namnet är skiftlägesokänsligt.

sessionHostName
path True

string

Namnet på sessionsvärden i den angivna värdpoolen

Reguljärt uttrycksmönster: ^[A-Za-z0-9@.\-_ ]*$

subscriptionId
path True

string

uuid

ID för målprenumerationen. Värdet måste vara ett UUID.

api-version
query True

string

DEN API-version som ska användas för den här åtgärden.

Svar

Name Typ Description
200 OK

SessionHost

Sessionsvärden har hämtats.

Other Status Codes

CloudError

Automation-felsvar som beskriver varför åtgärden misslyckades.

Exempel

SessionHost_Get

Exempelbegäran

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

Exempelsvar

{
  "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 som utförts.

HealthCheckResult

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

SessionHost

Representerar en SessionHost-definition.

SessionHostHealthCheckFailureDetails

Innehåller information om felet.

SessionHostHealthCheckReport

Rapporten för sessionsvärdinformation.

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

Molnfelobjekt.

Name Typ Description
error

CloudErrorProperties

Egenskaper för molnfelobjekt.

CloudErrorProperties

Egenskaper för molnfelobjekt.

Name Typ Description
code

string

Felkod

message

string

Felmeddelande som anger varför åtgärden misslyckades.

createdByType

Den typ av identitet som skapade resursen.

Name Typ Description
Application

string

Key

string

ManagedIdentity

string

User

string

HealthCheckName

Representerar namnet på den hälsokontroll som utförts.

Name Typ Description
AppAttachHealthCheck

string

Verifierar att AppAttachService är felfri (det uppstod inga problem under paketlagringen). AppAttachService används för att aktivera mellanlagring/registrering (och eventuell avregistrering/destaging) av MSIX-appar som har konfigurerats av klientadministratören. Detta kontrollerar om komponenten hade några fel under paketlagringen. Fel vid mellanlagring hindrar vissa MSIX-appar från att fungera korrekt för slutanvändaren. Om den här kontrollen misslyckas är den inte dödlig och datorn fortfarande kan hantera anslutningar. Huvudproblemet kan vara att vissa appar inte fungerar för slutanvändare. (För närvarande aktiverat)

DomainJoinedCheck

string

Verifierar att SessionHost är ansluten till en domän. Om den här kontrollen misslyckas klassificeras den som dödlig eftersom ingen anslutning kan lyckas om SessionHost inte är ansluten till domänen. (För närvarande aktiverat)

DomainReachable

string

Verifierar att domänen som SessionHost är ansluten till fortfarande kan nås. Om den här kontrollen misslyckas klassificeras den som dödlig eftersom ingen anslutning kan lyckas om domänen som SessionHost är ansluten inte kan nås vid tidpunkten för anslutningen. (För närvarande inaktiverad)

DomainTrustCheck

string

Verifierar att SessionHost inte har problem med domänförtroende som förhindrar autentisering på SessionHost vid anslutningstid när sessionen skapas. Om den här kontrollen misslyckas klassificeras den som dödlig eftersom ingen anslutning kan lyckas om vi inte kan nå domänen för autentisering på SessionHost. (För närvarande aktiverat)

FSLogixHealthCheck

string

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 som dödlig som ä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)

MetaDataServiceCheck

string

Verifierar att metadatatjänsten är tillgänglig och returnerar beräkningsegenskaper. (För närvarande aktiverat)

MonitoringAgentCheck

string

Verifierar att den genèveagent som krävs körs. Om den här kontrollen misslyckas är den inte dödlig och datorn fortfarande kan hantera anslutningar. Huvudproblemet kan vara att övervakningsagenten saknas eller kör (möjligen) äldre version. (För närvarande aktiverat)

SupportedEncryptionCheck

string

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 dödlig. Om värdet är 1 (SecurityLayer.Negotiate) misslyckas den här kontrollen med felkoden = NativeMethodErrorCode.ERROR_SUCCESS och är inte dödlig. (För närvarande inaktiverad)

SxSStackListenerCheck

string

Verifierar att SxS-stacken är igång så att anslutningarna kan lyckas. Om den här kontrollen misslyckas klassificeras den som dödlig eftersom ingen anslutning kan lyckas om SxS-stacken inte är klar. (För närvarande aktiverat)

UrlsAccessibleCheck

string

Verifierar att den nödvändiga WVD-tjänsten och Genève-URL:er kan nås från SessionHost. Dessa URL:er är: RdTokenUri, RdBrokerURI, RdDiagnosticsUri och lagringsblob-URL:er för agentövervakning (genève). Om den här kontrollen misslyckas är den inte dödlig och datorn fortfarande kan betjäna anslutningar. Huvudproblemet kan vara att övervakningsagenten inte kan lagra varma sökvägsdata (loggar, åtgärder ...). (För närvarande inaktiverad)

WebRTCRedirectorCheck

string

Verifierar om WebRTCRedirector-komponenten är felfri. WebRTCRedirector-komponenten 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 den inte dödlig och datorn fortfarande kan hantera anslutningar. Huvudproblemet kan vara att WebRTCRedirector-komponenten måste startas om eller uppdateras. (För närvarande inaktiverad)

HealthCheckResult

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

Name Typ Description
HealthCheckFailed

string

Hälsokontrollen misslyckades.

HealthCheckSucceeded

string

Hälsokontroll har godkänts.

SessionHostShutdown

string

Vi fick ett avstängningsmeddelande.

Unknown

string

Hälsokontrollresultatet är för närvarande inte känt.

SessionHost

Representerar en SessionHost-definition.

Name Typ Description
id

string

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

Sista hjärtslag från SessionHost.

properties.lastUpdateTime

string

Tidsstämpeln för den senaste uppdateringen.

properties.objectId

string

ObjectId för SessionHost. (intern användning)

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

Antal sessioner på SessionHost.

properties.status

Status

Status för en SessionHost.

properties.statusTimestamp

string

Tidsstämpeln för statusen.

properties.sxSStackVersion

string

Versionen av stacken sida vid sida på sessionsvärden.

properties.updateErrorMessage

string

Felmeddelandet.

properties.updateState

UpdateState

Uppdatera tillståndet för en SessionHost.

properties.virtualMachineId

string

Virtuell 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

Innehåller information om felet.

Name Typ Description
errorCode

integer

Felkod som motsvarar felet.

lastHealthCheckDateTime

string

Tidsstämpeln för den senaste uppdateringen.

message

string

Felmeddelande: antyder vad som är fel och hur du återställer.

SessionHostHealthCheckReport

Rapporten för sessionsvärdinformation.

Name Typ Description
additionalFailureDetails

SessionHostHealthCheckFailureDetails

Ytterligare detaljerad information om felet.

healthCheckName

HealthCheckName

Representerar namnet på den hälsokontroll som utförts.

healthCheckResult

HealthCheckResult

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

Status

Status för en SessionHost.

Name Typ Description
Available

string

Sessionsvärden har klarat alla hälsokontroller och är tillgänglig för att hantera anslutningar.

Disconnected

string

Sessionsvärden är inte tillgänglig eftersom den för närvarande är frånkopplad.

DomainTrustRelationshipLost

string

SessionHosts domänförtroenderelation har förlorats

FSLogixNotHealthy

string

FSLogix är i ett feltillstånd på sessionsvärden.

NeedsAssistance

string

Ny status för att informera administratörer om att hälsotillståndet på slutpunkten måste åtgärdas. Anslutningarna kanske inte misslyckas eftersom dessa problem inte är allvarliga.

NoHeartbeat

string

Sessionsvärden är inte hjärtslagande.

NotJoinedToDomain

string

SessionHost är inte anslutet till domänen.

Shutdown

string

Sessionsvärden stängs av – rd-agenten rapporterade att sessionsvärden skulle stoppas eller frigöras.

SxSStackListenerNotReady

string

SxS-stacken som är installerad på SessionHost är inte redo att ta emot anslutningar.

Unavailable

string

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 tidigare "NoHeartBeat"-status.

UpgradeFailed

string

Sessionsvärden är inte tillgänglig eftersom uppgraderingen av den kritiska komponenten (agenten, stacken sida vid sida osv.) misslyckades.

Upgrading

string

Sessionsvärden är inte tillgänglig eftersom det pågår en uppgradering av RDAgent/sida vid sida-stack. Obs! Det här tillståndet tas bort när uppgraderingen är klar och värden kan acceptera anslutningar.

systemData

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

Name Typ Description
createdAt

string

Tidsstämpeln för resursskapande (UTC).

createdBy

string

Identiteten som skapade resursen.

createdByType

createdByType

Den typ av identitet som skapade resursen.

lastModifiedAt

string

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

Uppdatera tillståndet för en SessionHost.

Name Typ Description
Failed

string

Initial

string

Pending

string

Started

string

Succeeded

string