Update-Module
Downloads and installs the newest version of specified modules from an online gallery to the local computer.
語法
All
Update-Module
[[-Name] <String[]>]
[-RequiredVersion <String>]
[-MaximumVersion <String>]
[-Credential <PSCredential>]
[-Scope <String>]
[-Proxy <Uri>]
[-ProxyCredential <PSCredential>]
[-Force]
[-AllowPrerelease]
[-AcceptLicense]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
The Update-Module cmdlet installs a module's newest version from an online gallery. You're
prompted to confirm the update before it's installed. Updates are installed only for modules that
were installed on the local computer with Install-Module. Update-Module searches
$env:PSModulePath for installed modules.
Update-Module with no parameters specified updates all installed modules. To specify a module to
update, use the Name parameter. You can update to a module's specific version using the
RequiredVersion parameter.
The parameters that take module version numbers expect strings formatted as version numbers.
- Standard version numbers have a format of
x.y.zwhere x, y, and z are numbers - Prerelease versions have a format of
x.y.z-<prerelease_label>where the<prerelease_label>is arbitrary string assigned to that release.
If an installed module is already the newest version, the module isn't updated. If the module isn't
found in $env:PSModulePath, an error is displayed.
To display the installed modules, use Get-InstalledModule.
範例
Example 1: Update all modules
This example updates all installed modules to the newest version in an online gallery.
Update-Module
Example 2: Update a module by name
This example updates a specific module to the newest version in an online gallery.
Update-Module -Name SpeculationControl
Update-Module uses the Name parameter to update a specific module, SpeculationControl.
Example 3: View what-if Update-Module runs
This example does a what-if scenario to show what happens if Update-Module is run. The command
isn't run.
Update-Module -WhatIf
What if: Performing the operation "Update-Module" on target "Version '2.8.0' of module
'Carbon', updating to version '2.8.1'".
What if: Performing the operation "Update-Module" on target "Version '1.0.10' of module
'SpeculationControl', updating to version '1.0.14'".
Update-Module uses the WhatIf parameter display what would happen if Update-Module were run.
Example 4: Update a module to a specified version
In this example, a module is updated to a specific version. The version must exist in the online gallery or an error is displayed.
Update-Module -Name SpeculationControl -RequiredVersion 1.0.14
Update-Module uses the Name parameter to specify the module, SpeculationControl. The
RequiredVersion parameter specifies the version, 1.0.14.
Example 5: Update a module without confirmation
This example doesn't request confirmation to update the module to the newest version from an online gallery. If the module is already installed, the Force parameter reinstalls the module.
Update-Module -Name SpeculationControl -Force
Update-Module uses the Name parameter to specify the module, SpeculationControl. The
Force parameter updates the module without requesting user confirmation.
參數
-AcceptLicense
Automatically accept the license agreement during installation if the package requires it.
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-AllowPrerelease
Allows you to update a module with the newer module marked as a prerelease.
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Confirm
Prompts you for confirmation before running Update-Module.
參數屬性
| 類型: | SwitchParameter |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | cf |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Credential
Specifies a user account that has permission to update a module.
參數屬性
| 類型: | PSCredential |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Force
Forces an update of each specified module without a prompt to request confirmation. If the module is already installed, Force reinstalls the module.
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-MaximumVersion
Specifies the maximum version of a single module to update. You can't add this parameter if you're attempting to update multiple modules. The MaximumVersion and the RequiredVersion parameters can't be used in the same command.
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Name
Specifies the names of one or more modules to update. Update-Module searches $env:PSModulePath
for the modules to update. If no matches are found in $env:PSModulePath for the specified module
name, an error occurs.
Wildcards are accepted in module names. If you add wildcard characters to the specified name and no matches are found, no error occurs.
參數屬性
| 類型: | String[] |
| 預設值: | None |
| 支援萬用字元: | True |
| 不要顯示: | False |
參數集
(All)
| Position: | 0 |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-PassThru
Returns an object representing the item with which you are working. By default, this cmdlet does not generate any output.
參數屬性
| 類型: | SwitchParameter |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Proxy
Specifies a proxy server for the request, rather than connecting directly to an internet resource.
參數屬性
| 類型: | Uri |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-ProxyCredential
Specifies a user account that has permission to use the proxy server specified by the Proxy parameter.
參數屬性
| 類型: | PSCredential |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-RequiredVersion
Specifies the exact version to which the existing installed module will be updated. The version specified by RequiredVersion must exist in the online gallery or an error is displayed. If more than one module is updated in a single command, you can't use RequiredVersion.
參數屬性
| 類型: | String |
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | True |
| 來自剩餘引數的值: | False |
-Scope
Specifies the installation scope of the module. The acceptable values for this parameter are AllUsers and CurrentUser. If Scope isn't specified, the update is installed in the CurrentUser scope.
The AllUsers scope requires elevated permissions and installs modules in a location that is accessible to all users of the computer:
$env:ProgramFiles\PowerShell\Modules
The CurrentUser doesn't require elevated permissions and installs modules in a location that is accessible only to the current user of the computer:
$HOME\Documents\PowerShell\Modules
When no Scope is defined, the default is set based on the PowerShellGet version.
- In PowerShellGet versions 2.0.0 and above, the default is CurrentUser, which does not require elevation for install.
- In PowerShellGet 1.x versions, the default is AllUsers, which requires elevation for install.
參數屬性
| 類型: | String |
| 預設值: | CurrentUser |
| 接受的值: | CurrentUser, AllUsers |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-WhatIf
Shows what would happen if Update-Module runs. The cmdlet isn't run.
參數屬性
| 類型: | SwitchParameter |
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
| 別名: | wi |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
輸入
輸出
備註
PowerShell includes the following aliases for Update-Module:
- All platforms:
upmo
For PowerShell version 6.0 and above, the default installation scope is always CurrentUser.
Module updates for CurrentUser, $HOME\Documents\PowerShell\Modules, don't need elevated
permissions. Module updates for AllUsers, $env:ProgramFiles\PowerShell\Modules, need elevated
permissions.
Important
As of April 2020, the PowerShell Gallery no longer supports Transport Layer Security (TLS) versions 1.0 and 1.1. If you are not using TLS 1.2 or higher, you will receive an error when trying to access the PowerShell Gallery. Use the following command to ensure you are using TLS 1.2:
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
For more information, see the announcement in the PowerShell blog.
Update-Module runs on PowerShell 3.0 or later releases of PowerShell, on Windows 7 or Windows 2008
R2 and later releases of Windows.
If the module that you specify with the Name parameter wasn't installed using Install-Module,
an error occurs.
You can only run Update-Module on modules that you installed from the online gallery by running
Install-Module.
If Update-Module attempts to update binaries that are in use, Update-Module returns an error
that identifies the problem processes. The user is informed to retry Update-Module after the
processes are stopped.
