Control Session Host Provisioning - Post

Serviço:

Desktop Virtualization

Versão API:

2026-01-01-preview

Controle o provisionamento de um hostpool.

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

Parâmetros URI

Nome	Em	Necessá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)	A 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.

Órgão do Pedido

Nome	Necessário	Tipo	Descrição
action	True	HostPoolProvisioningAction	Tipos de ação para controlar a atualização do hostpool.
cancelMessage		string maxLength: 260	A mensagem de cancelamento enviada ao usuário no host da sessão.

Respostas

Nome	Tipo	Descrição
202 Accepted		Operação de recurso aceita. Cabeçalhos Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Alcances

Nome	Descrição
user_impersonation	personificar a sua conta de utilizador

Exemplos

SessionHostManagements_ControlSessionHostProvisioning_Post

Pedido de exemplo

HTTP

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

{
  "action": "Cancel",
  "cancelMessage": "Cancel host pool provisioning"
}

Resposta de exemplo

Código de estado:

202

Location: https://management.azure.com/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1/sessionHostManagements/default/operationResults/ed5d502c-acaa-42ec-ad61-0d8488a9fd1d
Retry-After: 60

Definições

Nome	Descrição
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
HostPoolProvisioningAction	Tipos de ação para controlar o provisionamento do hostpool.
HostPoolProvisioningControlParameter	Objeto que contém ação de controle para provisionamento de hostpool.

ErrorAdditionalInfo

Objetivo

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

Objetivo

O detalhe do erro.

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

ErrorResponse

Objetivo

Resposta de erro

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

HostPoolProvisioningAction

Enumeração

Tipos de ação para controlar o provisionamento do hostpool.

Valor	Descrição
Cancel	Cancele o provisionamento do hostpool.

HostPoolProvisioningControlParameter

Objetivo

Objeto que contém ação de controle para provisionamento de hostpool.

Nome	Tipo	Descrição
action	HostPoolProvisioningAction	Tipos de ação para controlar a atualização do hostpool.
cancelMessage	string maxLength: 260	A mensagem de cancelamento enviada ao usuário no host da sessão.