Windows settings update

resources/Help/Microsoft.Windows.Setting.WindowsUpdate/WindowsUpdate.md

@@ -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.
+```

resources/Microsoft.Windows.Setting.WindowsUpdate/Microsoft.Windows.Setting.WindowsUpdate.psd1

@@ -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      = '*'
+
+    # 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 = ''
+
+}
+