Update-ScriptFileInfo
语法
PathParameterSet (默认值)
Update-ScriptFileInfo
[-Path] <String>
[-Version <String>]
[-Author <String>]
[-Guid <Guid>]
[-Description <String>]
[-CompanyName <String>]
[-Copyright <String>]
[-RequiredModules <Object[]>]
[-ExternalModuleDependencies <String[]>]
[-RequiredScripts <String[]>]
[-ExternalScriptDependencies <String[]>]
[-Tags <String[]>]
[-ProjectUri <Uri>]
[-LicenseUri <Uri>]
[-IconUri <Uri>]
[-ReleaseNotes <String[]>]
[-PrivateData <String>]
[-PassThru]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LiteralPathParameterSet
Update-ScriptFileInfo
[-LiteralPath] <String>
[-Version <String>]
[-Author <String>]
[-Guid <Guid>]
[-Description <String>]
[-CompanyName <String>]
[-Copyright <String>]
[-RequiredModules <Object[]>]
[-ExternalModuleDependencies <String[]>]
[-RequiredScripts <String[]>]
[-ExternalScriptDependencies <String[]>]
[-Tags <String[]>]
[-ProjectUri <Uri>]
[-LicenseUri <Uri>]
[-IconUri <Uri>]
[-ReleaseNotes <String[]>]
[-PrivateData <String>]
[-PassThru]
[-Force]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
该 Update-ScriptFileInfo cmdlet 更新脚本的属性值。 例如,版本、作者或说明的值。
这是 Update-PSScriptFileInfo 中 cmdlet 的代理 cmdlet。 有关详细信息,请参阅 Update-PSScriptFileInfo。
示例
示例 1:更新脚本文件的版本
在此示例中,使用新的属性值更新现有脚本文件。
Splatting 用于将参数传递给 Update-ScriptFileInfo cmdlet。 有关详细信息,请参阅 about_Splatting。
$Parms = @{
Path = "C:\Test\Temp-Scriptfile.ps1"
Version = "2.0"
Author = "bob@contoso.com"
CompanyName = "Contoso"
Description = "This is the updated description"
}
Update-ScriptFileInfo @Parms -PassThru
<#PSScriptInfo
.VERSION 2.0
.GUID 4609f00c-e850-4d3f-9c69-3741e56e4133
.AUTHOR bob@contoso.com
.COMPANYNAME Contoso
.COPYRIGHT
.TAGS
.LICENSEURI
.PROJECTURI
.ICONURI
.EXTERNALMODULEDEPENDENCIES
.REQUIREDSCRIPTS
.EXTERNALSCRIPTDEPENDENCIES
.RELEASENOTES
.PRIVATEDATA
#>
<#
.DESCRIPTION
This is the updated description
#>
Param()
$Parms 存储 Path、 Version、 Author、 CompanyName 和 Description 的参数值。
Update-ScriptFileInfo 从中获取参数值 @Parms 并更新脚本。
PassThru 参数在 PowerShell 控制台中显示脚本的内容。
参数
-Author
指定脚本作者。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-CompanyName
指定创建脚本的公司或供应商。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Confirm
代理 cmdlet 忽略此参数,因为它不受支持 Update-PSScriptFileInfo。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Copyright
指定脚本的版权声明。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Description
指定脚本的说明。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ExternalModuleDependencies
指定外部模块依赖项的数组。
参数属性
| 类型: | String[]
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ExternalScriptDependencies
指定外部脚本依赖项的数组。
参数属性
| 类型: | String[]
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Force
代理 cmdlet 忽略此参数,因为它不受支持 Update-PSScriptFileInfo。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Guid
指定脚本的唯一 ID。
参数属性
| 类型: | Guid
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-IconUri
指定脚本图标的 URL。 指定的图标显示在脚本的库网页上。
参数属性
| 类型: | Uri
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-LicenseUri
指定许可条款的 URL。
参数属性
| 类型: | Uri
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-LiteralPath
指定通向一个或多个位置的路径。
LiteralPath 参数的值与输入的值完全一样使用。 不会将任何字符解释为通配符。 如果路径包含转义字符,请将它们括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。
代理 cmdlet 将此参数映射到 Path 参数 Update-PSScriptFileInfo。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | PSPath |
参数集
LiteralPathParameterSet
| Position: | 0 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-PassThru
代理 cmdlet 忽略此参数,因为它不受支持 Update-PSScriptFileInfo。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Path
指定脚本文件的位置。 允许使用通配符。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | True |
| 不显示: | False |
参数集
PathParameterSet
| Position: | 0 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | True |
| 来自剩余参数的值: | False |
-PrivateData
指定脚本的专用数据。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ProjectUri
指定有关此项目的网页的 URL。
参数属性
| 类型: | Uri
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-ReleaseNotes
指定一个字符串数组,其中包含要用于此版本的脚本的发行说明或注释。
参数属性
| 类型: | String[]
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-RequiredModules
指定必须处于全局会话状态的模块。 如果所需的模块未处于全局会话状态,PowerShell 会导入它们。
参数属性
| 类型: | Object[]
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-RequiredScripts
指定所需脚本的数组。
参数属性
| 类型: | String[]
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
指定一个标签数组。
| 类型: | String[]
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Version
指定脚本的版本。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-WhatIf
代理 cmdlet 忽略此参数,因为它不受支持 Update-PSScriptFileInfo。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。
输出
备注
使用 Test-ScriptFileInfo cmdlet 验证脚本的元数据。 脚本必须包含 Version、 GUID、 Description 和 Author 的值。