Freigeben über

Update-PSScriptFileInfo

  • Referenz
Modul:
Microsoft.PowerShell.PSResourceGet

Dieses Cmdlet aktualisiert die kommentarbasierten Metadaten in einer vorhandenen Skriptdatei .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>]

Beschreibung

Dieses Cmdlet aktualisiert die kommentarbasierten Metadaten in einer vorhandenen Skriptdatei .ps1. Dies ähnelt Update-ModuleManifest.

Beispiele

Beispiel 1: Aktualisieren der Version eines Skripts

In diesem Beispiel wird ein Skript mit Version erstellt, auf 1.0.0.0festgelegt ist. Update-PSScriptFileInfo ändert die Versionin 2.0.0.0. Das Cmdlet Get-Content zeigt den aktualisierten Inhalt des Skripts an.

$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

#>

Parameter

-Author

Der Name des Autors des Skripts.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-CompanyName

Der Name des Unternehmens, das das Skript besitzt.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Copyright

Die Copyrightinformationen für das Skript.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Description

Die Beschreibung des Skripts.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ExternalModuleDependencies

Die Liste der externen Modulabhängigkeiten, die von diesem Skript übernommen wurden.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ExternalScriptDependencies

Die Liste der externen Skriptabhängigkeiten, die von diesem Skript übernommen wurden.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Guid

Der eindeutige Bezeichner für das Skript im GUID-Format.

Typ:Guid
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-IconUri

Ein URI (Uniform Resource Identifier), der auf das dem Skript zugeordnete Symbol zeigt.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-LicenseUri

Der URI, der auf die Lizenzvertragsdatei verweist, die dem Skript zugeordnet ist.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Path

Der Dateiname und der Speicherort des Skripts.

Typ:String
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-PrivateData

Die privaten Daten, die dem Skript zugeordnet sind.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ProjectUri

Der URI, der auf die Projektwebsite zeigt, die dem Skript zugeordnet ist.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-ReleaseNotes

Die Versionshinweise für das Skript.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-RemoveSignature

Entfernt die Signatur aus einer signierten .ps1 Datei, sodass Sie das Skript aktualisieren können. Sie sollten die Datei nach dem Aktualisieren erneut signieren.

Typ:SwitchParameter
Position:Named
Standardwert:False
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-RequiredModules

Der Parameter verwendet ein Array von Modulspezifikationshashtables. Eine Modulspezifikation ist eine Hashtabelle mit den folgenden Schlüsseln.

  • ModuleName - Erforderlicher Gibt den Modulnamen an.
  • GUID - Optionaler Gibt die GUID des Moduls an.
  • Außerdem Erforderlicher, um mindestens einen der drei folgenden Tasten anzugeben.
    • ModuleVersion – Gibt eine akzeptable Mindestversion des Moduls an.
    • MaximumVersion – Gibt die maximal zulässige Version des Moduls an.
    • RequiredVersion – Gibt eine genaue, erforderliche Version des Moduls an. Dies kann nicht mit den anderen Versionsschlüsseln verwendet werden.
Typ:Hashtable[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-RequiredScripts

Die Liste der Skripts, die für das Skript erforderlich sind.

Typ:String[]
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Tags

Die tags, die dem Skript zugeordnet sind. Tagwerte sind Zeichenfolgen, die keine Leerzeichen enthalten sollen. Weitere Informationen finden Sie unter Tagdetails.

Typ:String[]
Aliase:Tag
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Version

Die Version des Skripts.

Typ:String
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

Eingaben

None

Ausgaben

Hinweise

Die Cmdlets New-PSScriptFileInfo und Update-PSScriptFileInfo platzieren die #requires Anweisungen für erforderliche Module zwischen den <#PSScriptInfo und kommentarbasierten Hilfeblöcken der Hilfedatei. Die Get-PSScriptFileInfo erwartet, dass #requires Anweisungen irgendwo vor dem kommentarbasierten Hilfeblock platziert werden. Alle #requires Anweisungen, die nach dem kommentarbasierten Hilfeblock platziert wurden, werden von Get-PSScriptFileInfo und Publish-PSResourceignoriert.