Update-PSResource
Downloads and installs the newest version of a package already installed on the local machine.
Syntax
Update-PSResource
[[-Name] <String[]>]
[-Version <String>]
[-Prerelease]
[-Repository <String[]>]
[-Scope <ScopeType>]
[-TemporaryPath <String>]
[-TrustRepository]
[-Credential <PSCredential>]
[-Quiet]
[-AcceptLicense]
[-Force]
[-PassThru]
[-SkipDependencyCheck]
[-AuthenticodeCheck]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Description
Update-PSResource downloads and installs the newest version of a package already installed on the
local machine. This cmdlet replaces the Update-Module and Update-Script cmdlets from
PowerShellGet v2. The new version of the resource is installed side-by-side with previous
versions in a new versioned folder.
By default, Update-PSResource installs the latest version of the package and any of its
dependencies without deleting the older versions installed.
Examples
Example 1
In this example, the user already has the TestModule package installed and they update the package.
Get-PSResource -Name "TestModule"
Name Version Prerelease Description
---- ------- ---------- -----------
TestModule 1.2.0 test
Update-PSResource -Name "TestModule"
Name Version Prerelease Description
---- ------- ---------- -----------
TestModule 1.3.0 test
TestModule 1.2.0 testParameters
-AcceptLicense
For resources that require a license, AcceptLicense automatically accepts the license agreement during the update.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-AuthenticodeCheck
Validates signed files and catalog files on Windows.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Specifies optional credentials used when accessing a private repository.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
When specified, bypasses checks for TrustRepository and AcceptLicense and updates the package.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Name
Specifies the name of one or more resources to update. Wildcards are supported but NuGet only
accepts the * character. NuGet doesn't support wildcard searches of local (file-based)
repositories.
| Type: | String[] |
| Position: | 0 |
| Default value: | "*" |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-PassThru
When specified, outputs a PSResourceInfo object for the saved resource.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Prerelease
When specified, allows updating to a prerelease version.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Quiet
Suppresses progress information.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Repository
Specifies one or more repository names to search. If not specified, search includes all registered repositories, in priority order (highest first), until a repository is found that contains the package. Repositories are sorted by priority then by name. Lower Priority values have a higher precedence.
When searching for resources across multiple repositories, the PSResourceGet cmdlets search the
repositories using this sort order. Update-PSResource updates the first matching package from the
sorted list of repositories.
The parameter supports the * wildcard character. If you specify multiple repositories, all names
must include or omit the wildcard character. You can't specify a mix of names with and without
wildcards.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Scope
Specifies the installation scope. Accepted values are:
CurrentUserAllUsers
The default scope is CurrentUser, which doesn't require elevation.
| Type: | Microsoft.PowerShell.PSResourceGet.UtilClasses.ScopeType |
| Accepted values: | CurrentUser, AllUsers |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SkipDependencyCheck
Skips the check for resource dependencies. This means that only named resources are updated.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TemporaryPath
Specifies the path to temporarily install the resource before actual installatoin. If no temporary path is provided, the resource is temporarily installed in the current user's temporary folder.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TrustRepository
Suppress prompts to trust repository. The prompt to trust repository only occurs if the repository isn't configured as trusted.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Version
Specifies the version of the resource to be returned. The value can be an exact version or a version range using the NuGet versioning syntax.
For more information about NuGet version ranges, see Package versioning.
PowerShellGet supports all but the minimum inclusive version listed in the NuGet version range
documentation. Using 1.0.0.0 as the version doesn't yield versions 1.0.0.0 and higher (minimum
inclusive range). Instead, the value is considered to be the required version. To search for a
minimum inclusive range, use [1.0.0.0, ] as the version range.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-WhatIf
Shows what would happen if the cmdlet runs. The cmdlet isn't run.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
String[]
Outputs
Microsoft.PowerShell.PSResourceGet.UtilClasses.PSResourceInfo
By default, the cmdlet doesn't return any objects. When the PassThru parameter is used, the cmdlet outputs a PSResourceInfo object for the saved resource.
Notes
The module defines udres as an alias for Update-PSResource.
Related Links
PSResourceGet
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for