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

Windows settings update #93

Open
wants to merge 36 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
81541a8
Add whatif support
Nov 2, 2024
323d624
Initial module for Windows Update settings
Gijsreyn Nov 4, 2024
0ba034a
TODO task
Gijsreyn Nov 4, 2024
7ba6a69
Add assertions for delivery optimization
Gijsreyn Nov 4, 2024
81b64c3
Update the docs
Gijsreyn Nov 4, 2024
059b59b
Update table values
Gijsreyn Nov 4, 2024
4541bb4
Remove duplicate code
Gijsreyn Nov 4, 2024
102c763
Add whatif tests
Gijsreyn Nov 5, 2024
657e834
Merge branch 'main' into whatif-support
Gijsreyn Nov 5, 2024
5a06f85
Merge branch 'main' into windows-update-setting
Gijsreyn Nov 5, 2024
48877f6
Comments
Gijsreyn Nov 5, 2024
ba97203
Merge branch 'main' of https://github.com/Gijsreyn/winget-dsc into wh…
Gijsreyn Nov 6, 2024
d816dc3
Re-add Invoke-Process
Gijsreyn Nov 6, 2024
cd15ed2
Fix spelling
Gijsreyn Nov 6, 2024
6370252
Spell checker test
Gijsreyn Nov 6, 2024
8539290
Merge branch 'main' into windows-update-setting
Gijsreyn Nov 6, 2024
fec4047
Merge branch 'main' of https://github.com/Gijsreyn/winget-dsc into wi…
Gijsreyn Nov 6, 2024
3bf7d6b
Merge branch 'windows-update-setting' of https://github.com/Gijsreyn/…
Gijsreyn Nov 6, 2024
7ed2c35
Add attributes for validation
Gijsreyn Nov 6, 2024
e7262b2
Merge branch 'whatif-support' of https://github.com/Gijsreyn/winget-d…
Gijsreyn Nov 6, 2024
6dfddf3
Spell checker words
Gijsreyn Nov 6, 2024
8d8ad12
Test
Gijsreyn Nov 6, 2024
1fbe8e2
Add line break for test
Gijsreyn Nov 6, 2024
60fa17e
Fix variables at top
Gijsreyn Nov 14, 2024
cdab3c3
Revert spelling
Gijsreyn Nov 15, 2024
b371c1e
Resolve conflict
Gijsreyn Nov 15, 2024
041076a
Commit conflic
Gijsreyn Nov 15, 2024
ace1afa
Fix conflict on python tests
Gijsreyn Nov 15, 2024
e5a49f3
Add tests
Gijsreyn Nov 15, 2024
6aab6a6
Fix spelling
Gijsreyn Nov 15, 2024
a417fd6
Add spelling
Gijsreyn Nov 15, 2024
7cf3d6d
Merge branch 'main' into windows-update-setting
Gijsreyn Nov 15, 2024
2e401fd
Resolve conflicts in spelling
Dec 2, 2024
7f95436
Generic terms
Dec 2, 2024
6ca7556
Spelling
Dec 2, 2024
0fbd0c3
Spelling
Dec 2, 2024
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
@@ -0,0 +1,50 @@
---
external help file: Microsoft.Windows.Setting.Update.psm1-Help.xml
Module Name: Microsoft.Windows.Setting.Update
ms.date: 11/04/2024
online version:
schema: 2.0.0
title: WindowsUpdate
---

# WindowsUpdate

## SYNOPSIS

The `WindowsUpdate` DSC resource allows you to configure various Windows Update settings, including enabling or disabling specific update services, setting download and upload rates, and configuring active hours for updates.

## DESCRIPTION

The `WindowsUpdate` DSC resource allows you to configure various Windows Update settings, including enabling or disabling specific update services, setting download and upload rates, and configuring active hours for updates.

## PARAMETERS

| **Parameter** | **Attribute** | **DataType** | **Description** | **Allowed Values** |
| -------------------------------------------------- | ------------- | ------------ | -------------------------------------------------------------------------------- | ----------------------------------------------- |
| `SID` | Key | String | The security identifier. This is a key property and should not be set manually. | N/A |
| `IsContinuousInnovationOptedIn` | Optional | Boolean | Indicates whether the device is opted in to continuous innovation updates. | `$true`, `$false` |
| `AllowMUUpdateService` | Optional | Boolean | Allows updates from Microsoft Update service. | `$true`, `$false` |
| `IsExpedited` | Optional | Boolean | Indicates whether updates should be expedited. | `$true`, `$false` |
| `AllowAutoWindowsUpdateDownloadOverMeteredNetwork` | Optional | Boolean | Allows automatic Windows Update downloads over metered networks. | `$true`, `$false` |
| `RestartNotificationsAllowed` | Optional | Boolean | Allows restart notifications for updates. | `$true`, `$false` |
| `SmartActiveHoursState` | Optional | String | Configures smart active hours state for updates. | `Enabled`, `Disabled` |
| `UserChoiceActiveHoursEnd` | Optional | Integer | Specifies the end time for user-chosen active hours in `HH:MM` format. | Any valid time in `HH:MM` format |
| `UserChoiceActiveHoursStart` | Optional | Integer | Specifies the start time for user-chosen active hours in `HH:MM` format. | Any valid time in `HH:MM` format |
| `DownloadMode` | Optional | Integer | Specifies the download mode for updates. | `Foreground`, `Background`, `Bypass`, `None` |
| `DownloadRateBackgroundBps` | Optional | Integer | Specifies the background download rate for updates in Bps. | Any positive integer value. E.g. 20000 is 2MBPs |
| `DownloadRateForegroundBps` | Optional | Integer | Specifies the foreground download rate for updates in Bps. | Any positive integer value |
| `DownloadRateBackgroundPct` | Optional | Integer | Specifies the background download rate for updates as a percentage of bandwidth. | 0-100 |
| `DownloadRateForegroundPct` | Optional | Integer | Specifies the foreground download rate for updates as a percentage of bandwidth. | 0-100 |
| `UploadLimitGBMonth` | Optional | Integer | Specifies the upload limit for updates in GB per month. | 5-500 |
| `UpRatePctBandwidth` | Optional | Integer | Specifies the upload rate as a percentage of bandwidth. | 0-100 |

