Session Hosts - Get

Service:

Desktop Virtualization

API Version:

2022-02-10-preview

Ottenere un host di sessione.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
hostPoolName	path	True	string	Nome del pool di host all'interno del gruppo di risorse specificato
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
sessionHostName	path	True	string	Nome dell'host di sessione all'interno del pool di host specificato
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Risposte

Nome	Tipo	Descrizione
200 OK	SessionHost	Host sessione recuperato correttamente.
Other Status Codes	CloudError	Risposta di errore di automazione che descrive perché l'operazione non è riuscita.

Esempio

SessionHost_Get

Sample Request

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

Go

package armdesktopvirtualization_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/desktopvirtualization/armdesktopvirtualization/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2022-02-10-preview/examples/SessionHost_Get.json
func ExampleSessionHostsClient_Get() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	client, err := armdesktopvirtualization.NewSessionHostsClient("daefabc0-95b4-48b3-b645-8a753a63c4fa", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := client.Get(ctx,
		"resourceGroup1",
		"hostPool1",
		"sessionHost1.microsoft.com",
		nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// TODO: use response item
	_ = res
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

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 errore cloud.
CloudErrorProperties	Proprietà dell'oggetto errore cloud.
createdByType	Tipo di identità che ha creato la risorsa.
HealthCheckName	Rappresenta il nome dell'operazione di controllo dell'integrità eseguita.
HealthCheckResult	Rappresenta lo stato di integrità del controllo di integrità eseguito.
SessionHost	Rappresenta una definizione SessionHost.
SessionHostHealthCheckFailureDetails	Contiene i dettagli sull'errore.
SessionHostHealthCheckReport	Report per le informazioni sull'host sessione.
Status	Stato per un SessionHost.
systemData	Metadati relativi alla creazione e all'ultima modifica della risorsa.
UpdateState	Stato di aggiornamento di un SessionHost.

CloudError

Oggetto errore cloud.

Nome	Tipo	Descrizione
error	CloudErrorProperties	Proprietà dell'oggetto errore cloud.

CloudErrorProperties

Proprietà dell'oggetto errore cloud.

Nome	Tipo	Descrizione
code	string	Codice di errore
message	string	Messaggio di errore che indica perché l'operazione non è riuscita.

createdByType

Tipo di identità che ha creato la risorsa.

Nome	Tipo	Descrizione
Application	string
Key	string
ManagedIdentity	string
User	string

HealthCheckName

Rappresenta il nome dell'operazione di controllo dell'integrità eseguita.

Nome	Tipo	Descrizione
AppAttachHealthCheck	string	Verifica che AppAttachService sia integro (non sono presenti problemi durante la gestione temporanea del pacchetto). AppAttachService viene usato per abilitare la gestione temporanea/registrazione (e la deregistrazione/destaging finale) delle app MSIX configurate dall'amministratore del tenant. In questo modo viene verificato se il componente ha avuto errori durante la gestione temporanea del pacchetto. Gli errori nella gestione temporanea impediscono che alcune app MSIX funzionino correttamente per l'utente finale. Se questo controllo ha esito negativo, non è irreversibile e il computer può comunque eseguire connessioni al servizio, il problema principale potrebbe non funzionare per gli utenti finali.
DomainJoinedCheck	string	Verifica che SessionHost sia aggiunto a un dominio. Se questo controllo non riesce viene classificato come irreversibile perché non è possibile eseguire alcuna connessione se SessionHost non è aggiunto al dominio.
DomainReachable	string	Verifica che il dominio a cui è aggiunto SessionHost sia ancora raggiungibile. Se questo controllo non riesce è classificato come irreversibile perché nessuna connessione può avere esito positivo se il dominio di SessionHost non è raggiungibile al momento della connessione.
DomainTrustCheck	string	Verifica che SessionHost non verifichi problemi di attendibilità del dominio che impediranno l'autenticazione in SessionHost al momento della connessione al momento della creazione della sessione. Se questo controllo non riesce viene classificato come irreversibile perché non è possibile raggiungere il dominio per l'autenticazione in SessionHost.
FSLogixHealthCheck	string	Verifica che il servizio FSLogix sia attivo ed in esecuzione per assicurarsi che i profili degli utenti vengano caricati nella sessione. Se questo controllo non riesce viene classificato come irreversibile anche se la connessione può avere esito positivo, l'esperienza utente non è valida perché il profilo utente non può essere caricato e l'utente otterrà un profilo temporaneo nella sessione.
MetaDataServiceCheck	string	Verifica che il servizio metadati sia accessibile e restituisca le proprietà di calcolo.
MonitoringAgentCheck	string	Verifica che l'agente di Ginevra richiesto sia in esecuzione. Se questo controllo ha esito negativo, non è irreversibile e il computer può comunque eseguire connessioni al servizio, il problema principale potrebbe essere che l'agente di monitoraggio non è presente o è in esecuzione (possibilmente) versione precedente.
SupportedEncryptionCheck	string	Verifica il valore della chiave di registrazione SecurityLayer. Se il valore è 0 (SecurityLayer.RDP) questo controllo ha esito negativo con codice errore = NativeMethodErrorCode.E_FAIL ed è irreversibile. Se il valore è 1 (SecurityLayer.Negotiate) questo controllo ha esito negativo con il codice errore = NativeMethodErrorCode.ERROR_SUCCESS ed è non irreversibile.
SxSStackListenerCheck	string	Verifica che lo stack SxS sia attivo ed in esecuzione in modo che le connessioni possano avere esito positivo. Se questo controllo non riesce viene classificato come irreversibile perché non è possibile eseguire alcuna connessione se lo stack SxS non è pronto.
UrlsAccessibleCheck	string	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 ha esito negativo, non è irreversibile e il computer può comunque eseguire connessioni al servizio, il problema principale potrebbe essere che l'agente di monitoraggio non è in grado di archiviare i dati del percorso ad accesso frequente (log, operazioni ...).
WebRTCRedirectorCheck	string	Verifica se il componente WebRTCRedirector è integro. Il componente WebRTCRedirector viene usato 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 superiore. Se il controllo ha esito negativo, non è irreversibile e il computer può comunque eseguire connessioni al servizio, il problema principale potrebbe essere il componente WebRTCRedirector deve essere riavviato o aggiornato.

HealthCheckResult

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

Nome	Tipo	Descrizione
HealthCheckFailed	string	Controllo integrità non riuscito.
HealthCheckSucceeded	string	Controllo integrità passato.
SessionHostShutdown	string	È stata ricevuta una notifica di arresto.
Unknown	string	Il risultato del controllo integrità non è attualmente noto.

SessionHost

Rappresenta una definizione SessionHost.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ex - /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	Ultimo battito cardiaco da SessionHost.
properties.lastUpdateTime	string	Timestamp dell'ultimo aggiornamento.
properties.objectId	string	ObjectId di SessionHost. (uso interno)
properties.osVersion	string	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	Numero di sessioni in SessionHost.
properties.status	Status	Stato per un SessionHost.
properties.statusTimestamp	string	Timestamp dello stato.
properties.sxSStackVersion	string	Versione dello stack affiancato nell'host della sessione.
properties.updateErrorMessage	string	Messaggio di errore.
properties.updateState	UpdateState	Stato di aggiornamento di un SessionHost.
properties.virtualMachineId	string	ID macchina virtuale della macchina virtuale di SessionHost sottostante.
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

Contiene i dettagli sull'errore.

Nome	Tipo	Descrizione
errorCode	integer	Codice di errore corrispondente all'errore.
lastHealthCheckDateTime	string	Timestamp dell'ultimo aggiornamento.
message	string	Messaggio di errore: hint su ciò che è errato e su come ripristinare.

SessionHostHealthCheckReport

Report per le informazioni sull'host sessione.

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

Status

Stato per un SessionHost.

Nome	Tipo	Descrizione
Available	string	L'host sessione ha passato tutti i controlli di integrità ed è disponibile per gestire le connessioni.
Disconnected	string	L'host sessione non è disponibile perché è attualmente disconnesso.
DomainTrustRelationshipLost	string	Relazione di trust del dominio di SessionHost persa
FSLogixNotHealthy	string	FSLogix si trova in uno stato non integro nell'host della sessione.
NeedsAssistance	string	Nuovo stato per informare gli amministratori che l'integrità dell'endpoint deve essere fissa. Le connessioni potrebbero non riuscire, poiché questi problemi non sono irreversibili.
NoHeartbeat	string	L'host sessione non è il battito cardiaco.
NotJoinedToDomain	string	SessionHost non è aggiunto al dominio.
Shutdown	string	Host sessione è arrestato: l'host sessione segnalato dall'agente DESKTOP remoto deve essere arrestato o deallocato.
SxSStackListenerNotReady	string	Lo stack SxS installato in SessionHost non è pronto per ricevere le connessioni.
Unavailable	string	L'host sessione è disattivato o ha avuto esito negativo nei controlli di integrità critici che causano che il servizio non può instradare le connessioni a questo host di sessione. Si noti che sostituisce lo stato 'NoHeartBeat' precedente.
UpgradeFailed	string	Host sessione non è disponibile perché l'aggiornamento del componente critico (agente, stack side-by-side e così via) non è riuscito.
Upgrading	string	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 è in grado di accettare connessioni.

systemData

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

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

UpdateState

Stato di aggiornamento di un SessionHost.

Nome	Tipo	Descrizione
Failed	string
Initial	string
Pending	string
Started	string
Succeeded	string