Session Hosts - Get

Serviço:: Desktop Virtualization

Versão da API:: 2025-10-10

Obtenha um host de sessão.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	O nome do pool de host dentro do grupo de recursos especificado
resourceGroupName	path	True	string minLength: 1 maxLength: 90	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
sessionHostName	path	True	string minLength: 3 maxLength: 48 pattern: ^[A-Za-z0-9@.\-_ ]*$	O nome do host da sessão dentro do pool de host especificado
subscriptionId	path	True	string (uuid)	A ID da assinatura de destino. O valor deve ser uma UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Respostas

Nome	Tipo	Description
200 OK	SessionHost	Recuperei com sucesso o host da sessão.
Other Status Codes	CloudError	Resposta de erro de automação descrevendo por que a operação falhou.

Exemplos

SessionHost_Get

Solicitação de exemplo

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

Resposta de exemplo

Código de status:: 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"
        }
      }
    ]
  }
}

Definições

Nome	Description
CloudError	Objeto de erro na nuvem.
CloudErrorProperties	Propriedades do objeto de erro na nuvem.
createdByType	O tipo de identidade que criou o recurso.
HealthCheckName	Representa o nome da operação de verificação de integridade executada.
HealthCheckResult	Representa o estado de integridade da verificação de integridade que realizamos.
SessionHost	Representa uma definição de SessionHost.
SessionHostHealthCheckFailureDetails	Contém detalhes sobre a falha.
SessionHostHealthCheckReport	O relatório para informações do host da sessão.
Status	Status de um SessionHost.
systemData	Metadados relativos à criação e última modificação do recurso.
UpdateState	Atualize o estado de um SessionHost.

CloudError

Objeto

Objeto de erro na nuvem.

Nome	Tipo	Description
error	CloudErrorProperties	Propriedades do objeto de erro na nuvem.

CloudErrorProperties

Objeto

Propriedades do objeto de erro na nuvem.

Nome	Tipo	Description
code	string	Código do erro
message	string	Mensagem de erro indicando por que a operação falhou.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
User
Application
ManagedIdentity
Key

HealthCheckName

Enumeração

Representa o nome da operação de verificação de integridade executada.

Valor	Description
DomainJoinedCheck	Verifica se o SessionHost está ingressado em um domínio. Se essa verificação falhar, será classificada como fatal, pois nenhuma conexão poderá ser bem-sucedida se o SessionHost não estiver ingressado no domínio. (Atualmente ativado)
DomainTrustCheck	Verifica se o SessionHost não está enfrentando problemas de confiança de domínio que impedirão a autenticação no SessionHost no momento da conexão quando a sessão for criada. Se essa verificação falhar, será classificada como fatal, pois nenhuma conexão poderá ser bem-sucedida se não pudermos acessar o domínio para autenticação no SessionHost. (Atualmente ativado)
FSLogixHealthCheck	Verifica se o serviço FSLogix está ativo e em execução para garantir que os perfis dos usuários sejam carregados na sessão. Se essa verificação falhar, será classificada como fatal, pois mesmo que a conexão possa ser bem-sucedida, a experiência do usuário será ruim, pois o perfil do usuário não poderá ser carregado e o usuário obterá um perfil temporário na sessão. (Atualmente desativado)
SxSStackListenerCheck	Verifica se a pilha SxS está ativa e em execução para que as conexões possam ser bem-sucedidas. Se essa verificação falhar, será classificada como fatal, pois nenhuma conexão poderá ser bem-sucedida se a pilha SxS não estiver pronta. (Atualmente ativado)
UrlsAccessibleCheck	Verifica se o serviço WVD necessário e as URLs Geneva podem ser acessadas a partir do SessionHost. Essas URLs são: RdTokenUri, RdBrokerURI, RdDiagnosticsUri e URLs de blob de armazenamento para monitoramento de agente (genebra). Se essa verificação falhar, não é fatal e a máquina ainda pode atender às conexões, o principal problema pode ser que o agente de monitoramento não consiga armazenar dados de caminho quente (logs, operações ...). (Atualmente desativado)
MonitoringAgentCheck	Verifica se o agente Geneva necessário está em execução. Se essa verificação falhar, ela não é fatal e a máquina ainda pode atender às conexões, o principal problema pode ser que o agente de monitoramento esteja ausente ou executando (possivelmente) uma versão mais antiga. (Atualmente ativado)
DomainReachable	Verifica se o domínio ao qual o SessionHost está ingressado ainda está acessível. Se essa verificação falhar, será classificada como fatal, pois nenhuma conexão poderá ser bem-sucedida se o domínio ao qual o SessionHost está ingressado não estiver acessível no momento da conexão. (Atualmente desativado)
WebRTCRedirectorCheck	Verifica se o componente WebRTCRedirector está íntegro. O componente WebRTCRedirector é usado para otimizar o desempenho de vídeo e áudio no Microsoft Teams. Isso verifica se o componente ainda está em execução e se há uma versão superior disponível. Se essa verificação falhar, não é fatal e a máquina ainda pode atender às conexões, o principal problema pode ser que o componente WebRTCRedirector precise ser reiniciado ou atualizado. (Atualmente desativado)
SupportedEncryptionCheck	Verifica o valor da chave de registro SecurityLayer. Se o valor for 0 (SecurityLayer.RDP), essa verificação falhará com o código de erro = NativeMethodErrorCode.E_FAIL e será fatal. Se o valor for 1 (SecurityLayer.Negotiate), essa verificação falhará com o código de erro = NativeMethodErrorCode.ERROR_SUCCESS e não será fatal. (Atualmente desativado)
MetaDataServiceCheck	Verifica se o serviço de metadados está acessível e retorna propriedades de computação. (Atualmente ativado)
AppAttachHealthCheck	Verifica se o AppAttachService está íntegro (não houve problemas durante o preparo do pacote). O AppAttachService é usado para habilitar o staging/registro (e eventual desregistro/desestaging) dos aplicativos MSIX configurados pelo administrador do tenant. Isso verifica se o componente teve alguma falha durante o estágio do pacote. Falhas no preparo impedirão que alguns aplicativos MSIX funcionem corretamente para o usuário final. Se essa verificação falhar, não é fatal e a máquina ainda pode atender às conexões, o principal problema pode ser que certos aplicativos não funcionem para os usuários finais. (Atualmente ativado)

