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 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.
subscriptionId	path	True	string (uuid)	O 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	SessionHostConfiguration	A operação do Azure foi concluída com êxito.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo do OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	se passar pela sua conta de usuário

Exemplos

SessionHostConfigurations_Get

Solicitação de exemplo

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 de exemplo

Código de status:

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

Nome	Description
ActiveDirectoryInfoProperties	Informações do Active Directory. Apenas um deve ser preenchido com base no tipo de junção.
AzureActiveDirectoryInfoProperties	Informações do Azure Active Directory. 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 exibir a Saída do Console e a Captura de Tela para diagnosticar o status da VM. Você pode exibir 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 do disco temporário para o disco do sistema operacional. O comportamento padrão é: CacheDisk se um estiver configurado para o tamanho da VM, caso contrário, TempDisk for usado. Consulte a documentação de tamanho da VM para VM do Windows em https://docs.microsoft.com/azure/virtual-machines/windows/sizes e VM Linux em https://docs.microsoft.com/azure/virtual-machines/linux/sizes para verificar quais tamanhos de VM expõem um disco de cache. 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 de disco.
DomainInfoProperties	Configurações de domínio de hosts de sessão.
DomainJoinType	O tipo de junção de domínio feita pela máquina virtual.
ErrorAdditionalInfo	Informações adicionais sobre o erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
ImageInfoProperties	Configurações de imagem do host da sessão em um HostPool
KeyVaultCredentialsProperties	Credenciais mantidas no cofre de chaves.
ManagedDiskProperties	Informações do Disco Gerenciado.
MarketplaceInfoProperties	Informações de imagem do Marketplace.
NetworkInfoProperties	Informações de rede.
ProvisioningStateSHC	Estado de provisionamento da Configuração do Host da Sessão.
SecurityInfoProperties	Informações de segurança.
SessionHostConfiguration	Esquema para propriedades SessionHostConfiguration.
systemData	Metadados relativos à criação e última modificação do recurso.
type	O tipo de hosts de sessão de imagem usados no hostpool.
VirtualMachineDiskType	O tipo de disco usado pela máquina virtual no host da sessão do hostpool.
VirtualMachineSecurityType	O tipo de segurança usado pela máquina virtual no host da sessão de hostpool. O padrão é Standard.

ActiveDirectoryInfoProperties

Objeto

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

Nome	Tipo	Description
domainCredentials	KeyVaultCredentialsProperties	Credenciais necessárias para criar a máquina virtual.
domainName	string	O domínio em que uma máquina virtual conectada a um hostpool ingressará.
ouPath	string	O caminho da unidade organizacional (UO).

AzureActiveDirectoryInfoProperties

Objeto

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

Nome	Tipo	Description
mdmProviderGuid	string	O guia MDM (Gerenciamento de Dispositivo Móvel).

BootDiagnosticsInfoProperties

Objeto

O Diagnóstico de Inicialização é um recurso de depuração que permite exibir a Saída do Console e a Captura de Tela para diagnosticar o status da VM.

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

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

Nome	Tipo	Description
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	Description
User
Application
ManagedIdentity
Key

CustomInfoProperties

Objeto

Informações de imagem personalizadas.

Nome	Tipo	Description
resourceId	string (arm-id)	A ID do recurso da imagem.

DiffDiskOption

Enumeração

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

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

DiffDiskPlacement

Enumeração

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

Valor	Description
CacheDisk	Posicionamento do disco de cache
TempDisk	Posicionamento temporário do disco

DiffDiskProperties

Objeto

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

Nome	Tipo	Description
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 do disco temporário para o disco do sistema operacional. O comportamento padrão é: CacheDisk se um estiver configurado para o tamanho da VM, caso contrário, TempDisk for usado. Consulte a documentação de tamanho da VM para VM do Windows em https://docs.microsoft.com/azure/virtual-machines/windows/sizes e VM Linux em https://docs.microsoft.com/azure/virtual-machines/linux/sizes para verificar quais tamanhos de VM expõem um disco de cache. Valores possíveis incluem: 'CacheDisk', 'TempDisk'.

DiskInfoProperties

Objeto

Informações de disco.

Nome	Tipo	Description
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 de disco gerenciado.

DomainInfoProperties

Objeto

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

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

DomainJoinType

Enumeração

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

Valor	Description
ActiveDirectory	Usando o Microsoft Active Directory.
AzureActiveDirectory	Usando o Microsoft Azure Active Directory.

ErrorAdditionalInfo

Objeto

Informações adicionais sobre o erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

ImageInfoProperties

Objeto

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

Nome	Tipo	Description
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 do marketplace. Apenas um deve ser preenchido com base no tipo de imagem.
type	type	O tipo de hosts de sessão de imagem usados no hostpool.

KeyVaultCredentialsProperties

Objeto

Credenciais mantidas no cofre de chaves.

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

Objeto

Informações do Disco Gerenciado.

Nome	Tipo	Description
type	VirtualMachineDiskType	Informações do Disco Gerenciado.

MarketplaceInfoProperties

Objeto

Informações de imagem do Marketplace.

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

Objeto

Informações de rede.

Nome	Tipo	Description
securityGroupId	string	A ID do recurso do grupo de segurança. Todas as portas permitidas/abertas devem ser especificadas no NSG (Grupo de Segurança de Rede).
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	Description
Succeeded	Provisionamento bem-sucedido
Failed	Falha no provisionamento
Canceled	O provisionamento foi cancelado
Provisioning	Provisionamento em andamento

SecurityInfoProperties

Objeto

Informações de segurança.

Nome	Tipo	Valor padrão	Description
secureBootEnabled	boolean		Se deseja usar secureBoot na máquina virtual.
type	VirtualMachineSecurityType	Standard	O tipo de segurança usado pela máquina virtual no host da sessão de hostpool. O padrão é Standard.
vTpmEnabled	boolean		Se o vTpm deve ser usado na máquina virtual.

SessionHostConfiguration

Objeto

Esquema para propriedades SessionHostConfiguration.

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.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 de braço 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 de 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 hosts de sessão."
properties.vmLocation	string	O local no qual o host da sessão será criado. O padrão será 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 em que serão criados. Ele usará como padrão 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 que contêm informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

systemData

Objeto

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

Nome	Tipo	Description
createdAt	string (date-time)	O registro de data e hora 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)	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.

type

Enumeração

O tipo de hosts de sessão de imagem usados no hostpool.

Valor	Description
Marketplace	Usando imagens padrão do marketplace oferecidas pelo Azure Marketplace.
Custom	Usando uma imagem personalizada.

VirtualMachineDiskType

Enumeração

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

Valor	Description
Standard_LRS	Armazenamento HDD Standard com redundância local. Melhor para backup, acesso não crítico e pouco frequente.
Premium_LRS	SSD Premium com armazenamento de redundância local. Melhor para cargas de trabalho que exigem sensibilidade à produção e desempenho.
StandardSSD_LRS	SSD Standard com armazenamento de redundância local. Melhor para servidores Web, aplicativos empresariais levemente usados e desenvolvimento/teste.

VirtualMachineSecurityType

Enumeração

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

Valor	Description
Standard	Protocolo de segurança padrão. Sem parâmetros adicionais
TrustedLaunch	O TrustedLaunch permite inicialização segura e vTpm
ConfidentialVM	Protocolo de segurança da Máquina Virtual Confidencial