Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix description for maintenance window time zone #18905

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3541,7 +3541,7 @@
},
"agentUpdate": {
"$ref": "#/definitions/AgentUpdateProperties",
"description": "The session host configuration for updating agent, monitoring agent, and stack component."
"description": "The preferred settings for updating the agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts."
},
"privateEndpointConnections": {
"readOnly": true,
Expand Down Expand Up @@ -3698,7 +3698,7 @@
},
"agentUpdate": {
"$ref": "#/definitions/AgentUpdatePatchProperties",
"description": "The session host configuration for updating agent, monitoring agent, and stack component."
"description": "The preferred settings for updating the agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts."
}
}
},
Expand Down Expand Up @@ -3756,12 +3756,12 @@
}
},
"AgentUpdateProperties": {
"description": "The session host configuration for updating agent, monitoring agent, and stack component.",
"description": "The preferred settings for updating the agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts.",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of maintenance for session host components.",
"description": "The preferred mechanism for updating the agent components. This is either Scheduled or Default.",
"enum": [
"Default",
"Scheduled"
Expand All @@ -3772,26 +3772,26 @@
"values": [
{
"value": "Default",
"description": "Agent and other agent side components are delivery schedule is controlled by WVD Infra."
"description": "The agent components are updated according to the AVD infrastructure flighting. For more information, see https://aka.ms/avdagent."
},
{
"value": "Scheduled",
"description": "TenantAdmin have opted in for Scheduled Component Update feature."
"description": "This enables the Scheduled Agent Updates feature which allows the agent components to get updated according to the schedule that the admin define. For more information, see https://aka.ms/avdsau."
}
]
}
},
"useSessionHostLocalTime": {
"type": "boolean",
"description": "Whether to use localTime of the virtual machine."
"description": "Boolean indicating whether to update the agent components in the local time zone of each session host in the host pool. By default, this is false."
},
"maintenanceWindowTimeZone": {
"type": "string",
"description": "Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true."
"description": "The time zone for updating the agent components. Valid time zones can be found here: https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. A time zone must be specified if useSessionHostLocalTime is false."
},
"maintenanceWindows": {
"type": "array",
"description": "List of maintenance windows. Maintenance windows are 2 hours long.",
"description": "The maintenance windows (day and time) for updating the agent components. At least 1 window must be specified. Optionally, a 2nd window can be specified.",
"items": {
"$ref": "#/definitions/MaintenanceWindowProperties"
},
Expand All @@ -3806,11 +3806,11 @@
"hour": {
"format": "int32",
"type": "integer",
"description": "The update start hour of the day. (0 - 23)"
"description": "The starting hour of the maintenance window (0-23). Note that maintenance windows are 2 hours long. This means that updates can be applied anytime from the specified start hour to 2 hours after."
},
"dayOfWeek": {
"type": "string",
"description": "Day of the week.",
"description": "The day of the week (Monday-Sunday).",
"enum": [
"Monday",
"Tuesday",
Expand All @@ -3828,12 +3828,12 @@
}
},
"AgentUpdatePatchProperties": {
"description": "The session host configuration for updating agent, monitoring agent, and stack component.",
"description": "The preferred settings for updating the agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts.",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "The type of maintenance for session host components.",
"description": "The preferred mechanism for updating the agent components. This is either Scheduled or Default.",
"enum": [
"Default",
"Scheduled"
Expand All @@ -3844,26 +3844,26 @@
"values": [
{
"value": "Default",
"description": "Agent and other agent side components are delivery schedule is controlled by WVD Infra."
"description": "The agent components are updated according to the AVD infrastructure flighting. For more information, see https://aka.ms/avdagent."
},
{
"value": "Scheduled",
"description": "TenantAdmin have opted in for Scheduled Component Update feature."
"description": "This enables the Scheduled Agent Updates feature which allows the agent components to get updated according to the schedule that the admin define. For more information, see https://aka.ms/avdsau."
}
]
}
},
"useSessionHostLocalTime": {
"type": "boolean",
"description": "Whether to use localTime of the virtual machine."
"description": "Boolean indicating whether to update the agent components in the local time zone of each session host in the host pool. By default, this is false."
},
"maintenanceWindowTimeZone": {
"type": "string",
"description": "Time zone for maintenance as defined in https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. Must be set if useLocalTime is true."
"description": "The time zone for updating the agent components. Valid time zones can be found here: https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.findsystemtimezonebyid?view=net-5.0. A time zone must be specified if useSessionHostLocalTime is false."
},
"maintenanceWindows": {
"type": "array",
"description": "List of maintenance windows. Maintenance windows are 2 hours long.",
"description": "The maintenance windows (day and time) for updating the agent components. At least 1 window must be specified. Optionally, a 2nd window can be specified.",
"items": {
"$ref": "#/definitions/MaintenanceWindowPatchProperties"
},
Expand All @@ -3878,11 +3878,11 @@
"hour": {
"format": "int32",
"type": "integer",
"description": "The update start hour of the day. (0 - 23)"
"description": "The starting hour of the maintenance window (0-23). Note that maintenance windows are 2 hours long. This means that updates can be applied anytime from the specified start hour to 2 hours after."
},
"dayOfWeek": {
"type": "string",
"description": "Day of the week.",
"description": "The day of the week (Monday-Sunday).",
"enum": [
"Monday",
"Tuesday",
Expand Down