Session Hosts - Get

Servizio:

Desktop Virtualization

Versione API:

2025-10-10

Ottenere un host di sessione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Nome del pool di host all'interno del gruppo di risorse specificato
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.
sessionHostName	path	True	string minLength: 3 maxLength: 48 pattern: ^[A-Za-z0-9@.\-_ ]*$	Nome dell'host della sessione all'interno del pool di host specificato
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	SessionHost	Recuperato con successo l'host della sessione.
Other Status Codes	CloudError	Risposta di errore di automazione che descrive il motivo per cui l'operazione non è riuscita.

Esempio

SessionHost_Get

Esempio di richiesta

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

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
CloudError	Oggetto di errore cloud.
CloudErrorProperties	Proprietà dell'oggetto di errore nella nube.
createdByType	Tipo di identità che ha creato la risorsa.
HealthCheckName	Rappresenta il nome dell'operazione di controllo dello stato eseguita.
HealthCheckResult	Rappresenta lo stato di integrità del controllo di integrità eseguito.
SessionHost	Rappresenta una definizione SessionHost.
SessionHostHealthCheckFailureDetails	Contiene i dettagli sull'errore.
SessionHostHealthCheckReport	Rapporto per le informazioni sull'host della sessione.
Status	Stato di un oggetto SessionHost.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
UpdateState	Aggiorna lo stato di un oggetto SessionHost.

CloudError

Oggetto

Oggetto di errore cloud.

Nome	Tipo	Descrizione
error	CloudErrorProperties	Proprietà dell'oggetto di errore nella nube.

CloudErrorProperties

Oggetto

Proprietà dell'oggetto di errore nella nube.

Nome	Tipo	Descrizione
code	string	Codice di errore
message	string	Messaggio di errore che indica il motivo per cui l'operazione non è riuscita.

createdByType

Enumerazione

Tipo di identità che ha creato la risorsa.

Valore	Descrizione
User
Application
ManagedIdentity
Key

HealthCheckName

Enumerazione

Rappresenta il nome dell'operazione di controllo dello stato eseguita.

