winget-cli

Unnamed repository; edit this file 'description' to name the repository.
Log | Files | Refs | README | LICENSE

WinGetUserSettings.md (1103B)

      1 ---
      2 external help file: Microsoft.WinGet.DSC.psm1-Help.xml
      3 Module Name: Microsoft.WinGet.DSC
      4 ms.date: 08/28/2024
      5 online version:
      6 schema: 2.0.0
      7 title: WinGetUserSettings
      8 ---
      9 
     10 # WinGetUserSettings
     11 
     12 ## SYNOPSIS
     13 Configures WinGet user settings.
     14 
     15 ## DESCRIPTION
     16 
     17 Allows part or all of the user settings to be configured or retrieved.
     18 
     19 ## PARAMETERS
     20 
     21 **Parameter**|**Attribute**|**DataType**|**Description**|**Allowed Values**
     22 :-----|:-----|:-----|:-----|:-----
     23 `SID`|Key|String|The SID of the user to target, or an empty string to target the current user. **Only the empty string is currently supported.**|See [security identifiers](https://learn.microsoft.com/en-us/windows-server/identity/ad-ds/manage/understand-security-identifiers)
     24 `Settings`|Mandatory|Hashtable|The user settings as a hashtable.|See [the schema](https://github.com/microsoft/winget-cli/blob/master/schemas/JSON/settings/settings.schema.0.2.json)
     25 `Action`|Optional|WinGetAction|Determines whether to overwrite (`Full`) or merge (`Partial`) the value provided in `Settings` with the current user settings.|`Full` (default), `Partial`