Session Host Configurations - Get

Serviço:

Desktop Virtualization

Versão da API:

2026-04-01-preview

Obtenha um SessionHostConfiguration.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default?api-version=2026-04-01-preview

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	O nome do pool de hosts 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.
subscriptionId	path	True	string (uuid)	O ID da assinatura de destino. O valor deve ser um UUID.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Respostas

Name	Tipo	Descrição
200 OK	SessionHostConfiguration	Operação do Azure concluída com sucesso.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Descrição
user_impersonation	assumir a identidade da sua conta de utilizador

Exemplos

SessionHostConfigurations_Get

Pedido de amostra

HTTP

GET https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default?api-version=2026-04-01-preview

Resposta da amostra

Código de estado:

200

{
  "name": "default",
  "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostConfigurations/default",
  "type": "Microsoft.DesktopVirtualization/hostPools/sessionHostConfigurations",
  "systemData": {
    "createdBy": "user1",
    "createdByType": "User",
    "createdAt": "2020-01-01T17:18:19.1234567Z",
    "lastModifiedBy": "user2",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2020-01-02T17:18:19.1234567Z"
  },
  "properties": {
    "version": "2022-10-21T17:18:19.1234567Z",
    "friendlyName": "InitialConfiguration",
    "provisioningState": "Provisioning",
    "vmTags": {
      "Department": "myDepartment",
      "Team": "myTeam"
    },
    "vmLocation": "eastus2",
    "vmResourceGroup": "myResourceGroup",
    "vmNamePrefix": "westus2-vm",
    "availabilityZones": [
      1,
      3
    ],
    "networkInfo": {
      "subnetId": "/subscriptions/.../resourceGroups/.../providers/Microsoft.Network/virtualNetworks/.../subnets/subnet1",
      "securityGroupId": "/subscriptions/.../resourceGroups/.../provider s/Microsoft.Network/networkSecurityGroups/nsg1"
    },
    "vmSizeId": "Standard_D2s_v3",
    "diskInfo": {
      "managedDisk": {
        "type": "Standard_LRS"
      }
    },
    "customConfigurationScriptUrl": "https://storageaccountname.blob.core.windows.net/blobcontainer/file",
    "imageInfo": {
      "type": "Marketplace",
      "marketplaceInfo": {
        "offer": "Windows-10",
        "publisher": "MicrosoftWindowsDesktop",
        "sku": "19h2-ent",
        "exactVersion": "2019.0.20190115"
      },
      "customInfo": {
        "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/images/imageName"
      }
    },
    "domainInfo": {
      "joinType": "ActiveDirectory",
      "activeDirectoryInfo": {
        "domainCredentials": {
          "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername",
          "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname"
        },
        "ouPath": "OU=testOU,DC=domain,DC=Domain,DC=com",
        "domainName": "wvdarmtest1.net"
      },
      "azureActiveDirectoryInfo": {
        "mdmProviderGuid": "bdefabc0-95b4-48b3-b645-8a753a63c4fa"
      }
    },
    "securityInfo": {
      "type": "TrustedLaunch",
      "secureBootEnabled": true,
      "vTpmEnabled": true
    },
    "vmAdminCredentials": {
      "usernameKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/myusername",
      "passwordKeyVaultSecretUri": "https://myvault.vault.azure.net/secrets/mysecretname"
    },
    "bootDiagnosticsInfo": {
      "enabled": true,
      "storageUri": "https://myStorageAccountName.blob.core.windows.net"
    }
  }
}

Definições

