Update-PSScriptFileInfo

此 cmdlet 更新现有脚本 .ps1 文件中基于注释的元数据。

语法

Default (默认值)

Update-PSScriptFileInfo
    [-Author <String>]
    [-CompanyName <String>]
    [-Copyright <String>]
    [-Description <String>]
    [-ExternalModuleDependencies <String[]>]
    [-ExternalScriptDependencies <String[]>]
    [-Guid <Guid>]
    [-IconUri <String>]
    [-LicenseUri <String>]
    [-Path] <String>
    [-PrivateData <String>]
    [-ProjectUri <String>]
    [-ReleaseNotes <String>]
    [-RemoveSignature]
    [-RequiredModules <Hashtable[]>]
    [-RequiredScripts <String[]>]
    [-Tags <String[]>]
    [-Version <String>]
    [<CommonParameters>]

说明

此 cmdlet 更新现有脚本 .ps1 文件中基于注释的元数据。 这类似于 Update-ModuleManifest

示例

示例 1:更新脚本的版本

在此示例中,创建脚本时 版本 设置为 1.0.0.0Update-PSScriptFileInfo版本更改为 2.0.0.0Get-Content cmdlet 显示脚本的更新内容。

$parameters = @{
    FilePath = "C:\Users\johndoe\MyScripts\test_script.ps1"
    Version = "1.0.0.0"
    Description = "this is a test script"
}
New-PSScriptFileInfo @parameters
$parameters.Version = "2.0.0.0"
Update-PSScriptFileInfo @parameters
Get-Content $parameters.FilePath
<#PSScriptInfo

.VERSION 2.0.0.0

.GUID 6ec3934e-a2e0-495b-9a9c-480e555ad1d1

.AUTHOR johndoe

.COMPANYNAME

.COPYRIGHT

.TAGS

.LICENSEURI

.PROJECTURI

.ICONURI

.EXTERNALMODULEDEPENDENCIES

.REQUIREDSCRIPTS

.EXTERNALSCRIPTDEPENDENCIES

.RELEASENOTES

.PRIVATEDATA

#>

<#

.DESCRIPTION
this is a test script

#>

参数

-Author

脚本的作者的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-CompanyName

拥有脚本的公司的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

脚本的版权信息。

类型: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

-Guid

采用 GUID 格式的脚本的唯一标识符。

参数属性

类型:Guid
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-IconUri

指向与脚本关联的图标的统一资源标识符(URI)。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-LicenseUri

指向与脚本关联的许可协议文件的 URI。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Path

脚本的文件名和位置。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:0
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PrivateData

与脚本关联的专用数据。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ProjectUri

指向与脚本关联的项目站点的 URI。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ReleaseNotes

脚本的发行说明。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-RemoveSignature

从已签名的 .ps1 文件中删除签名,以便更新脚本。 更新文件后,应重新签名。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-RequiredModules

该参数采用模块规范哈希表数组。 模块规范是具有以下键的哈希表。

  • ModuleName - 必需 指定模块名称。
  • GUID - 可选 指定模块的 GUID。
  • 它还 必需 指定以下三个键中的至少一个。
    • ModuleVersion - 指定模块的最低可接受版本。
    • MaximumVersion - 指定模块的最大可接受版本。
    • RequiredVersion - 指定模块的确切所需版本。 这不能与其他版本密钥一起使用。

参数属性

类型:

Hashtable[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-RequiredScripts

脚本所需的脚本列表。

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Tags

与脚本关联的标记。 标记值是不应包含空格的字符串。 有关详细信息,请参阅 标记详细信息

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False
别名:标记

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Version

脚本的版本。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

None

输出

Object

备注

New-PSScriptFileInfoUpdate-PSScriptFileInfo cmdlet 在帮助文件的 #requires 和基于注释的帮助块之间放置所需模块的 <#PSScriptInfo 语句。 Get-PSScriptFileInfo 要求将 #requires 语句放在基于注释的帮助块的某个位置。 #requiresGet-PSScriptFileInfo忽略在基于注释的帮助块之后放置的任何 Publish-PSResource 语句。