Update-ScriptFileInfo

模块:

PowerShellGet

汇报脚本的信息。

语法

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>]

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>]

说明

cmdlet Update-ScriptFileInfo 更新脚本的属性值。 例如，版本、作者或说明的值。

示例

示例 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

指定脚本作者。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-CompanyName

指定创建脚本的公司或供应商。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Confirm

在运行 Update-ScriptFileInfo之前提示你进行确认。

Type:	SwitchParameter
Aliases:	cf
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Copyright

指定脚本的版权声明。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Description

指定脚本的说明。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExternalModuleDependencies

指定外部模块依赖项的数组。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ExternalScriptDependencies

指定外部脚本依赖项的数组。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

强制 Update-ScriptFileInfo 运行而不要求用户确认。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Guid

指定脚本的唯一 ID。

Type:	Guid
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-IconUri

指定脚本图标的 URL。 指定的图标显示在脚本的库网页上。

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LicenseUri

指定许可条款的 URL。

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-LiteralPath

指定一个或多个位置的路径。 LiteralPath 参数的值在输入时完全一样使用。 不会将任何字符解释为通配符。 如果路径包含转义字符，请用单引号将它们括起来。 单引号告知 PowerShell 不要将任何字符解释为转义序列。

Type:	String
Aliases:	PSPath
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-PassThru

返回一个 对象，该对象表示正在使用的项。 默认情况下， Update-ScriptFileInfo 不会生成任何输出。

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

指定脚本文件的位置。 允许使用通配符。

Type:	String
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	True

-PrivateData

指定脚本的私有数据。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ProjectUri

指定有关此项目的网页的 URL。

Type:	Uri
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-ReleaseNotes

指定一个字符串数组，其中包含你希望可用于此版本的脚本的发行说明或注释。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RequiredModules

指定必须处于全局会话状态的模块。 如果所需的模块不处于全局会话状态，PowerShell 会导入它们。

Type:	Object[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-RequiredScripts

指定所需脚本的数组。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Tags

指定标记的数组。

Type:	String[]
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Version

指定脚本的版本。

Type:	String
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-WhatIf

显示运行后 Update-ScriptFileInfo 会发生什么情况。 cmdlet 未运行。

Type:	SwitchParameter
Aliases:	wi
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

输入

String

输出

Object

备注

使用 Test-ScriptFileInfo cmdlet 验证脚本的元数据。 脚本必须包含版本、GUID、说明和作者的值。

相关链接

• New-ScriptFileInfo
• Test-ScriptFileInfo