Name	Descrição
ActiveDirectoryInfoProperties	Informações do Ative Directory. Apenas um deve ser preenchido com base no tipo de junção.
AzureActiveDirectoryInfoProperties	Informações do Ative Directory do Azure. Apenas um deve ser preenchido com base no tipo de junção
BootDiagnosticsInfoProperties	O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM. Você pode visualizar facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor
createdByType	O tipo de identidade que criou o recurso.
CustomInfoProperties	Informações de imagem personalizadas.
DiffDiskOption	Especifica as configurações de disco efêmero para o disco do sistema operacional.
DiffDiskPlacement	Obtém ou define especifica o posicionamento efêmero do disco para o disco do sistema operacional. O comportamento padrão é: CacheDisk se estiver configurado para o tamanho da VM, caso contrário é usado TempDisk. Consulte a documentação de tamanho de VM para VM do Windows em https://docs.microsoft.com/azure/virtual-machines/windows/sizes e VM do Linux em https://docs.microsoft.com/azure/virtual-machines/linux/sizes para verificar quais tamanhos de VM expõem um disco de cache. Os valores possíveis incluem: 'CacheDisk', 'TempDisk'.
DiffDiskProperties	Especifica as configurações de disco efêmero para o disco do sistema operacional usado pela máquina virtual.
DiskInfoProperties	Informações do disco.
DomainInfoProperties	Configurações de domínio de hosts de sessão.
DomainJoinType	O tipo de associação de domínio feita pela máquina virtual.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ImageInfoProperties	Configurações de imagem do host de sessão em um HostPool
KeyVaultCredentialsProperties	Credenciais mantidas no cofre de chaves.
ManagedDiskProperties	Informações do Managed Disk.
MarketplaceInfoProperties	Informações de imagem do mercado.
NetworkInfoProperties	Informações da rede.
ProvisioningStateSHC	Estado de provisionamento da Configuração do Host da Sessão.
SecurityInfoProperties	Informações de segurança.
SessionHostConfiguration	Esquema para as propriedades SessionHostConfiguration.
systemData	Metadados referentes à criação e última modificação do recurso.
type	O tipo de imagem que os hosts de sessão usam no hostpool.
VirtualMachineDiskType	O tipo de disco usado pela máquina virtual no host de sessão do hostpool.
VirtualMachineSecurityType	O tipo de segurança usado pela máquina virtual no host de sessão do hostpool. O padrão é Padrão.

ActiveDirectoryInfoProperties

Object

Informações do Ative Directory. Apenas um deve ser preenchido com base no tipo de junção.

Name	Tipo	Descrição
domainCredentials	KeyVaultCredentialsProperties	Credenciais necessárias para criar a máquina virtual.
domainName	string	O domínio ao qual uma máquina virtual conectada a um hostpool ingressará.
ouPath	string	O caminho da unidade organizacional (UO).

AzureActiveDirectoryInfoProperties

Object

Informações do Ative Directory do Azure. Apenas um deve ser preenchido com base no tipo de junção

Name	Tipo	Descrição
mdmProviderGuid	string	O guid de Gerenciamento de Dispositivos Móveis (MDM).

BootDiagnosticsInfoProperties

Object

O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM.

Você pode visualizar facilmente a saída do log do console.

O Azure também permite que você veja uma captura de tela da VM do hipervisor

Name	Tipo	Descrição
enabled	boolean	Se o diagnóstico de inicialização deve ser habilitado na máquina virtual.
storageUri	string (uri)	Uri da conta de armazenamento a ser usada para colocar a saída do console e a captura de tela. Se storageUri não for especificado ao habilitar o diagnóstico de inicialização, o armazenamento gerenciado será usado.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Descrição
User
Application
ManagedIdentity
Key

CustomInfoProperties

Object

Informações de imagem personalizadas.

Name	Tipo	Descrição
resourceId	string (arm-id)	O ID do recurso da imagem.

DiffDiskOption

Enumeração

Especifica as configurações de disco efêmero para o disco do sistema operacional.

Valor	Descrição
Local	Configuração local do disco do sistema operacional.

DiffDiskPlacement

Enumeração

Obtém ou define especifica o posicionamento efêmero do disco para o disco do sistema operacional. O comportamento padrão é: CacheDisk se estiver configurado para o tamanho da VM, caso contrário é usado TempDisk. Consulte a documentação de tamanho de VM para VM do Windows em https://docs.microsoft.com/azure/virtual-machines/windows/sizes e VM do Linux em https://docs.microsoft.com/azure/virtual-machines/linux/sizes para verificar quais tamanhos de VM expõem um disco de cache. Os valores possíveis incluem: 'CacheDisk', 'TempDisk'.

