Add background DSC classes for personalization

.github/actions/spelling/allow.txt

@@ -67,4 +67,11 @@ websites
 wekyb
 Hmmss
 MMdd
-MMdd
+MMdd
+hif
+jfif
+jpe
+jxl
+jxr
+lpv
+wdp

.github/actions/spelling/expect/generic_terms.txt

@@ -20,3 +20,8 @@ usr
 versioning
 VGpu
 ADDLOCAL
+Datacenter
+Cim
+HPC
+Sku
+windir

pipelines/azure-pipelines.yml

@@ -1,5 +1,5 @@
 # winget-dsc pipeline to publish artifacts
-name: '$(Build.DefinitionName)-$(Build.DefinitionVersion)-$(Date:yyyyMMdd)-$(Rev:r)'
+name: "$(Build.DefinitionName)-$(Build.DefinitionVersion)-$(Date:yyyyMMdd)-$(Rev:r)"
 
 # Commit triggers
 trigger:
@@ -41,43 +41,47 @@ extends:
       - stage: WinGet_DSC_Artifacts_Publish
         jobs:
           - job: Publish_WinGet_DSC_Resources
-            displayName: 'Publish WinGet DSC Resources'
+            displayName: "Publish WinGet DSC Resources"
             templateContext:
               outputs:
                 - output: pipelineArtifact
-                  displayName: 'Publish Pipeline Microsoft.Windows.Developer'
+                  displayName: "Publish Pipeline Microsoft.Windows.Developer"
                   targetPath: $(Build.SourcesDirectory)\resources\Microsoft.Windows.Developer\
                   artifactName: Microsoft.Windows.Developer
                 - output: pipelineArtifact
-                  displayName: 'Publish Pipeline Microsoft.Windows.Setting.Accessibility'
+                  displayName: "Publish Pipeline Microsoft.Windows.Setting.Accessibility"
                   targetPath: $(Build.SourcesDirectory)\resources\Microsoft.Windows.Setting.Accessibility\
                   artifactName: Microsoft.Windows.Setting.Accessibility
                 - output: pipelineArtifact
-                  displayName: 'Publish Pipeline PythonPip3Dsc'
+                  displayName: "Publish Pipeline Microsoft.Windows.Setting.Personalization"
+                  targetPath: $(Build.SourcesDirectory)\resources\Microsoft.Windows.Setting.Personalization\
+                  artifactName: Microsoft.Windows.Setting.Personalization
+                - output: pipelineArtifact
+                  displayName: "Publish Pipeline PythonPip3Dsc"
                   targetPath: $(Build.SourcesDirectory)\resources\PythonPip3Dsc\
                   artifactName: PythonPip3Dsc
                 - output: pipelineArtifact
-                  displayName: 'Publish Pipeline YarnDsc'
+                  displayName: "Publish Pipeline YarnDsc"
                   targetPath: $(Build.SourcesDirectory)\resources\YarnDsc\
                   artifactName: YarnDsc
                 - output: pipelineArtifact
-                  displayName: 'Publish Pipeline NpmDsc'
+                  displayName: "Publish Pipeline NpmDsc"
                   targetPath: $(Build.SourcesDirectory)\resources\NpmDsc\
                   artifactName: NpmDsc
                 - output: pipelineArtifact
-                  displayName: 'Publish Pipeline Microsoft.WindowsSandbox.DSC'
+                  displayName: "Publish Pipeline Microsoft.WindowsSandbox.DSC"
                   targetPath: $(Build.SourcesDirectory)\resources\Microsoft.WindowsSandbox.DSC\
                   artifactName: Microsoft.WindowsSandbox.DSC
                 - output: pipelineArtifact
-                  displayName: 'Publish Pipeline GitDsc'
+                  displayName: "Publish Pipeline GitDsc"
                   targetPath: $(Build.SourcesDirectory)\resources\GitDsc\
                   artifactName: GitDsc
                 - output: pipelineArtifact
-                  displayName: 'Publish Pipeline Microsoft.VSCode.Dsc'
+                  displayName: "Publish Pipeline Microsoft.VSCode.Dsc"
                   targetPath: $(Build.SourcesDirectory)\resources\Microsoft.VSCode.Dsc\
                   artifactName: Microsoft.VSCode.Dsc
                 - output: pipelineArtifact
-                  displayName: 'Publish Pipeline Microsoft.DotNet.Dsc'
+                  displayName: "Publish Pipeline Microsoft.DotNet.Dsc"
                   targetPath: $(Build.SourcesDirectory)\resources\Microsoft.DotNet.Dsc\
                   artifactName: Microsoft.DotNet.Dsc
 
