Microsoft.DesktopVirtualization (preview:2025-04-01)

2025/10/24 • 1 updated methods

SessionHostManagements_Update (updated)
Description :  Update a SessionHostManagement.
Reference :  Link ¶

⚶ Changes

{
  "#id": "SessionHostManagements_Update",
  "$parameters": {
    "sessionHostManagement": {
      "$properties": {
        "properties": [
          {
            "@added_8ad693ad6be3452a9b4be379416dfb04": {
              "#name": "provisioning",
              "Description": "Parameters that apply when session hosts are provisioned.",
              "Required": false,
              "Type": "object",
              "$properties": [
                {
                  "#name": "setDrainMode",
                  "Description": "Whether the session host should be set in drain mode following provisioning.",
                  "Required": false,
                  "Type": "boolean"
                },
                {
                  "#name": "instanceCount",
                  "Description": "The number of session hosts to exist in the Host Pool.",
                  "Format": "int32",
                  "Required": false,
                  "Type": "integer"
                },
                {
                  "#name": "canaryPolicy",
                  "Description": "Policy on whether a Canary VM(a single VM to validate the configuration) should be provisioned during a session host provisioning operation.",
                  "Enum": [
                    [
                      "Auto",
                      "Decided by service whether to provision Canary VM."
                    ],
                    [
                      "Never",
                      "Never provision Canary VM."
                    ],
                    [
                      "Always",
                      "Always provision Canary VM."
                    ]
                  ],
                  "Required": false,
                  "Type": "string"
                }
              ]
            }
          },
          {
            "@added_47bfff3d23924ed8bccd2f6bc6b597a2": {
              "#name": "failedSessionHostCleanupPolicy",
              "Description": "The policy that should be applied when the Session Host provisioning operation fails.",
              "Enum": [
                [
                  "KeepAll",
                  "Keep All."
                ],
                [
                  "KeepOne",
                  "Keep One."
                ],
                [
                  "KeepNone",
                  "Keep None."
                ]
              ],
              "Required": false,
              "Type": "string"
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
hostPoolName:
{
Description: The name of the host pool within the specified resource group ,
Required: True ,
}
string ,
sessionHostManagement:
{
Description: The properties to be updated. ,
Required: False ,
}
{
properties:
{
Description: Detailed properties for SessionHostManagement ,
Required: False ,
}
{
scheduledDateTimeZone:
{
Description: Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true. ,
Required: False ,
}
string ,
update:
{
Description: Parameters for a hostpool update. ,
Required: False ,
}
{
deleteOriginalVm:
{
Description: Whether not to save original disk. False by default. ,
Required: False ,
}
boolean ,
maxVmsRemoved:
{
Description: The maximum number of virtual machines to be removed during hostpool update. ,
Format: int32 ,
Required: False ,
}
integer ,
logOffDelayMinutes:
{
Description: Grace period before logging off users in minutes. ,
Format: int32 ,
Required: False ,
}
integer ,
logOffMessage:
{
Description: Log off message sent to user for logoff. Default value is an empty string. ,
Required: False ,
}
string ,
}
,
provisioning:
{
Description: Parameters that apply when session hosts are provisioned. ,
Required: False ,
}
{
setDrainMode:
{
Description: Whether the session host should be set in drain mode following provisioning. ,
Required: False ,
}
boolean ,
instanceCount:
{
Description: The number of session hosts to exist in the Host Pool. ,
Format: int32 ,
Required: False ,
}
integer ,
canaryPolicy:
{
Description: Policy on whether a Canary VM(a single VM to validate the configuration) should be provisioned during a session host provisioning operation. ,
Enum:
{
Auto: Decided by service whether to provision Canary VM. ,
Never: Never provision Canary VM. ,
Always: Always provision Canary VM. ,
}
,
Required: False ,
}
enum ,
}
,
failedSessionHostCleanupPolicy:
{
Description: The policy that should be applied when the Session Host provisioning operation fails. ,
Enum:
{
KeepAll: Keep All. ,
KeepOne: Keep One. ,
KeepNone: Keep None. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Detailed properties for SessionHostManagement ,
Required: True ,
}
{
scheduledDateTimeZone:
{
Description: Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid. Must be set if useLocalTime is true. ,
Required: True ,
}
string ,
update:
{
Description: Parameters for a hostpool update. ,
Required: True ,
}
{
deleteOriginalVm:
{
Description: Whether not to save original disk. False by default. ,
Required: False ,
}
boolean ,
maxVmsRemoved:
{
Description: The maximum number of virtual machines to be removed during hostpool update. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffDelayMinutes:
{
Description: Grace period before logging off users in minutes. ,
Format: int32 ,
Required: True ,
}
integer ,
logOffMessage:
{
Description: Log off message sent to user for logoff. Default value is an empty string. ,
Required: False ,
}
string ,
}
,
provisioning:
{
Description: Parameters that apply when session hosts are provisioned. ,
Required: False ,
}
{
setDrainMode:
{
Description: Whether the session host should be set in drain mode following provisioning. ,
Required: False ,
}
boolean ,
instanceCount:
{
Description: The number of session hosts to exist in the Host Pool. ,
Format: int32 ,
Required: False ,
}
integer ,
canaryPolicy:
{
Description: Policy on whether a Canary VM(a single VM to validate the configuration) should be provisioned during a session host provisioning operation. ,
Enum:
{
Auto: Decided by service whether to provision Canary VM. ,
Never: Never provision Canary VM. ,
Always: Always provision Canary VM. ,
}
,
Required: False ,
}
enum ,
}
,
failedSessionHostCleanupPolicy:
{
Description: The policy that should be applied when the Session Host provisioning operation fails. ,
Enum:
{
KeepAll: Keep All. ,
KeepOne: Keep One. ,
KeepNone: Keep None. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}