Valor	Descrição
CacheDisk	Posicionamento do disco de cache
TempDisk	Colocação do disco temporário

DiffDiskProperties

Object

Especifica as configurações de disco efêmero para o disco do sistema operacional usado pela máquina virtual.

Name	Tipo	Descrição
option	DiffDiskOption	Especifica as configurações de disco efêmero para o disco do sistema operacional.
placement	DiffDiskPlacement	Obtém ou define especifica o posicionamento efêmero do disco para o disco do sistema operacional. O comportamento padrão é: CacheDisk se estiver configurado para o tamanho da VM, caso contrário é usado TempDisk. Consulte a documentação de tamanho de VM para VM do Windows em https://docs.microsoft.com/azure/virtual-machines/windows/sizes e VM do Linux em https://docs.microsoft.com/azure/virtual-machines/linux/sizes para verificar quais tamanhos de VM expõem um disco de cache. Os valores possíveis incluem: 'CacheDisk', 'TempDisk'.

DiskInfoProperties

Object

Informações do disco.

Name	Tipo	Descrição
diffDiskSettings	DiffDiskProperties	Especifica as configurações de disco efêmero para o disco do sistema operacional usado pela máquina virtual.
managedDisk	ManagedDiskProperties	Os parâmetros do disco gerenciado.

DomainInfoProperties

Object

Configurações de domínio de hosts de sessão.

Name	Tipo	Descrição
activeDirectoryInfo	ActiveDirectoryInfoProperties	Informações do Ative Directory. Apenas um deve ser preenchido com base no tipo de junção.
azureActiveDirectoryInfo	AzureActiveDirectoryInfoProperties	Informações do Ative Directory do Azure. Apenas um deve ser preenchido com base no tipo de junção.
joinType	DomainJoinType	O tipo de associação de domínio feita pela máquina virtual.

DomainJoinType

Enumeração

O tipo de associação de domínio feita pela máquina virtual.

Valor	Descrição
ActiveDirectory	Usando o Microsoft Ative Directory.
AzureActiveDirectory	Usando o Ative Directory do Microsoft Azure.

ErrorAdditionalInfo

Object

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Descrição
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro

Name	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

ImageInfoProperties

Object

Configurações de imagem do host de sessão em um HostPool

Name	Tipo	Descrição
customInfo	CustomInfoProperties	Os valores para identificar exclusivamente uma imagem personalizada. Apenas um deve ser preenchido com base no tipo de imagem.
marketplaceInfo	MarketplaceInfoProperties	Os valores para identificar exclusivamente uma imagem de mercado. Apenas um deve ser preenchido com base no tipo de imagem.
type	type	O tipo de imagem que os hosts de sessão usam no hostpool.

KeyVaultCredentialsProperties

Object

Credenciais mantidas no cofre de chaves.

Name	Tipo	Descrição
passwordKeyVaultSecretUri	string (uri)	O uri para acessar o segredo no qual a senha está armazenada.
usernameKeyVaultSecretUri	string (uri)	O uri para acessar o segredo no qual o nome de usuário está armazenado.

ManagedDiskProperties

Object

Informações do Managed Disk.

Name	Tipo	Descrição
type	VirtualMachineDiskType	Informações do Managed Disk.

MarketplaceInfoProperties

Object

Informações de imagem do mercado.

Name	Tipo	Descrição
exactVersion	string	A versão da imagem.
offer	string	A oferta da imagem.
publisher	string	O editor da imagem.
sku	string	O SKU da imagem.

NetworkInfoProperties

Object

Informações da rede.

Name	Tipo	Descrição
securityGroupId	string	A ID do recurso do grupo de segurança. Todas as portas permitidas/abertas devem ser especificadas no NSG (Network Security Group).
subnetId	string (arm-id)	A ID do recurso da sub-rede.

ProvisioningStateSHC

Enumeração

Estado de provisionamento da Configuração do Host da Sessão.

Valor	Descrição
Succeeded	Provisionamento bem-sucedido
Failed	Falha no provisionamento
Canceled	O provisionamento foi cancelado
Provisioning	Provisionamento em andamento

