Control Session Host Provisioning - Post

Service:

Desktop Virtualization

Version d'API:

2026-01-01-preview

Contrôlez le provisionnement d’un pool d’hôtes.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	Nom du pool d’hôtes dans le groupe de ressources spécifié
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

Nom	Obligatoire	Type	Description
action	True	HostPoolProvisioningAction	Types d’action pour contrôler la mise à jour du pool d’hôtes.
cancelMessage		string maxLength: 260	Message d’annulation envoyé à l’utilisateur sur l’hôte de session.

Réponses

Nom	Type	Description
202 Accepted		Opération de ressource acceptée. En-têtes Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

SessionHostManagements_ControlSessionHostProvisioning_Post

Exemple de requête

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

Exemple de réponse

Code d’état:

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

Définitions

Nom	Description
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
HostPoolProvisioningAction	Types d’action pour contrôler le provisionnement du pool d’hôtes.
HostPoolProvisioningControlParameter	Objet contenant l’action de contrôle pour le provisionnement du pool d’hôtes.

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

HostPoolProvisioningAction

Énumération

Types d’action pour contrôler le provisionnement du pool d’hôtes.

Valeur	Description
Cancel	Annulez le provisionnement du pool d’hôtes.

HostPoolProvisioningControlParameter

Objet

Objet contenant l’action de contrôle pour le provisionnement du pool d’hôtes.

Nom	Type	Description
action	HostPoolProvisioningAction	Types d’action pour contrôler la mise à jour du pool d’hôtes.
cancelMessage	string maxLength: 260	Message d’annulation envoyé à l’utilisateur sur l’hôte de session.