Session Hosts - Get

Referência

Service:: Desktop Virtualization

API Version:: 2022-02-10-preview

Obtenha um host de sessão.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
hostPoolName	path	True	string	O nome do pool de hosts 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 no 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

Nome	Tipo	Description
200 OK	SessionHost	Host de sessão recuperado com êxito.
Other Status Codes	CloudError	Resposta de erro de automação que descreve por que a operação falhou.

Exemplos

SessionHost_Get

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

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

Definições

Nome	Description
CloudError	Objeto de erro de nuvem.
CloudErrorProperties	Propriedades do objeto de erro de nuvem.
createdByType	O tipo de identidade que criou o recurso.
HealthCheckName	Representa o nome da operação de marcar de integridade executada.
HealthCheckResult	Representa o estado integridade do marcar de integridade que executamos.
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	Atualizar o estado de um SessionHost.

CloudError

Objeto de erro de nuvem.

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

CloudErrorProperties

Propriedades do objeto de erro de nuvem.

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

createdByType

O tipo de identidade que criou o recurso.

Nome	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

HealthCheckName

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

Nome	Tipo	Description
AppAttachHealthCheck	string	Verifica se o AppAttachService está íntegro (não houve problemas durante o preparo do pacote). O AppAttachService é usado para habilitar o preparo/registro (e eventual desregistração/desativação) de aplicativos MSIX que foram configurados pelo administrador do locatário. Isso verifica se o componente teve falhas durante o preparo do pacote. Falhas no preparo impedirão que alguns aplicativos MSIX funcionem corretamente para o usuário final. Se esse marcar falhar, ele não será fatal e o computador ainda poderá atender às conexões, main problema poderá ser determinado que os aplicativos não funcionarão para os usuários finais.
DomainJoinedCheck	string	Verifica se o SessionHost está ingressado em um domínio. Se esse marcar falhar for 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 qual SessionHost está ingressado ainda está acessível. Se esse marcar falhar for classificado como fatal, pois nenhuma conexão poderá ter êxito se o domínio ingressado no SessionHost não for 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 for criada. Se esse marcar falhar for classificado como fatal, pois nenhuma conexão poderá ser bem-sucedida se não pudermos acessar 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 marcar falhar for classificada como fatal, mesmo que a conexão possa ser bem-sucedida, a experiência do usuário será ruim, pois o perfil de usuário não pode 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 Genebra necessário está em execução. Se esse marcar falhar, ele não será fatal e o computador ainda poderá atender às conexões, main 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), esse marcar falhará com Código de erro = NativeMethodErrorCode.E_FAIL e será fatal. Se o valor for 1 (SecurityLayer.Negotiate), esse marcar 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 marcar falhar, será classificada como fatal, pois nenhuma conexão poderá ter êxito se a pilha SxS não estiver pronta.
UrlsAccessibleCheck	string	Verifica se o serviço WVD necessário e as URLs de Genebra podem ser acessados no SessionHost. Essas URLs são: RdTokenUri, RdBrokerURI, RdDiagnosticsUri e URLs de blob de armazenamento para monitoramento de agente (geneva). Se esse marcar falhar, ele não será fatal e o computador ainda poderá atender às conexões, main problema pode ser que o agente de monitoramento não consiga armazenar dados de caminho quente (logs, operações ...).
WebRTCRedirectorCheck	string	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 mais alta disponível. Se esse marcar falhar, ele não será fatal e o computador ainda poderá atender às conexões, main problema pode ser que o componente WebRTCRedirector precise ser reiniciado ou atualizado.

HealthCheckResult

Representa o estado integridade do marcar de integridade que executamos.

Nome	Tipo	Description
HealthCheckFailed	string	Falha no marcar de integridade.
HealthCheckSucceeded	string	A marcar de integridade foi aprovada.
SessionHostShutdown	string	Recebemos uma notificação de desligamento.
Unknown	string	O resultado da marcar de integridade não é conhecido no momento.

SessionHost

Representa uma definição de SessionHost.

Nome	Tipo	Description
id	string	ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.agentVersion	string	Versão do agente no SessionHost.
properties.allowNewSession	boolean	Permitir uma nova sessão.
properties.assignedUser	string	Usuário atribuído ao SessionHost.
properties.friendlyName	string	Nome amigável de SessionHost
properties.lastHeartBeat	string	Última batida cardíaca de SessionHost.
properties.lastUpdateTime	string	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	Número de sessões no SessionHost.
properties.status	Status	Status de um SessionHost.
properties.statusTimestamp	string	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	Atualizar o estado de um SessionHost.
properties.virtualMachineId	string	ID de máquina virtual da máquina virtual subjacente do SessionHost.
systemData	systemData	Metadados relativos à criação e à última modificação do recurso.
type	string	Tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

SessionHostHealthCheckFailureDetails

Contém detalhes sobre a falha.

Nome	Tipo	Description
errorCode	integer	Código de erro correspondente à falha.
lastHealthCheckDateTime	string	O carimbo de data/hora 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.

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

Status

Status de um SessionHost.

Nome	Tipo	Description
Available	string	O Host da Sessão passou por todas as verificações de integridade 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 íntegro no host da sessão.
NeedsAssistance	string	Novas status informar aos administradores que a integridade 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 está batendo no coraçã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 Área de Trabalho Remota deve ser interrompido ou desalocado.
SxSStackListenerNotReady	string	A pilha SxS instalada no SessionHost não está pronta para receber conexões.
Unavailable	string	O Host da Sessão está desativado ou falhou em verificações de integridade críticas, o que está fazendo com que o serviço não possa rotear conexões para este host de sessão. Observe que isso substitui os status 'NoHeartBeat' anteriores.
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 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.

systemData

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

Nome	Tipo	Description
createdAt	string	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	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

Atualizar o estado de um SessionHost.

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