Dela via


Update-PSScriptFileInfo

Den här cmdleten uppdaterar kommentarsbaserade metadata i en befintlig skriptfil .ps1 .

Syntax

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

Description

Den här cmdleten uppdaterar kommentarsbaserade metadata i en befintlig skriptfil .ps1 . Detta liknar Update-ModuleManifest.

Exempel

Exempel 1: Uppdatera versionen av ett skript

I det här exemplet skapas ett skript med version inställd på 1.0.0.0. Update-PSScriptFileInfo ändrar versionen till 2.0.0.0. Cmdleten Get-Content visar det uppdaterade innehållet i skriptet.

$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

#>

Parametrar

-Author

Namnet på skriptförfattaren.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-CompanyName

Namnet på företaget som äger skriptet.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Copyrightinformationen för skriptet.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Description

Beskrivningen av skriptet.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ExternalModuleDependencies

Listan över externa modulberoenden som tas av det här skriptet.

Typ:String[]
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ExternalScriptDependencies

Listan över externa skriptberoenden som tas av det här skriptet.

Typ:String[]
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Guid

Den unika identifieraren för skriptet i GUID-format.

Typ:Guid
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-IconUri

En URI (Uniform Resource Identifier) som pekar på ikonen som är associerad med skriptet.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-LicenseUri

URI:n som pekar på licensavtalsfilen som är associerad med skriptet.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Path

Skriptets filnamn och plats.

Typ:String
Position:0
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-PrivateData

De privata data som är associerade med skriptet.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ProjectUri

URI:n som pekar på den projektwebbplats som är associerad med skriptet.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-ReleaseNotes

Viktig information för skriptet.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-RemoveSignature

Tar bort signaturen från en signerad .ps1 fil så att du kan uppdatera skriptet. Du bör signera om när du har uppdaterat filen.

Typ:SwitchParameter
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-RequiredModules

Parametern tar en matris med hashtabeller för modulspecifikationer. En modulspecifikation är en hashtable som har följande nycklar.

  • ModuleName - Krävs Anger modulnamnet.
  • GUID - Valfri Anger GUID för modulen.
  • Det är också Obligatoriskt att ange minst en av de tre nycklarna nedan.
    • ModuleVersion – Anger en lägsta godtagbar version av modulen.
    • MaximumVersion – Anger den högsta godkända versionen av modulen.
    • RequiredVersion – Anger en exakt version av modulen som krävs. Detta kan inte användas med de andra versionsnycklarna.
Typ:Hashtable[]
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-RequiredScripts

Listan över skript som krävs av skriptet.

Typ:String[]
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Tags

Taggarna som är associerade med skriptet. Taggvärden är strängar som inte ska innehålla blanksteg. Mer information finns i Tagginformation.

Typ:String[]
Alias:Tag
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Version

Versionen av skriptet.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Indata

None

Utdata

Object