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

New Microsoft.Windows.Setting.Privacy #131

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
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
32 changes: 20 additions & 12 deletions .github/actions/spelling/expect/generic_terms.txt
Original file line number Diff line number Diff line change
@@ -1,21 +1,29 @@
AKV
wildcards
ssh
Amd
Authenticode
automerge
usr
screenshots
currentstate
Scrollbars
Searchbox
VGpu
versioning
worktree
sortby
msft
automerge
Workaround

Check warning on line 15 in .github/actions/spelling/expect/generic_terms.txt

View workflow job for this annotation

GitHub Actions / Check Spelling

`Workaround` is ignored by check spelling because another more general variant is also in expect. (ignored-expect-variant)
keyvalue
psobject
webcam
websites
workaround
AKV
Authenticode
esrp
gtm
msft
NPH
Peet
rfc
screenshots
Scrollbars
Searchbox
SFP
Signtool
sortby
ssh
usr
versioning
VGpu
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
external help file: Microsoft.Windows.Setting.Privacy.psm1-Help.xml
Module Name: Microsoft.Windows.Setting.Privacy
ms.date: 11/04/2024
online version:
schema: 2.0.0
title: Privacy
---

# Privacy

## SYNOPSIS

The `Privacy` DSC Resource allows you to manage Windows privacy settings. This resource ensures that the specified privacy settings are in the desired state on your local machine.

## DESCRIPTION

The `Privacy` DSC Resource allows you to manage Windows privacy settings. This resource ensures that the specified privacy settings are in the desired state on your local machine.

## 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 |
| `EnablePersonalizedAds` | Optional | Boolean | Indicates whether personalized ads should be enabled. The default value is `$null`. You can find the setting in `Settings > Privacy & security > General -> Let apps show me personalized ads by using my advertising ID. | `$true`, `$false` | |
| `EnableLocalContentByLanguageList` | Optional | Boolean | Indicates whether local content by language list should be enabled. The default value is `$null`. You can find the setting in `Settings > Privacy & security > General -> Let Windows provide locally relevant content based on my language list. | `$true`, `$false` | |
| `EnableAppLaunchTracking` | Optional | Boolean | Indicates whether app launch tracking should be enabled. The default value is `$null`. You can find the setting in `Settings > Privacy & security > General -> Let Windows improve Start and search results by tracking app launches. | `$true`, `$false` | |
| `ShowContentSuggestion` | Optional | Boolean | Indicates whether content suggestions should be shown. The default value is `$null`. You can find the setting in `Settings > Privacy & security > General -> Show me suggested content in the Settings app. | `$true`, `$false` | |
| `EnableAccountNotifications` | Optional | Boolean | Indicates whether account notifications should be enabled. The default value is `$null`. You can find the setting in `Settings > Privacy & security > General -> Show me notifications in the Settings app. | `$true`, `$false` | |


## EXAMPLES

### EXAMPLE 1 - Set the personalized ads on

```powershell
PS C:\> $params = @{#
EnablePersonalizedAds = $true
}
PS C:\> Invoke-DscResource -Name Privacy -Method Set -Property $params -ModuleName Microsoft.Windows.Setting.Privacy

# This enables personalized ads for the specified user.
```

### Example 2 - Disable app launch tracking

```powershell
PS C:\> $params = @{
EnableAppLaunchTracking = $false
}
PS C:\> Invoke-DscResource -Name Privacy -Method Set -Property $params -ModuleName Microsoft.Windows.Setting.Privacy

# This disables app launch tracking for the specified user.
```

### Example 3 - Turn on content suggestion

```powershell
PS C:\> $params = @{
ShowContentSuggestion = $true
}
PS C:\> Invoke-DscResource -Name Privacy -Method Set -Property $params -ModuleName Microsoft.Windows.Setting.Privacy

This enables content suggestions for the specified user.
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
#
# Module manifest for module 'Microsoft.Windows.Setting.Privacy'
#
# Generated by: Microsoft Corporation
#
# Generated on: 11/14/2024
#

@{

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

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

# Supported PSEditions
# CompatiblePSEditions = @()

# ID used to uniquely identify this module
GUID = '151d9b2f-4c29-4920-b75f-a220fdb24888'

# 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 Settings Privacy'

# 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 = @('Privacy')

# 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 = @()

# 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
Loading