Session Hosts - Get

Obter um host de sessão.

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

Parâmetros de URI

Name In Required Type Description
hostPoolName
path True
  • string

O nome do pool de host dentro do grupo de recursos especificado

resourceGroupName
path True
  • string

O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.

sessionHostName
path True
  • string

O nome do host da sessão dentro do pool de host especificado

subscriptionId
path True
  • string

A ID da assinatura de destino.

api-version
query True
  • string

A versão da API a ser usada para esta operação.

Respostas

Name Type Description
200 OK

Host de sessão recuperado com êxito.

Other Status Codes

Resposta de erro de automação que descreve por que a operação falhou.

Exemplos

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=2021-01-14-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",
  "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",
    "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

CloudError
CloudErrorProperties
HealthCheckName

Representa o nome da operação de verificação de saúde executada.

HealthCheckResult

Representa o estado de saúde da verificação de saúde 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.

UpdateState

Atualize o estado de um SessionHost.

CloudError

Name Type Description
error

CloudErrorProperties

Name Type Description
code
  • string

Código do erro

message
  • string

Mensagem de erro indicando por que a operação falhou.

HealthCheckName

Representa o nome da operação de verificação de saúde executada.

Name Type Description
AppAttachHealthCheck
  • string

Verifica se o AppAttachService está oso (não houve problemas durante o preparação do pacote). O AppAttachService é usado para habilitar o registro/preparação (e eventual desregistração/desagregação) de aplicativos MSIX que foram definidos pelo administrador do locatário. Isso verifica se o componente teve falhas durante o preparação do pacote. Falhas no preparação impedirão que alguns aplicativos MSIX funcionaam corretamente para o usuário final. Se essa verificação falhar, ela não será fatal e o computador ainda poderá fazer conexões de serviço. O problema principal pode ser que determinados aplicativos não funcionarão para os usuários finais.

DomainJoinedCheck
  • string

Verifica se o SessionHost está ingressado em um domínio. Se essa verificação falhar, será classificado como fatal, pois nenhuma conexão poderá ser bem-sucedida se o SessionHost não estiver ingressado no domínio.

DomainReachable
  • string

Verifica se o domínio ao que o SessionHost está ingressado ainda está acessível. Se essa verificação falhar, será classificado como fatal, pois nenhuma conexão poderá ser bem-sucedida se o domínio ingressado no SessionHost não estiver acessível no momento da conexão.

DomainTrustCheck
  • string

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 é criada. Se essa verificação falhar, será classificado como fatal, pois nenhuma conexão poderá ser bem-sucedida se não alcançarmos o domínio para autenticação no SessionHost.

FSLogixHealthCheck
  • string

Verifica se o serviço FSLogix está em execução para garantir que os perfis dos usuários sejam carregados na sessão. Se essa verificação falhar for classificada como fatal, mesmo se a conexão puder 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.

MetaDataServiceCheck
  • string

Verifica se o serviço de metadados está acessível e retorna propriedades de computação.

MonitoringAgentCheck
  • string

Verifica se o agente de Geneva necessário está em execução. Se essa verificação falhar, ela não será fatal e o computador ainda poderá fazer conexões de serviço, o principal problema pode ser que o agente de monitoramento esteja ausente ou executando (possivelmente) a versão mais antiga.

SupportedEncryptionCheck
  • string

Verifica o valor da chave de registro SecurityLayer. Se o valor for 0 (SecurityLayer.RDP), essa verificação falhará com Código de erro = NativeMethodErrorCode.E_FAIL e será fatal. Se o valor for 1 (SecurityLayer.Negotiate), essa verificação falhará com Código de erro = NativeMethodErrorCode.ERROR_SUCCESS e não será fatal.

SxSStackListenerCheck
  • string

Verifica se a pilha SxS está em execução para que as conexões possam ser bem-sucedidas. Se essa verificação falhar, será classificado como fatal, pois nenhuma conexão poderá ser bem-sucedida se a pilha SxS não estiver pronta.

UrlsAccessibleCheck
  • string