## EXAMPLES

### EXAMPLE 1

```powershell
$params = @{}
Invoke-DscResource -Name WindowsUpdate -Method Set -Property $params -ModuleName Microsoft.Windows.Setting.WindowsUpdate

# This command gets the current Windows Update settings.
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@
#
# Module manifest for module 'Microsoft.Windows.Setting.WindowsUpdate'
#
# Generated by: Microsoft Corporation
#
# Generated on: 04/11/2024
#

@{

# Script module or binary module file associated with this manifest.
RootModule = 'Microsoft.Windows.Setting.WindowsUpdate.psm1'

# Version number of this module.
ModuleVersion = '0.1.0'

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = '6a0a9e72-9797-4c28-94ca-ebfbef3d7116'

# Author of this module
Author = 'Microsoft Corporation'

# Company or vendor of this module
CompanyName = 'Microsoft Corporation'

# Copyright statement for this module
Copyright = '(c) Microsoft Corporation. All rights reserved.'

# Description of the functionality provided by this module
Description = 'DSC Resource for Windows Update Settings'

# Minimum version of the PowerShell engine required by this module
PowerShellVersion = '7.2'

# Name of the PowerShell host required by this module
# PowerShellHostName = ''

# Minimum version of the PowerShell host required by this module
# PowerShellHostVersion = ''

# Minimum version of Microsoft .NET Framework required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# DotNetFrameworkVersion = ''

# Minimum version of the common language runtime (CLR) required by this module. This prerequisite is valid for the PowerShell Desktop edition only.
# ClrVersion = ''

# Processor architecture (None, X86, Amd64) required by this module
# ProcessorArchitecture = ''

# Modules that must be imported into the global environment prior to importing this module
# RequiredModules = @()

# Assemblies that must be loaded prior to importing this module
# RequiredAssemblies = @()

# Script files (.ps1) that are run in the caller's environment prior to importing this module.
# ScriptsToProcess = @()

# Type files (.ps1xml) to be loaded when importing this module
# TypesToProcess = @()

# Format files (.ps1xml) to be loaded when importing this module
# FormatsToProcess = @()

# Modules to import as nested modules of the module specified in RootModule/ModuleToProcess
# NestedModules = @()

# Functions to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no functions to export.
FunctionsToExport = '*'

# Cmdlets to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no cmdlets to export.
CmdletsToExport = '*'

# Variables to export from this module
VariablesToExport = '*'

# Aliases to export from this module, for best performance, do not use wildcards and do not delete the entry, use an empty array if there are no aliases to export.
AliasesToExport = '*'
Gijsreyn marked this conversation as resolved.
Show resolved Hide resolved

# DSC resources to export from this module
DscResourcesToExport = @('WindowsUpdate')

# List of all modules packaged with this module
# ModuleList = @()

# List of all files packaged with this module
# FileList = @()

# Private data to pass to the module specified in RootModule/ModuleToProcess. This may also contain a PSData hashtable with additional module metadata used by PowerShell.
PrivateData = @{

PSData = @{

# Tags applied to this module. These help with module discovery in online galleries.
Tags = @(
'PSDscResource_WindowsUpdate'
)

# A URL to the license for this module.
LicenseUri = 'https://github.com/microsoft/winget-dsc/blob/main/LICENSE'

# A URL to the main website for this project.
ProjectUri = 'https://github.com/microsoft/winget-dsc'

# A URL to an icon representing this module.
# IconUri = ''

# ReleaseNotes of this module
# ReleaseNotes = ''

# Prerelease string of this module
Prerelease = 'alpha'

# Flag to indicate whether the module requires explicit user acceptance for install/update/save
# RequireLicenseAcceptance = $false

# External dependent modules of this module
# ExternalModuleDependencies = @()

} # End of PSData hashtable

} # End of PrivateData hashtable

# HelpInfo URI of this module
# HelpInfoURI = ''

# Default prefix for commands exported from this module. Override the default prefix using Import-Module -Prefix.
# DefaultCommandPrefix = ''

}

Loading