|
3541 | 3541 | }, |
3542 | 3542 | "agentUpdate": { |
3543 | 3543 | "$ref": "#/definitions/AgentUpdateProperties", |
3544 | | - "description": "The session host configuration for updating agent, monitoring agent, and stack component." |
| 3544 | + "description": "The preferred settings for updating the agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts." |
3545 | 3545 | }, |
3546 | 3546 | "privateEndpointConnections": { |
3547 | 3547 | "readOnly": true, |
|
3698 | 3698 | }, |
3699 | 3699 | "agentUpdate": { |
3700 | 3700 | "$ref": "#/definitions/AgentUpdatePatchProperties", |
3701 | | - "description": "The session host configuration for updating agent, monitoring agent, and stack component." |
| 3701 | + "description": "The preferred settings for updating the agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts." |
3702 | 3702 | } |
3703 | 3703 | } |
3704 | 3704 | }, |
|
3756 | 3756 | } |
3757 | 3757 | }, |
3758 | 3758 | "AgentUpdateProperties": { |
3759 | | - "description": "The session host configuration for updating agent, monitoring agent, and stack component.", |
| 3759 | + "description": "The preferred settings for updating the agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts.", |
3760 | 3760 | "type": "object", |
3761 | 3761 | "properties": { |
3762 | 3762 | "type": { |
3763 | 3763 | "type": "string", |
3764 | | - "description": "The type of maintenance for session host components.", |
| 3764 | + "description": "The preferred mechanism for updating the agent components. This is either Scheduled or Default.", |
3765 | 3765 | "enum": [ |
3766 | 3766 | "Default", |
3767 | 3767 | "Scheduled" |
|
3772 | 3772 | "values": [ |
3773 | 3773 | { |
3774 | 3774 | "value": "Default", |
3775 | | - "description": "Agent and other agent side components are delivery schedule is controlled by WVD Infra." |
| 3775 | + "description": "The agent components are updated according to the AVD infrastructure flighting. For more information, see https://aka.ms/avdagent." |
3776 | 3776 | }, |
3777 | 3777 | { |
3778 | 3778 | "value": "Scheduled", |
3779 | | - "description": "TenantAdmin have opted in for Scheduled Component Update feature." |
| 3779 | + "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." |
3780 | 3780 | } |
3781 | 3781 | ] |
3782 | 3782 | } |
3783 | 3783 | }, |
3784 | 3784 | "useSessionHostLocalTime": { |
3785 | 3785 | "type": "boolean", |
3786 | | - "description": "Whether to use localTime of the virtual machine." |
| 3786 | + "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." |
3787 | 3787 | }, |
3788 | 3788 | "maintenanceWindowTimeZone": { |
3789 | 3789 | "type": "string", |
3790 | | - "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." |
| 3790 | + "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." |
3791 | 3791 | }, |
3792 | 3792 | "maintenanceWindows": { |
3793 | 3793 | "type": "array", |
3794 | | - "description": "List of maintenance windows. Maintenance windows are 2 hours long.", |
| 3794 | + "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.", |
3795 | 3795 | "items": { |
3796 | 3796 | "$ref": "#/definitions/MaintenanceWindowProperties" |
3797 | 3797 | }, |
|
3806 | 3806 | "hour": { |
3807 | 3807 | "format": "int32", |
3808 | 3808 | "type": "integer", |
3809 | | - "description": "The update start hour of the day. (0 - 23)" |
| 3809 | + "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." |
3810 | 3810 | }, |
3811 | 3811 | "dayOfWeek": { |
3812 | 3812 | "type": "string", |
3813 | | - "description": "Day of the week.", |
| 3813 | + "description": "The day of the week (Monday-Sunday).", |
3814 | 3814 | "enum": [ |
3815 | 3815 | "Monday", |
3816 | 3816 | "Tuesday", |
|
3828 | 3828 | } |
3829 | 3829 | }, |
3830 | 3830 | "AgentUpdatePatchProperties": { |
3831 | | - "description": "The session host configuration for updating agent, monitoring agent, and stack component.", |
| 3831 | + "description": "The preferred settings for updating the agent components (RDAgent, Geneva Monitoring agent, and side-by-side stack) on session hosts.", |
3832 | 3832 | "type": "object", |
3833 | 3833 | "properties": { |
3834 | 3834 | "type": { |
3835 | 3835 | "type": "string", |
3836 | | - "description": "The type of maintenance for session host components.", |
| 3836 | + "description": "The preferred mechanism for updating the agent components. This is either Scheduled or Default.", |
3837 | 3837 | "enum": [ |
3838 | 3838 | "Default", |
3839 | 3839 | "Scheduled" |
|
3844 | 3844 | "values": [ |
3845 | 3845 | { |
3846 | 3846 | "value": "Default", |
3847 | | - "description": "Agent and other agent side components are delivery schedule is controlled by WVD Infra." |
| 3847 | + "description": "The agent components are updated according to the AVD infrastructure flighting. For more information, see https://aka.ms/avdagent." |
3848 | 3848 | }, |
3849 | 3849 | { |
3850 | 3850 | "value": "Scheduled", |
3851 | | - "description": "TenantAdmin have opted in for Scheduled Component Update feature." |
| 3851 | + "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." |
3852 | 3852 | } |
3853 | 3853 | ] |
3854 | 3854 | } |
3855 | 3855 | }, |
3856 | 3856 | "useSessionHostLocalTime": { |
3857 | 3857 | "type": "boolean", |
3858 | | - "description": "Whether to use localTime of the virtual machine." |
| 3858 | + "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." |
3859 | 3859 | }, |
3860 | 3860 | "maintenanceWindowTimeZone": { |
3861 | 3861 | "type": "string", |
3862 | | - "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." |
| 3862 | + "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." |
3863 | 3863 | }, |
3864 | 3864 | "maintenanceWindows": { |
3865 | 3865 | "type": "array", |
3866 | | - "description": "List of maintenance windows. Maintenance windows are 2 hours long.", |
| 3866 | + "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.", |
3867 | 3867 | "items": { |
3868 | 3868 | "$ref": "#/definitions/MaintenanceWindowPatchProperties" |
3869 | 3869 | }, |
|
3878 | 3878 | "hour": { |
3879 | 3879 | "format": "int32", |
3880 | 3880 | "type": "integer", |
3881 | | - "description": "The update start hour of the day. (0 - 23)" |
| 3881 | + "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." |
3882 | 3882 | }, |
3883 | 3883 | "dayOfWeek": { |
3884 | 3884 | "type": "string", |
3885 | | - "description": "Day of the week.", |
| 3885 | + "description": "The day of the week (Monday-Sunday).", |
3886 | 3886 | "enum": [ |
3887 | 3887 | "Monday", |
3888 | 3888 | "Tuesday", |
|
0 commit comments