Control Session Host Provisioning - Post

サービス:

Desktop Virtualization

API バージョン:

2026-01-01-preview

ホストプールのプロビジョニングを制御します。

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

URI パラメーター

名前	/	必須	型	説明
hostPoolName	path	True	string minLength: 3 maxLength: 64 pattern: ^[A-Za-z0-9@.\-_ ]*$	指定されたリソース・グループ内のホスト・プールの名前
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソース グループの名前。 名前は大文字と小文字が区別されます。
subscriptionId	path	True	string (uuid)	ターゲット サブスクリプションの ID。 値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
action	True	HostPoolProvisioningAction	ホストプールの更新を制御するためのアクションの種類。
cancelMessage		string maxLength: 260	セッション・ホスト上のユーザーに送信されるキャンセル・メッセージ。

応答

名前	型	説明
202 Accepted		リソース操作が受け入れられます。 ヘッダー Location: string Retry-After: integer
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントになりすます

例

SessionHostManagements_ControlSessionHostProvisioning_Post

要求のサンプル

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

応答のサンプル

状態コード:

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

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
HostPoolProvisioningAction	ホストプールのプロビジョニングを制御するためのアクションタイプ。
HostPoolProvisioningControlParameter	ホストプールプロビジョニングの制御アクションを含むオブジェクト。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラー コード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラー メッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラー オブジェクト。

HostPoolProvisioningAction

列挙

ホストプールのプロビジョニングを制御するためのアクションタイプ。

値	説明
Cancel	ホストプールのプロビジョニングをキャンセルします。

HostPoolProvisioningControlParameter

Object

ホストプールプロビジョニングの制御アクションを含むオブジェクト。

名前	型	説明
action	HostPoolProvisioningAction	ホストプールの更新を制御するためのアクションの種類。
cancelMessage	string maxLength: 260	セッション・ホスト上のユーザーに送信されるキャンセル・メッセージ。