Session Hosts - Get

Servicio:: Desktop Virtualization

Versión de la API:: 2025-10-10

Consigue un host de sesión.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	El nombre del grupo de hosts dentro del grupo de recursos especificado
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
sessionHostName	path	True	string minLength: 3 maxLength: 48 pattern: ^[A-Za-z0-9@.\-_ ]*$	El nombre del host de sesión dentro del grupo de hosts especificado
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de API que se usará para la operación.

Respuestas

Nombre	Tipo	Description
200 OK	SessionHost	Recuperé con éxito el anfitrión de sesión.
Other Status Codes	CloudError	Respuesta de error de automatización que describe por qué falló la operación.

Ejemplos

SessionHost_Get

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre	Description
CloudError	Objeto de error en la nube.
CloudErrorProperties	Propiedades del objeto de error en la nube.
createdByType	Tipo de identidad que creó el recurso.
HealthCheckName	Representa el nombre de la operación de comprobación de estado realizada.
HealthCheckResult	Representa el estado de mantenimiento de la comprobación de estado que realizamos.
SessionHost	Representa una definición de SessionHost.
SessionHostHealthCheckFailureDetails	Contiene detalles sobre el error.
SessionHostHealthCheckReport	El informe de información del host de sesión.
Status	Estado de un SessionHost.
systemData	Metadatos relativos a la creación y última modificación del recurso.
UpdateState	Actualizar el estado de un SessionHost.

CloudError

Objeto

Objeto de error en la nube.

Nombre	Tipo	Description
error	CloudErrorProperties	Propiedades del objeto de error en la nube.

CloudErrorProperties

Objeto

Propiedades del objeto de error en la nube.

Nombre	Tipo	Description
code	string	Código de error
message	string	Mensaje de error que indica por qué se produjo un error en la operación.

createdByType

Enumeración

Tipo de identidad que creó el recurso.

Valor	Description
User
Application
ManagedIdentity
Key

HealthCheckName

Enumeración

Representa el nombre de la operación de comprobación de estado realizada.

