winget-cli

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

WinGetPackage.md (1561B)

      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: WinGetPackage
      8 ---
      9 
     10 # WinGetPackage
     11 
     12 ## SYNOPSIS
     13 Configures packages through WinGet.
     14 
     15 ## DESCRIPTION
     16 
     17 Allows WinGet package state to be configured.
     18 
     19 ## PARAMETERS
     20 
     21 **Parameter**|**Attribute**|**DataType**|**Description**|**Allowed Values**
     22 :-----|:-----|:-----|:-----|:-----
     23 `Id`|Key, Mandatory|String|The identifier of a WinGet package.|Use `Find-WinGetPackage` to search for packages
     24 `Source`|Key|String|The name of the source that provides the package. If not provided, all configured sources will be searched for the `Id`.|Use the `WinGetSources` resource to configure a source or `Get-WinGetSource` to discover the default sources
     25 `Version`|Optional|String|The version of the package.|See the `AvailableVersions` property of output from `Find-WinGetPackage`
     26 `Ensure`|Optional|WinGetEnsure|Whether the package should be installed (`Present`) or not (`Absent`).|`Present` (default), `Absent`
     27 `MatchOption`|Optional|WinGetMatchOption|The method used to compare the `Id` parameter with available packages.|`Equals`, `EqualsCaseInsensitive` (default), `StartsWithCaseInsensitive`, `ContainsCaseInsensitive`
     28 `UseLatest`|Optional|Boolean|Whether the package should updated to the latest available version. If true, takes precedence over `Version`.|`True`, `False` (default)
     29 `InstallMode`|Optional|WinGetInstallMode|The interactivity level requested when installing.|`Default`, `Silent` (default), `Interactive`