Verifica se o serviço WVD necessário e as URLs do Geneva estão acessíveis no SessionHost. Essas URLs são: RdTokenUri, RdBrokerURI, RdDiagnosticsUri e URLs de blob de armazenamento para monitoramento de agente (geneva). Se essa verificação falhar, ela não será fatal e o computador ainda poderá fazer conexões de serviço, o principal problema pode ser que o agente de monitoramento não consegue armazenar dados de caminho quente (logs, operações...).

WebRTCRedirectorCheck
  • string

Verifica se o componente WebRTCRedirector está healthy. 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 mais alta disponível. Se essa verificação falhar, ela não será fatal e o computador ainda poderá fazer conexões de serviço. O problema principal pode ser que o componente WebRTCRedirector precisa ser reiniciado ou atualizado.

HealthCheckResult

Representa o estado de saúde da verificação de saúde que realizamos.

Name Type Description
HealthCheckFailed
  • string

Falha na verificação de saúde.

HealthCheckSucceeded
  • string

Verificação de saúde aprovada.

SessionHostShutdown
  • string

Recebemos uma notificação de desligamento.

Unknown
  • string

O resultado da verificação de saúde não é conhecido no momento.

SessionHost

Representa uma definição de SessionHost.

Name Type Description
id
  • string

ID de recurso totalmente qualificada para o recurso. Por ex- /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

Permitir uma nova sessão.

properties.assignedUser
  • string

Usuário atribuído a SessionHost.

properties.lastHeartBeat
  • string

Última parada cardíaca de SessionHost.

properties.lastUpdateTime
  • string

O timestamp 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

Lista de SessionHostHealthCheckReports

properties.sessions
  • integer

Número de sessões em SessionHost.

properties.status

Status de um SessionHost.

properties.statusTimestamp
  • string

O timestamp 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

Atualize o estado de um SessionHost.

properties.virtualMachineId
  • string

ID da Máquina Virtual da máquina virtual subjacente do SessionHost.

type
  • string

Tipo do recurso. Por ex.: "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SessionHostHealthCheckFailureDetails

Contém detalhes sobre a falha.

Name Type Description
errorCode
  • integer

Código de erro correspondente à falha.

lastHealthCheckDateTime
  • string

O timestamp da última atualização.

message
  • string

Mensagem de falha: dicas sobre o que está errado e como recuperar.

SessionHostHealthCheckReport

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

Name Type Description
additionalFailureDetails

Informações detalhadas adicionais sobre a falha.

healthCheckName

Representa o nome da operação de verificação de saúde executada.

healthCheckResult

Representa o estado de saúde da verificação de saúde que realizamos.

Status

Status de um SessionHost.

Name Type Description
Available
  • string

O Host da Sessão passou todas as verificações de saúde e está disponível para lidar com conexões.

Disconnected
  • string

O Host da Sessão não está disponível porque está desconectado no momento.

DomainTrustRelationshipLost
  • string

Relação de confiança de domínio do SessionHost perdida

FSLogixNotHealthy
  • string

O FSLogix está em um estado não alembre no host da sessão.

NeedsAssistance
  • string

Novo status para informar os administradores de que a saúde em seu ponto de extremidade precisa ser corrigida. As conexões podem não falhar, pois esses problemas não são fatais.

NoHeartbeat
  • string

O Host da Sessão não tem pulsação.

NotJoinedToDomain
  • string

SessionHost não está ingressado no domínio.

Shutdown
  • string

O Host da Sessão está desligado – o host de sessão relatado pelo Agente de RD deve ser interrompido ou desaloqueado.

SxSStackListenerNotReady
  • string

A pilha SxS instalada no SessionHost não está pronta para receber conexões.

Unavailable
  • string

O Host da Sessão está desligado ou falhou nas verificações de saúde críticas, o que está fazendo com que o serviço não seja capaz de rotear conexões para esse host de sessão. Observe que isso substitui o status 'NoBeatBeat' anterior.

UpgradeFailed
  • string

O Host da Sessão não está disponível porque a atualização crítica do componente (agente, pilha lado a lado etc.) falhou.

Upgrading
  • string

O Host de 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 depois que a atualização for concluída e o host for capaz de aceitar conexões.

UpdateState

Atualize o estado de um SessionHost.

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