@@ -87,10 +91,10 @@ extends:
                 fetchTags: false
 
               - task: PowerShell@2
-                displayName: 'Run Pester tests for DSC modules'
+                displayName: "Run Pester tests for DSC modules"
                 inputs:
                   pwsh: true
-                  targetType: 'inline'
+                  targetType: "inline"
                   script: |
                     $env:PSModulePath += ";$(Build.SourcesDirectory)\resources"
                     Invoke-Pester -CI
@@ -99,6 +103,6 @@ extends:
 
               - task: PublishTestResults@2
                 inputs:
-                  testResultsFormat: 'NUnit'
-                  testResultsFiles: '**/Test*.xml'
+                  testResultsFormat: "NUnit"
+                  testResultsFiles: "**/Test*.xml"
                   failTaskOnFailedTests: true

resources/Help/Microsoft.Windows.Setting.Personalization/BackgroundPicture.md

@@ -0,0 +1,36 @@
+---
+external help file: Microsoft.Windows.Setting.Personalization.psm1-Help.xml
+Module Name: Microsoft.Windows.Setting.Personalization
+ms.date: 01/09/2025
+online version:
+schema: 2.0.0
+title: BackgroundPicture
+---
+
+# BackgroundPicture
+
+## SYNOPSIS
+
+The `BackgroundPicture` class contains DSC resources for configuring the desktop background picture.
+
+## DESCRIPTION
+
+The `BackgroundPicture` class contains DSC resources for configuring the desktop background picture.
+
+## PARAMETERS
+
+| **Parameter**   | **Attribute**  | **DataType** | **Description**                                                                                                                                                      | **Allowed Values**                         |
+| --------------- | -------------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
+| Picture         | Key, Mandatory | String       | The path to the image file that will be used as the desktop background picture.                                                                                      | Any valid image path.                      |
+| Style           | Optional       | String       | The style of the desktop background picture.                                                                                                                         | { Fill, Fit, Stretch, Tile, Center, Span } |
+| BackgroundColor | Optional       | String       | The color of the desktop background. The value should be in the format `R,G,B`, where `R`, `G`, and `B` are the red, green, and blue color components, respectively. | Any RGB code in 0,0,0 format.              |
+
+## EXAMPLES
+
+### EXAMPLE 1 - Example to set the background picture, style and color
+
+```powershell
+Invoke-DscResource -Name BackgroundPicture -Method Set -Property @{ Picture = 'C:\Pictures\Background.jpg'; Style = 'Fill'; BackgroundColor = '255,255,255' }
+
+# This example sets the desktop background picture to `C:\Pictures\Background.jpg` with the `Fill` style and white background color.
+```

resources/Help/Microsoft.Windows.Setting.Personalization/BackgroundSlideShow.md

@@ -0,0 +1,38 @@
+---
+external help file: Microsoft.Windows.Setting.Personalization.psm1-Help.xml
+Module Name: Microsoft.Windows.Setting.Personalization
+ms.date: 01/09/2025
+online version:
+schema: 2.0.0
+title: BackgroundSlideShow
+---
+
+# BackgroundSlideShow
+
+## SYNOPSIS
+
+The `BackgroundSlideShow` class contains DSC resources for configuring the desktop background slideshow.
+
+## DESCRIPTION
+
+The `BackgroundSlideShow` class contains DSC resources for configuring the desktop background slideshow.
+
+## PARAMETERS
+
+| **Parameter**    | **Attribute** | **DataType** | **Description**                                                                   | **Allowed Values**                                                                   |
+| ---------------- | ------------- | ------------ | --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
+| `PictureAlbum`   | Key           | String       | The path to the folder containing the images for the slideshow.                   |                                                                                      |
+| `SlideDuration`  | Optional      | Integer      | The duration for each slide in milliseconds. Defaults to 30 minutes.              | Valid values are '60000', '600000', '1800000', '3600000', '21600000', and '86400000' |
+| `Shuffle`        | Optional      | Boolean      | Indicates whether the slideshow should shuffle the images.                        | `True` or `False`                                                                    |
+| `PauseOnBattery` | Optional      | Boolean      | Indicates whether the slideshow should pause when the device is on battery power. | `True` or `False`                                                                    |
+| `Style`          | Optional      | String       | The style of the desktop background picture.                                      | { Fill, Fit, Stretch, Tile, Center, Span }                                           |
+
+## EXAMPLES
+
+### EXAMPLE 1 - Example setting all properties with slide duration on 1 hour
+
+```powershell
+Invoke-DscResource -Name BackgroundSlideShow -Method Set -Property @{ PictureAlbum = 'C:\Pictures\Album'; SlideDuration = '1800000'; Shuffle = $true; PauseOnBattery = $true; Style = 'Fill' }
+
+# This example sets the desktop background slideshow to use images from `C:\Pictures\Album` with a slide duration of 30 minutes, shuffling enabled, pausing on battery, and the `Fill` style.
+```