Valore	Descrizione
DomainJoinedCheck	Verifica che l'oggetto SessionHost sia aggiunto a un dominio. Se questo controllo ha esito negativo, viene classificato come irreversibile in quanto nessuna connessione può avere esito positivo se SessionHost non è aggiunto al dominio. (Attualmente abilitato)
DomainTrustCheck	Verifica che SessionHost non riscontri problemi di attendibilità del dominio che impediranno l'autenticazione su SessionHost al momento della connessione quando viene creata la sessione. Se questo controllo fallisce è classificato come irreversibile in quanto nessuna connessione può avere successo se non riusciamo a raggiungere il dominio per l'autenticazione su SessionHost. (Attualmente abilitato)
FSLogixHealthCheck	Verifica che il servizio FSLogix sia attivo e in esecuzione per assicurarsi che i profili degli utenti vengano caricati nella sessione. Se questo controllo non riesce, viene classificato come irreversibile in quanto anche se la connessione può avere esito positivo, l'esperienza utente è negativa in quanto il profilo utente non può essere caricato e l'utente otterrà un profilo temporaneo nella sessione. (Attualmente disabilitato)
SxSStackListenerCheck	Verifica che lo stack SxS sia attivo e in esecuzione in modo che le connessioni possano avere esito positivo. Se questo controllo ha esito negativo, viene classificato come irreversibile in quanto non è possibile eseguire alcuna connessione se lo stack SxS non è pronto. (Attualmente abilitato)
UrlsAccessibleCheck	Verifica che il servizio WVD richiesto e gli URL di Ginevra siano raggiungibili da SessionHost. Questi URL sono: RdTokenUri, RdBrokerURI, RdDiagnosticsUri e URL BLOB di archiviazione per il monitoraggio dell'agente (ginevra). Se questo controllo fallisce, non è irreversibile e la macchina è ancora in grado di gestire le connessioni, il problema principale potrebbe essere che l'agente di monitoraggio non è in grado di memorizzare i dati del percorso caldo (registri, operazioni...). (Attualmente disabilitato)
MonitoringAgentCheck	Verifica che l'agente Geneva richiesto sia in esecuzione. Se questo controllo non riesce, non è irreversibile e la macchina è ancora in grado di gestire le connessioni, il problema principale potrebbe essere che l'agente di monitoraggio è mancante o esegue (probabilmente) una versione precedente. (Attualmente abilitato)
DomainReachable	Verifica che il dominio a cui è aggiunto SessionHost sia ancora raggiungibile. Se questo controllo ha esito negativo, viene classificato come irreversibile in quanto non è possibile eseguire la connessione se il dominio a cui si è aggiunto SessionHost non è raggiungibile al momento della connessione. (Attualmente disabilitato)
WebRTCRedirectorCheck	Verifica se il componente WebRTCRedirector è integro. Il componente WebRTCRedirector viene utilizzato per ottimizzare le prestazioni video e audio in Microsoft Teams. In questo modo viene verificato se il componente è ancora in esecuzione e se è disponibile una versione successiva. Se questo controllo fallisce, non è irreversibile e la macchina è ancora in grado di gestire le connessioni, il problema principale potrebbe essere che il componente WebRTCRedirector deve essere riavviato o aggiornato. (Attualmente disabilitato)
SupportedEncryptionCheck	Verifica il valore della chiave di registrazione SecurityLayer. Se il valore è 0 (SecurityLayer.RDP), questo controllo ha esito negativo con il codice di errore = NativeMethodErrorCode.E_FAIL ed è irreversibile. Se il valore è 1 (SecurityLayer.Negotiate), questo controllo ha esito negativo con il codice di errore = NativeMethodErrorCode.ERROR_SUCCESS e non è irreversibile. (Attualmente disabilitato)
MetaDataServiceCheck	Verifica che il servizio metadati sia accessibile e restituisca le proprietà di calcolo. (Attualmente abilitato)
AppAttachHealthCheck	Verifica che AppAttachService sia integro (non si sono verificati problemi durante la gestione temporanea del pacchetto). AppAttachService viene utilizzato per abilitare lo staging/registrazione (e eventuale la deregistrazione/deestaging) delle app MSIX configurate dall'amministratore del tenant admin. Questo verifica se il componente ha avuto guasti durante lo staging del pacchetto. Gli errori nella gestione temporanea impediranno ad alcune app MSIX di funzionare correttamente per l'utente finale. Se questo controllo fallisce, non è irreversibile e la macchina è ancora in grado di gestire le connessioni, il problema principale potrebbe essere che alcune app non funzioneranno per gli utenti finali. (Attualmente abilitato)

HealthCheckResult

Enumerazione

Rappresenta lo stato di integrità del controllo di integrità eseguito.

Valore	Descrizione
Unknown	Il risultato del controllo dello stato non è attualmente noto.
HealthCheckSucceeded	Controllo sanitario superato.
HealthCheckFailed	Controllo dello stato non riuscito.
SessionHostShutdown	Abbiamo ricevuto una notifica di chiusura.

SessionHost

Oggetto

Rappresenta una definizione SessionHost.

Nome	Tipo	Descrizione
id	string (arm-id)	ID risorsa completo per la risorsa. Ad esempio, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nome della risorsa
properties.agentVersion	string	Versione dell'agente in SessionHost.
properties.allowNewSession	boolean	Consenti una nuova sessione.
properties.assignedUser	string	Utente assegnato a SessionHost.
properties.friendlyName	string	Nome descrittivo di SessionHost
properties.lastHeartBeat	string (date-time)	Ultimo battito cardiaco da SessionHost.
properties.lastUpdateTime	string (date-time)	Il timestamp dell'ultimo aggiornamento.
properties.objectId	string	ObjectId di SessionHost. (uso interno)
properties.osVersion	string	La versione del sistema operativo nell'host della sessione.
properties.resourceId	string	ID risorsa della macchina virtuale sottostante di SessionHost.
properties.sessionHostHealthCheckResults	SessionHostHealthCheckReport[]	Elenco di SessionHostHealthCheckReports
properties.sessions	integer (int32)	Numero di sessioni su SessionHost.
properties.status	Status	Stato di un oggetto SessionHost.
properties.statusTimestamp	string (date-time)	Timestamp dello stato.
properties.sxSStackVersion	string	Versione dello stack affiancato nell'host della sessione.
properties.updateErrorMessage	string	Messaggio di errore.
properties.updateState	UpdateState	Aggiorna lo stato di un oggetto SessionHost.
properties.virtualMachineId	string	ID macchina virtuale della macchina virtuale sottostante di SessionHost.
systemData	systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SessionHostHealthCheckFailureDetails