Valor	Description
DomainJoinedCheck	Comprueba que SessionHost está unido a un dominio. Si se produce un error en esta comprobación, se clasifica como grave, ya que ninguna conexión puede realizarse correctamente si SessionHost no está unido al dominio. (Actualmente habilitado)
DomainTrustCheck	Comprueba que SessionHost no experimenta problemas de confianza de dominio que impidan la autenticación en SessionHost en el momento de la conexión cuando se crea la sesión. Si esta comprobación falla, se clasifica como fatal, ya que ninguna conexión puede tener éxito si no podemos llegar al dominio para la autenticación en SessionHost. (Actualmente habilitado)
FSLogixHealthCheck	Verifica que el servicio FSLogix esté en funcionamiento para asegurarse de que los perfiles de los usuarios se carguen en la sesión. Si esta comprobación falla se clasifica como fatal, ya que incluso si la conexión puede tener éxito, la experiencia del usuario es mala, ya que el perfil de usuario no se puede cargar y el usuario obtendrá un perfil temporal en la sesión. (Actualmente deshabilitado)
SxSStackListenerCheck	Comprueba que la pila SxS está en funcionamiento para que las conexiones puedan realizarse correctamente. Si esta comprobación falla, se clasifica como irrecuperable, ya que ninguna conexión puede realizarse correctamente si la pila SxS no está lista. (Actualmente habilitado)
UrlsAccessibleCheck	Comprueba que se puede acceder al servicio WVD requerido y a las direcciones URL de Ginebra desde SessionHost. Estas direcciones URL son: RdTokenUri, RdBrokerURI, RdDiagnosticsUri y direcciones URL de blobs de almacenamiento para la supervisión de agentes (ginebra). Si esta comprobación falla, no es fatal y la máquina aún puede dar servicio a las conexiones, el problema principal puede ser que el agente de monitoreo no pueda almacenar datos de ruta caliente (registros, operaciones ...). (Actualmente deshabilitado)
MonitoringAgentCheck	Comprueba que el agente de Ginebra requerido se está ejecutando. Si esta verificación falla, no es fatal y la máquina aún puede dar servicio a las conexiones, el problema principal puede ser que falta el agente de monitoreo o se ejecuta (posiblemente) una versión anterior. (Actualmente habilitado)
DomainReachable	Comprueba que el dominio al que está unido SessionHost sigue siendo accesible. Si se produce un error en esta comprobación, se clasifica como grave, ya que ninguna conexión puede realizarse correctamente si no se puede acceder al dominio al que se une SessionHost en el momento de la conexión. (Actualmente deshabilitado)
WebRTCRedirectorCheck	Comprueba si el componente WebRTCRedirector está en buen estado. El componente WebRTCRedirector se usa para optimizar el rendimiento de vídeo y audio en Microsoft Teams. Esto comprueba si el componente todavía se está ejecutando y si hay una versión superior disponible. Si esta verificación falla, no es fatal y la máquina aún puede reparar las conexiones, el problema principal puede ser que el componente WebRTCRedirector debe reiniciarse o actualizarse. (Actualmente deshabilitado)
SupportedEncryptionCheck	Comprueba el valor de la clave de registro de SecurityLayer. Si el valor es 0 (SecurityLayer.RDP), se produce un error en esta comprobación con el código de error = NativeMethodErrorCode.E_FAIL y es grave. Si el valor es 1 (SecurityLayer.Negotiate), se produce un error en esta comprobación con el código de error = NativeMethodErrorCode.ERROR_SUCCESS y no es grave. (Actualmente deshabilitado)
MetaDataServiceCheck	Comprueba que el servicio de metadatos es accesible y devuelve propiedades de proceso. (Actualmente habilitado)
AppAttachHealthCheck	Comprueba que AppAttachService está en buen estado (no hubo problemas durante el almacenamiento provisional de paquetes). AppAttachService se utiliza para habilitar el staging/registro (y eventual desregistro/desestaging) de las aplicaciones MSIX configuradas por el administrador del inquilino. Esto comprueba si el componente ha tenido fallos durante la preparación del paquete. Los errores en el ensayo impedirán que algunas aplicaciones MSIX funcionen correctamente para el usuario final. Si esta verificación falla, no es fatal y la máquina aún puede dar servicio a las conexiones, el problema principal puede ser que ciertas aplicaciones no funcionen para los usuarios finales. (Actualmente habilitado)

HealthCheckResult

Enumeración

Representa el estado de mantenimiento de la comprobación de estado que realizamos.

Valor	Description
Unknown	Actualmente se desconoce el resultado de la comprobación de estado.
HealthCheckSucceeded	Se ha superado la comprobación de estado.
HealthCheckFailed	Error en la comprobación de estado.
SessionHostShutdown	Recibimos una notificación de apagado.

SessionHost

Objeto

Representa una definición de SessionHost.

Nombre	Tipo	Description
id	string (arm-id)	Identificador de recurso completo para el recurso. Por ejemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	Nombre del recurso
properties.agentVersion	string	Versión del agente en SessionHost.
properties.allowNewSession	boolean	Permitir una nueva sesión.
properties.assignedUser	string	Usuario asignado a SessionHost.
properties.friendlyName	string	Nombre descriptivo de SessionHost
properties.lastHeartBeat	string (date-time)	Último latido del corazón de SessionHost.
properties.lastUpdateTime	string (date-time)	La marca de tiempo de la última actualización.
properties.objectId	string	ObjectId de SessionHost. (uso interno)
properties.osVersion	string	La versión del sistema operativo en el host de sesión.
properties.resourceId	string	Identificador de recurso de la máquina virtual subyacente de SessionHost.
properties.sessionHostHealthCheckResults	SessionHostHealthCheckReport[]	Lista de SessionHostHealthCheckReports
properties.sessions	integer (int32)	Número de sesiones en SessionHost.
properties.status	Status	Estado de un SessionHost.
properties.statusTimestamp	string (date-time)	Marca de tiempo del estado.
properties.sxSStackVersion	string	La versión de la pila en paralelo en el host de sesión.
properties.updateErrorMessage	string	El mensaje de error.
properties.updateState	UpdateState	Actualizar el estado de un SessionHost.
properties.virtualMachineId	string	Identificador de máquina virtual de la máquina virtual subyacente de SessionHost.
systemData	systemData	Metadatos relativos a la creación y última modificación del recurso.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