resources/Help/Microsoft.Windows.Setting.Personalization/BackgroundSolidColor.md

@@ -0,0 +1,34 @@
+---
+external help file: Microsoft.Windows.Setting.Personalization.psm1-Help.xml
+Module Name: Microsoft.Windows.Setting.Personalization
+ms.date: 01/09/2025
+online version:
+schema: 2.0.0
+title: BackgroundSolidColor
+---
+
+# BackgroundSolidColor
+
+## SYNOPSIS
+
+The `BackgroundSolidColor` class contains DSC resources for configuring the desktop background color.
+
+## DESCRIPTION
+
+The `BackgroundSolidColor` class contains DSC resources for configuring the desktop background color.
+
+## PARAMETERS
+
+| **Parameter**   | **Attribute**  | **DataType** | **Description**                                                                                                                                                      | **Allowed Values**                         |
+| --------------- | -------------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
+| BackgroundColor | Key, Mandatory   | String       | The color of the desktop background. The value should be in the format `R,G,B`, where `R`, `G`, and `B` are the red, green, and blue color components, respectively. | Any RGB code in 0,0,0 format.              |
+
+## EXAMPLES
+
+### EXAMPLE 1 - Example to set the background color
+
+```powershell
+Invoke-DscResource -Name BackgroundSolidColor -Method Set -Property @{ BackgroundColor = '255,255,255' }
+
+# This example sets the desktop background color to white.
+```

resources/Help/Microsoft.Windows.Setting.Personalization/BackgroundWindowsSpotlight.md

@@ -0,0 +1,35 @@
+---
+external help file: Microsoft.Windows.Setting.Personalization.psm1-Help.xml
+Module Name: Microsoft.Windows.Setting.Personalization
+ms.date: 01/09/2025
+online version:
+schema: 2.0.0
+title: BackgroundWindowsSpotlight
+---
+
+# BackgroundWindowsSpotlight
+
+## SYNOPSIS
+
+The `BackgroundWindowsSpotlight` class contains DSC resources for configuring the Windows Spotlight feature.
+
+## DESCRIPTION
+
+The `BackgroundWindowsSpotlight` class contains DSC resources for configuring the Windows Spotlight feature.
+
+## PARAMETERS
+
+| **Parameter**            | **Attribute**  | **DataType** | **Description**                                                                 | **Allowed Values** |
+| ------------------------ | -------------- | ------------ | ------------------------------------------------------------------------------- | ------------------ |
+| `SID`                    | Key, Mandatory | String       | The security identifier. This is a key property and should not be set manually. |                    |
+| `EnableWindowsSpotlight` | Optional       | Boolean      | Indicates whether the Windows Spotlight feature should be enabled.              | `True` or `False`  |
+
+## EXAMPLES
+
+### EXAMPLE 1 - Example turning on Windows Spotlight background feature
+
+```powershell
+Invoke-DscResource -Name BackgroundWindowsSpotlight -Method Set -Property @{ EnableWindowsSpotlight = $true }
+
+# This example enables the Windows Spotlight feature.
+```

resources/Microsoft.Windows.Setting.Personalization/Microsoft.Windows.Setting.Personalization.psd1

@@ -0,0 +1,38 @@
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License.
+@{
+    RootModule           = 'Microsoft.Windows.Setting.Personalization.psm1'
+    ModuleVersion        = '0.1.0'
+    GUID                 = '7b91df07-d95a-4234-b11c-7595f21c28fc'
+    Author               = 'Microsoft Corporation'
+    CompanyName          = 'Microsoft Corporation'
+    Copyright            = '(c) Microsoft Corp. All rights reserved.'
+    Description          = 'The DSC module for Windows Personalization'
+    PowerShellVersion    = '7.4'
+    DscResourcesToExport = @(
+        'BackgroundPicture',
+        'BackgroundSolidColor',
+        'BackgroundSlideshow',
+        'BackgroundWindowsSpotlight'
+    )
+    PrivateData          = @{
+        PSData = @{
+            # Tags applied to this module. These help with module discovery in online galleries.
+            Tags       = @(
+                'PSDscResource_BackgroundPicture',
+                'PSDscResource_BackgroundSolidColor',
+                'PSDscResource_BackgroundSlideshow',
+                'PSDscResource_BackgroundWindowsSpotlight'
+            )
+
+            # 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'
+
+            # Prerelease string of this module
+            Prerelease = 'alpha'
+        }
+    }
+}