Oggetto

Contiene i dettagli sull'errore.

Nome	Tipo	Descrizione
errorCode	integer (int32)	Codice di errore corrispondente all'errore.
lastHealthCheckDateTime	string (date-time)	Il timestamp dell'ultimo aggiornamento.
message	string	Messaggio di errore: suggerimenti su cosa c'è che non va e su come recuperare.

SessionHostHealthCheckReport

Oggetto

Rapporto per le informazioni sull'host della sessione.

Nome	Tipo	Descrizione
additionalFailureDetails	SessionHostHealthCheckFailureDetails	Ulteriori informazioni dettagliate sull'errore.
healthCheckName	HealthCheckName	Rappresenta il nome dell'operazione di controllo dello stato eseguita.
healthCheckResult	HealthCheckResult	Rappresenta lo stato di integrità del controllo di integrità eseguito.

Status

Enumerazione

Stato di un oggetto SessionHost.

Valore	Descrizione
Available	L'host della sessione ha superato tutti i controlli di integrità ed è disponibile per gestire le connessioni.
Unavailable	L'host sessione è disattivato o ha fallito i controlli di integrità critici, causando l'impossibilità per il servizio di instradare le connessioni a questo host di sessione. Si noti che questo sostituisce il precedente stato "NoHeartBeat".
Shutdown	L'host sessione è stato arrestato: l'agente Desktop remoto ha segnalato l'arresto o la deallocazione dell'host sessione.
Disconnected	L'host sessione non è disponibile perché è attualmente disconnesso.
Upgrading	L'host sessione non è disponibile perché è attualmente in corso un aggiornamento dello stack RDAgent/side-by-side. Nota: questo stato verrà rimosso una volta completato l'aggiornamento e l'host sarà in grado di accettare le connessioni.
UpgradeFailed	L'host sessione non è disponibile perché l'aggiornamento del componente critico (agente, stack side-by-side e così via) non è riuscito.
NoHeartbeat	L'host della sessione non batte a cuore.
NotJoinedToDomain	SessionHost non è aggiunto al dominio.
DomainTrustRelationshipLost	Relazione di trust del dominio di SessionHost persa
SxSStackListenerNotReady	Lo stack SxS installato in SessionHost non è pronto per ricevere connessioni.
FSLogixNotHealthy	FSLogix si trova in uno stato non integro nell'host della sessione.
NeedsAssistance	Nuovo stato per informare gli amministratori che l'integrità dell'endpoint deve essere corretta. Le connessioni potrebbero non riuscire, poiché questi problemi non sono irreversibili.

systemData

Oggetto

Metadati relativi alla creazione e all'ultima modifica della risorsa.

Nome	Tipo	Descrizione
createdAt	string (date-time)	Timestamp della creazione della risorsa (UTC).
createdBy	string	Identità che ha creato la risorsa.
createdByType	createdByType	Tipo di identità che ha creato la risorsa.
lastModifiedAt	string (date-time)	Timestamp dell'ultima modifica della risorsa (UTC)
lastModifiedBy	string	Identità che ha modificato l'ultima volta la risorsa.
lastModifiedByType	createdByType	Tipo di identità che ha modificato l'ultima volta la risorsa.

UpdateState

Enumerazione

Aggiorna lo stato di un oggetto SessionHost.

Valore	Descrizione
Initial
Pending
Started
Succeeded
Failed