SecurityInfoProperties

Object

Informações de segurança.

Name	Tipo	Valor predefinido	Descrição
secureBootEnabled	boolean		Se o secureBoot deve ser usado na máquina virtual.
type	VirtualMachineSecurityType	Standard	O tipo de segurança usado pela máquina virtual no host de sessão do hostpool. O padrão é Padrão.
vTpmEnabled	boolean		Se o vTpm deve ser usado na máquina virtual.

SessionHostConfiguration

Object

Esquema para as propriedades SessionHostConfiguration.

Name	Tipo	Descrição
id	string (arm-id)	ID de recurso totalmente qualificado para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.availabilityZones	integer[] (int32)	Valor para zonas de disponibilidade a serem usadas pelo host da sessão. Deve ser de [1,2,3].
properties.bootDiagnosticsInfo	BootDiagnosticsInfoProperties	Informações de diagnóstico de inicialização
properties.customConfigurationScriptUrl	string (uri)	O uri para o blob de armazenamento que contém o modelo arm a ser executado na máquina virtual após o provisionamento.
properties.diskInfo	DiskInfoProperties	Informações do disco
properties.domainInfo	DomainInfoProperties	Configurações de domínio de hosts de sessão.
properties.friendlyName	string maxLength: 260	Nome amigável para descrever esta versão do SessionHostConfiguration.
properties.imageInfo	ImageInfoProperties	Configurações de imagem do HostPool.
properties.networkInfo	NetworkInfoProperties	Informações da rede.
properties.provisioningState	ProvisioningStateSHC	Estado de provisionamento da Configuração do Host da Sessão.
properties.securityInfo	SecurityInfoProperties	Informações de Segurança
properties.version	string (date-time)	O carimbo de data/hora da última atualização.
properties.vmAdminCredentials	KeyVaultCredentialsProperties	Credenciais de administrador local para anfitriões de sessão."
properties.vmLocation	string	O Local para o host da sessão a ser criado. Ele será padrão para o local do hostpool, se não for fornecido
properties.vmNamePrefix	string maxLength: 11	O prefixo que deve ser associado a nomes de host de sessão
properties.vmResourceGroup	string	O ResourceGroup para os hosts de sessão a serem criados. Ele será padrão para o ResourceGroup do hostpool, se não for fornecido.
properties.vmSizeId	string	A id do tamanho de uma máquina virtual conectada a um hostpool. Exemplo: Standard_D2as_v6
properties.vmTags	object	Hashtable que lista marcas de par chave/valor a serem aplicadas às VMs
systemData	systemData	Metadados do Azure Resource Manager contendo informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

systemData

Object

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

Name	Tipo	Descrição
createdAt	string (date-time)	A marca temporal da criação do recurso (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	A data e 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.

type

Enumeração

O tipo de imagem que os hosts de sessão usam no hostpool.

Valor	Descrição
Marketplace	Utilizar imagens de mercado predefinidas oferecidas pelo Azure Marketplace.
Custom	Usando uma imagem personalizada.

VirtualMachineDiskType

Enumeração

O tipo de disco usado pela máquina virtual no host de sessão do hostpool.

Valor	Descrição
Standard_LRS	Armazenamento localmente redundante de HDD padrão. Ideal para backup, acesso não crítico e pouco frequente.
Premium_LRS	Armazenamento localmente redundante com SSD Premium. Ideal para cargas de trabalho sensíveis à produção e ao desempenho.
StandardSSD_LRS	Armazenamento SSD padrão com redundância local. Ideal para servidores web, aplicações empresariais levemente utilizadas e desenvolvimento/teste.

VirtualMachineSecurityType

Enumeração

O tipo de segurança usado pela máquina virtual no host de sessão do hostpool. O padrão é Padrão.

Valor	Descrição
Standard	Protocolo de segurança padrão. Sem parâmetros adicionais
TrustedLaunch	TrustedLaunch permite inicialização segura e vTpm
ConfidentialVM	Protocolo de segurança confidencial da máquina virtual