Control Session Host Provisioning - Post

Servicio:

Desktop Virtualization

Versión de la API:

2026-01-01-preview

Controle el aprovisionamiento de un grupo de hosts.

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 identificador URI

Nombre	En	Requerido	Tipo	Description
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	El nombre del grupo de hosts dentro del grupo de recursos especificado
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	La versión de API que se va a utilizar para esta operación.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
action	True	HostPoolProvisioningAction	Tipos de acción para controlar la actualización del grupo de hosts.
cancelMessage		string maxLength: 260	El mensaje de cancelación enviado al usuario en el host de sesión.

Respuestas

Nombre	Tipo	Description
202 Accepted		Operación de recurso aceptada. Encabezados Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

SessionHostManagements_ControlSessionHostProvisioning_Post

Solicitud de ejemplo

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

Respuesta de muestra

status code:

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

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
HostPoolProvisioningAction	Tipos de acción para controlar el aprovisionamiento del grupo de hosts.
HostPoolProvisioningControlParameter	Objeto que contiene la acción de control para el aprovisionamiento del grupo de hosts.

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Los detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

HostPoolProvisioningAction

Enumeración

Tipos de acción para controlar el aprovisionamiento del grupo de hosts.

Valor	Description
Cancel	Cancele el aprovisionamiento del grupo de hosts.

HostPoolProvisioningControlParameter

Objeto

Objeto que contiene la acción de control para el aprovisionamiento del grupo de hosts.

Nombre	Tipo	Description
action	HostPoolProvisioningAction	Tipos de acción para controlar la actualización del grupo de hosts.
cancelMessage	string maxLength: 260	El mensaje de cancelación enviado al usuario en el host de sesión.