Control Session Host Provisioning - Post

Serviço:

Desktop Virtualization

Versão da API:

2026-01-01-preview

Controlar 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 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)	A 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.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
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	Description
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 Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

SessionHostManagements_ControlSessionHostProvisioning_Post

Solicitação 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 status:

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	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
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 ação de controle para provisionamento de hostpool.

ErrorAdditionalInfo

Objeto

As informações adicionais do 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[]	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 destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

HostPoolProvisioningAction

Enumeração

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

Valor	Description
Cancel	Cancele o provisionamento do hostpool.

HostPoolProvisioningControlParameter

Objeto

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

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