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=2022-02-10-preview

URI-parametrar

Name In Required Type Description
hostPoolName
path True
  • string

Namnet på värdpoolen i den angivna resursgruppen

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

subscriptionId
path True
  • string

ID för målprenumerationen.

api-version
query True
  • string

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

Svar

Name Type Description
200 OK

Sessionsvärden har hämtats.

Other Status Codes

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

Exempel

SessionHost_Get

Sample Request

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

Sample Response

{
  "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

CloudError

Molnfelobjekt.

CloudErrorProperties

Egenskaper för molnfelobjekt.

createdByType

Den typ av identitet som skapade resursen.

HealthCheckName

Representerar namnet på hälsokontrollåtgärden 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

Uppdateringstillstånd för en SessionHost.

CloudError

Molnfelobjekt.

Name Type Description
error

Egenskaper för molnfelobjekt.

CloudErrorProperties

Egenskaper för molnfelobjekt.

Name Type Description
code
  • string

Felkod

message
  • string

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

createdByType

Den typ av identitet som skapade resursen.

Name Type Description
Application
  • string
Key
  • string
ManagedIdentity
  • string
User
  • string

HealthCheckName

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

Name Type Description
AppAttachHealthCheck
  • string

Verifierar att AppAttachService är felfri (det uppstod inga problem under mellanlagringen av paket). 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 mellanlagringen av paketet. Fel vid mellanlagring förhindrar att vissa MSIX-appar fungerar 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ändarna.

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.

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 SessionHost är ansluten inte kan nås vid tidpunkten för anslutningen.

DomainTrustCheck
  • string

Verifierar att SessionHost inte har domänförtroendeproblem som förhindrar autentisering på SessionHost vid anslutningstiden 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.

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 den som dödlig som även om anslutningen kan lyckas, användarupplevelsen är dålig eftersom användarprofilen inte kan läsas in och användaren får en tillfällig profil i sessionen.

MetaDataServiceCheck
  • string

Verifierar att metadatatjänsten är tillgänglig och returnerar beräkningsegenskaper.

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 kan fortfarande hantera anslutningar. Huvudproblemet kan vara att övervakningsagenten saknas eller körs (möjligen) äldre version.

SupportedEncryptionCheck
  • string

Verifierar värdet för SecurityLayer-registreringsnyckeln. Om värdet är 0 (SecurityLayer.RDP) misslyckas den här kontrollen med felkoden = NativeMethodErrorCode.E_FAIL och är dödlig. Om värdet är 1 (SecurityLayer.Negotiate) misslyckas den här kontrollen med Felkod = NativeMethodErrorCode.ERROR_SUCCESS och är inte dödlig.

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.

UrlsAccessibleCheck
  • string

Verifierar att nödvändiga WVD-tjänst- 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 kan fortfarande hantera anslutningar. Huvudproblemet kan vara att övervakningsagenten inte kan lagra varma sökvägsdata (loggar, åtgärder ...).

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 kan fortfarande hantera anslutningar. Huvudproblemet kan vara att WebRTCRedirector-komponenten måste startas om eller uppdateras.

HealthCheckResult

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

Name Type Description
HealthCheckFailed
  • string

Hälsokontrollen misslyckades.

HealthCheckSucceeded
  • string

Hälsokontrollen har godkänts.

SessionHostShutdown
  • string

Vi har fått ett avstängningsmeddelande.

Unknown
  • string

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

SessionHost

Representerar en SessionHost-definition.

Name Type Description
id
  • string

Fullständigt kvalificerat resurs-ID för resursen. 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

Senaste 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

Lista över SessionHostHealthCheckReports

properties.sessions
  • integer

Antal sessioner på SessionHost.

properties.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

Uppdateringstillstånd för en SessionHost.

properties.virtualMachineId
  • string

ID för virtuell dator för SessionHosts underliggande virtuella dator.

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 Type Description
errorCode
  • integer

Felkod som motsvarar felet.

lastHealthCheckDateTime
  • string

Tidsstämpeln för den senaste uppdateringen.

message
  • string

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

SessionHostHealthCheckReport

Rapporten för sessionsvärdinformation.

Name Type Description
additionalFailureDetails

Ytterligare detaljerad information om felet.

healthCheckName

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

healthCheckResult

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

Status

Status för en SessionHost.

Name Type 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 förlorad

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å deras slutpunkt måste åtgärdas. Anslutningarna kanske inte misslyckas eftersom de här problemen inte är allvarliga.

NoHeartbeat
  • string

Sessionsvärden är inte hjärtslagande.

NotJoinedToDomain
  • string

SessionHost är inte ansluten till domänen.

Shutdown
  • string

Sessionsvärden stängs av – Rd Agent 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 som 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 den kritiska komponentuppgradningen (agent, sida vid sida-stack osv.) misslyckades.

Upgrading
  • string

Sessionsvärden är inte tillgänglig eftersom en uppgradering av RDAgent/sida-vid-sida-stack pågår. 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 Type Description
createdAt
  • string

Tidsstämpeln för resursskapande (UTC).

createdBy
  • string

Identiteten som skapade resursen.

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

Den typ av identitet som senast ändrade resursen.

UpdateState

Uppdateringstillstånd för en SessionHost.

Name Type Description
Failed
  • string
Initial
  • string
Pending
  • string
Started
  • string
Succeeded
  • string