winget-cli

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

Get-WinGetSetting.md (2445B)

      1 ---
      2 external help file: Microsoft.WinGet.Client.Cmdlets.dll-Help.xml
      3 Module Name: Microsoft.WinGet.Client
      4 ms.date: 08/01/2024
      5 online version:
      6 schema: 2.0.0
      7 title: Get-WinGetSetting
      8 ---
      9 
     10 # Get-WinGetSetting
     11 
     12 ## SYNOPSIS
     13 Gets WinGet configuration settings.
     14 
     15 ## SYNTAX
     16 
     17 ```
     18 Get-WinGetSetting [-AsPlainText] [<CommonParameters>]
     19 ```
     20 
     21 ## DESCRIPTION
     22 
     23 This command gets the WinGet configuration settings. The settings include:
     24 - the schema
     25 - administrative settings
     26 - the location of the user settings file
     27 For more information about WinGet settings, see
     28 [WinGet CLI Settings](https://aka.ms/winget-settings).
     29 
     30 ## EXAMPLES
     31 
     32 ### Example 1 - Display the WinGet configuration settings
     33 
     34 ```powershell
     35 Get-WinGetSetting
     36 ```
     37 
     38 ```Output
     39 
     40 Name              Value
     41 ----              -----
     42 $schema           https://aka.ms/winget-settings-export.schema.json
     43 userSettingsFile  C:\Users\user1\AppData\Local\Packages\Microsoft.DesktopAppInstaller_8wekyb3d8bbwe\Local…
     44 adminSettings     {[ProxyCommandLineOptions, False], [LocalArchiveMalwareScanOverride, False], [InstallerH…
     45 ```
     46 
     47 ### Example 2 - Display the administrative settings in WinGet configuration
     48 
     49 ```powershell
     50 Get-WinGetSetting | Select-Object -ExpandProperty adminSettings
     51 ```
     52 
     53 ```Output
     54 Name                                      Value
     55 ----                                      -----
     56 InstallerHashOverride                     False
     57 ProxyCommandLineOptions                   False
     58 BypassCertificatePinningForMicrosoftStore False
     59 LocalArchiveMalwareScanOverride           False
     60 LocalManifestFiles                        True
     61 ```
     62 
     63 ## PARAMETERS
     64 
     65 ### -AsPlainText
     66 
     67 Output results as plain text
     68 
     69 ```yaml
     70 Type: System.Management.Automation.SwitchParameter
     71 Parameter Sets: (All)
     72 Aliases:
     73 
     74 Required: False
     75 Position: Named
     76 Default value: None
     77 Accept pipeline input: True (ByPropertyName)
     78 Accept wildcard characters: False
     79 ```
     80 
     81 ### CommonParameters
     82 
     83 This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable,
     84 -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable,
     85 -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see
     86 [about_CommonParameters](http://go.microsoft.com/fwlink/?LinkID=113216).
     87 
     88 ## INPUTS
     89 
     90 ### System.Management.Automation.SwitchParameter
     91 
     92 ## OUTPUTS
     93 
     94 ### System.Object
     95 
     96 ## NOTES
     97 
     98 ## RELATED LINKS
     99 
    100 [Get-WinGetUserSetting](Get-WinGetUserSetting.md)
    101 
    102 [Set-WinGetUserSetting](Set-WinGetUserSetting.md)