The hostPools/sessionHostManagements resource type can be deployed with operations that target:
For a list of changed properties in each API version, see change log.
To create a Microsoft.DesktopVirtualization/hostPools/sessionHostManagements resource, add the following JSON to your template.
{
"type": "Microsoft.DesktopVirtualization/hostPools/sessionHostManagements",
"apiVersion": "2023-11-01-preview",
"name": "default",
"properties": {
"scheduledDateTimeZone": "string",
"update": {
"deleteOriginalVm": "bool",
"logOffDelayMinutes": "int",
"logOffMessage": "string",
"maxVmsRemoved": "int"
}
}
}
Name | Description | Value |
---|---|---|
type | The resource type | 'Microsoft.DesktopVirtualization/hostPools/sessionHostManagements' |
apiVersion | The resource api version | '2023-11-01-preview' |
name | The resource name See how to set names and types for child resources in JSON ARM templates. |
'default' |
properties | Detailed properties for SessionHostManagement | SessionHostManagementProperties (required) |
Name | Description | Value |
---|---|---|
scheduledDateTimeZone | Time zone for sessionHostManagement operations as defined in https://docs.microsoft.com/dotnet/api/system.timezoneinfo.findsystemtimezonebyid . Must be set if useLocalTime is true. |
string (required) |
update | Parameters for a hostpool update. | HostPoolUpdateConfigurationProperties (required) |
Name | Description | Value |
---|---|---|
deleteOriginalVm | Whether not to save original disk. False by default. | bool |
logOffDelayMinutes | Grace period before logging off users in minutes. | int (required) |
logOffMessage | Log off message sent to user for logoff. Default value is an empty string. | string Constraints: Max length = 260 |
maxVmsRemoved | The maximum number of virtual machines to be removed during hostpool update. | int (required) Constraints: Min value = 1 |