SessionHostHealthCheckFailureDetails

Objeto

Contiene detalles sobre el error.

Nombre	Tipo	Description
errorCode	integer (int32)	Código de error correspondiente al error.
lastHealthCheckDateTime	string (date-time)	La marca de tiempo de la última actualización.
message	string	Mensaje de falla: sugerencias sobre lo que está mal y cómo recuperarse.

SessionHostHealthCheckReport

Objeto

El informe de información del host de sesión.

Nombre	Tipo	Description
additionalFailureDetails	SessionHostHealthCheckFailureDetails	Información detallada adicional sobre la falla.
healthCheckName	HealthCheckName	Representa el nombre de la operación de comprobación de estado realizada.
healthCheckResult	HealthCheckResult	Representa el estado de mantenimiento de la comprobación de estado que realizamos.

Status

Enumeración

Estado de un SessionHost.

Valor	Description
Available	El host de sesión ha superado todas las comprobaciones de estado y está disponible para gestionar las conexiones.
Unavailable	El host de sesión está desactivado o no ha superado las comprobaciones de estado críticas, lo que hace que el servicio no pueda enrutar las conexiones a este host de sesión. Tenga en cuenta que esto reemplaza el estado anterior 'NoHeartBeat'.
Shutdown	El host de sesión está apagado: el Agente de Escritorio remoto notificó que el host de sesión se detuvo o desasignó.
Disconnected	El host de sesión no está disponible porque actualmente está desconectado.
Upgrading	El host de sesión no está disponible porque actualmente hay una actualización de RDAgent o pila en paralelo. Nota: este estado se eliminará una vez que se complete la actualización y el host pueda aceptar conexiones.
UpgradeFailed	El host de sesión no está disponible porque se produjo un error en la actualización de componentes críticos (agente, pila en paralelo, etc.).
NoHeartbeat	El anfitrión de la sesión no está latiendo el corazón.
NotJoinedToDomain	SessionHost no está unido al dominio.
DomainTrustRelationshipLost	Se perdió la relación de confianza de dominio de SessionHost
SxSStackListenerNotReady	La pila SxS instalada en SessionHost no está lista para recibir conexiones.
FSLogixNotHealthy	FSLogix se encuentra en un estado incorrecto en el host de sesión.
NeedsAssistance	Nuevo estado para informar a los administradores de que es necesario corregir el estado de su punto de conexión. Es posible que las conexiones no fallen, ya que estos problemas no son fatales.

systemData

Objeto

Metadatos relativos a la creación y última modificación del recurso.

Nombre	Tipo	Description
createdAt	string (date-time)	Marca de tiempo de creación de recursos (UTC).
createdBy	string	Identidad que creó el recurso.
createdByType	createdByType	Tipo de identidad que creó el recurso.
lastModifiedAt	string (date-time)	Marca de tiempo de la última modificación del recurso (UTC)
lastModifiedBy	string	Identidad que modificó por última vez el recurso.
lastModifiedByType	createdByType	Tipo de identidad que modificó por última vez el recurso.

UpdateState

Enumeración

Actualizar el estado de un SessionHost.

Valor	Description
Initial
Pending
Started
Succeeded
Failed

Compartir a través de

Session Hosts - Get

Parámetros de identificador URI

Respuestas

Ejemplos

SessionHost_Get

Solicitud de ejemplo

Respuesta de muestra

Definiciones

CloudError

CloudErrorProperties

createdByType

HealthCheckName

HealthCheckResult

SessionHost

SessionHostHealthCheckFailureDetails

SessionHostHealthCheckReport

Status

systemData

UpdateState