Update-ScriptFileInfo

更新腳本的資訊。

Syntax

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

Description

Cmdlet 會 Update-ScriptFileInfo 更新腳本的屬性值。 例如,版本、作者或描述的值。

這是Microsoft.PowerShell.PSResourceGet中 Cmdlet 的 Proxy Cmdlet Update-PSScriptFileInfo 。 如需詳細資訊,請參閱 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 儲存 PathVersionAuthorCompanyNameDescription的參數值。 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

Proxy Cmdlet 會忽略此參數,因為它不受 支援 Update-PSScriptFileInfo

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

指定腳本的著作權聲明。

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

Proxy Cmdlet 會忽略此參數,因為它不受 支援 Update-PSScriptFileInfo

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

-Guid

指定腳本的唯一識別碼。

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 不要將任何字元解譯為逸出序列。

Proxy Cmdlet 會將此參數對應至 的 Update-PSScriptFileInfoPath參數。

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

-PassThru

Proxy Cmdlet 會忽略此參數,因為它不受 支援 Update-PSScriptFileInfo

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

Proxy Cmdlet 會忽略此參數,因為它不受 支援 Update-PSScriptFileInfo

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

輸入

String

輸出

Object

備註

Test-ScriptFileInfo使用 Cmdlet 來驗證腳本的中繼資料。 腳本必須包含 VersionGUIDDescriptionAuthor的值。