HealthCheckResult

Enumeração

Representa o estado de integridade da verificação de integridade que realizamos.

Valor	Description
Unknown	O resultado da verificação de integridade não é conhecido no momento.
HealthCheckSucceeded	Verificação de saúde aprovada.
HealthCheckFailed	Falha na verificação de integridade.
SessionHostShutdown	Recebemos uma notificação de desligamento.

SessionHost

Objeto

Representa uma definição de SessionHost.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.agentVersion	string	Versão do agente em SessionHost.
properties.allowNewSession	boolean	Permita uma nova sessão.
properties.assignedUser	string	Usuário atribuído a SessionHost.
properties.friendlyName	string	Nome amigável de SessionHost
properties.lastHeartBeat	string (date-time)	Última batida cardíaca de SessionHost.
properties.lastUpdateTime	string (date-time)	O carimbo de data/hora da última atualização.
properties.objectId	string	ObjectId de SessionHost. (uso interno)
properties.osVersion	string	A versão do sistema operacional no host da sessão.
properties.resourceId	string	ID do recurso da máquina virtual subjacente do SessionHost.
properties.sessionHostHealthCheckResults	SessionHostHealthCheckReport[]	Lista de SessionHostHealthCheckReports
properties.sessions	integer (int32)	Número de sessões no SessionHost.
properties.status	Status	Status de um SessionHost.
properties.statusTimestamp	string (date-time)	O carimbo de data/hora do status.
properties.sxSStackVersion	string	A versão da pilha lado a lado no host da sessão.
properties.updateErrorMessage	string	A mensagem de erro.
properties.updateState	UpdateState	Atualize o estado de um SessionHost.
properties.virtualMachineId	string	ID da máquina virtual da máquina virtual subjacente do SessionHost.
systemData	systemData	Metadados relativos à criação e última modificação do recurso.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SessionHostHealthCheckFailureDetails

Objeto

Contém detalhes sobre a falha.

Nome	Tipo	Description
errorCode	integer (int32)	Código de erro correspondente à falha.
lastHealthCheckDateTime	string (date-time)	O carimbo de data/hora da última atualização.
message	string	Mensagem de falha: dicas sobre o que está errado e como recuperar.

SessionHostHealthCheckReport

Objeto

O relatório para informações do host da sessão.

Nome	Tipo	Description
additionalFailureDetails	SessionHostHealthCheckFailureDetails	Informações detalhadas adicionais sobre a falha.
healthCheckName	HealthCheckName	Representa o nome da operação de verificação de integridade executada.
healthCheckResult	HealthCheckResult	Representa o estado de integridade da verificação de integridade que realizamos.

Status

Enumeração

Status de um SessionHost.

Valor	Description
Available	O Host da Sessão passou em todas as verificações de integridade e está disponível para lidar com conexões.
Unavailable	O host da sessão está desativado ou falhou nas verificações críticas de integridade, o que está fazendo com que o serviço não consiga rotear conexões para esse host da sessão. Observe que isso substitui o status anterior 'NoHeartBeat'.
Shutdown	O Host da Sessão foi desligado – o Agente da Área de Trabalho Remota relatou que o host da sessão foi interrompido ou desalocado.
Disconnected	O Host da Sessão não está disponível porque está desconectado no momento.
Upgrading	O Host da Sessão não está disponível porque atualmente uma atualização da pilha RDAgent/lado a lado está em andamento. Observação: esse estado será removido assim que a atualização for concluída e o host puder aceitar conexões.
UpgradeFailed	O Host da Sessão não está disponível porque a atualização do componente crítico (agente, pilha lado a lado, etc.) falhou.
NoHeartbeat	O anfitrião da sessão não está batendo o coração.
NotJoinedToDomain	SessionHost não está ingressado no domínio.
DomainTrustRelationshipLost	Relação de confiança de domínio do SessionHost perdida
SxSStackListenerNotReady	A pilha SxS instalada no SessionHost não está pronta para receber conexões.
FSLogixNotHealthy	FSLogix está em um estado não íntegro no host da sessão.
NeedsAssistance	Novo status para informar aos administradores que a integridade em seu endpoint precisa ser corrigida. As conexões podem não falhar, pois esses problemas não são fatais.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

UpdateState

Enumeração

Atualize o estado de um SessionHost.

Valor	Description
Initial
Pending
Started
Succeeded
Failed

Compartilhar via

Session Hosts - Get

Parâmetros de URI

Respostas

Exemplos

SessionHost_Get

Solicitação de exemplo

Resposta de exemplo

Definições

CloudError

CloudErrorProperties

createdByType

HealthCheckName

HealthCheckResult

SessionHost

SessionHostHealthCheckFailureDetails

SessionHostHealthCheckReport

Status

systemData

UpdateState