Dela via

Update-PSScriptFileInfo

Modul:
Microsoft.PowerShell.PSResourceGet Module

Den här cmdleten uppdaterar kommentarsbaserade metadata i ett befintligt skript .ps1 fil.

Syntax

Default (Standard) 

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 ett befintligt skript .ps1 fil. 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 versiontill 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å författaren till skriptet.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-CompanyName

Namnet på det företag som äger skriptet.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Copyright

Copyrightinformationen för skriptet.

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False
(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Description

Beskrivningen av skriptet.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ExternalModuleDependencies

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

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ExternalScriptDependencies

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

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Guid

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

Parameteregenskaper

Typ:Guid
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-IconUri

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

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-LicenseUri

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

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Path

Skriptets filnamn och plats.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:0
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-PrivateData

De privata data som är associerade med skriptet.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ProjectUri

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

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-ReleaseNotes

Viktig information för skriptet.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-RemoveSignature

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

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-RequiredModules

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

  • ModuleName - Obligatoriskt Anger modulnamnet.
  • GUID - Valfri Anger GUID för modulen.
  • Det är också Krävs för att ange minst en av de tre nycklarna nedan.
    • ModuleVersion – Anger en lägsta godtagbar version av modulen.
    • MaximumVersion – Anger den maximala godkända versionen av modulen.
    • RequiredVersion – Anger en exakt, nödvändig version av modulen. Detta kan inte användas med de andra versionsnycklarna.

Parameteregenskaper

Typ:

Hashtable[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-RequiredScripts

Listan över skript som krävs av skriptet.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Tags

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

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:Tag

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Version

Versionen av skriptet.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

None

Utdata

Object

Kommentarer

Cmdletarna New-PSScriptFileInfo och Update-PSScriptFileInfo placerar #requires-instruktionerna för nödvändiga moduler mellan de <#PSScriptInfo- och kommentarsbaserade hjälpblocken i hjälpfilen. Get-PSScriptFileInfo förväntar sig att #requires-instruktioner placeras någonstans före det kommentarsbaserade hjälpblocket. Alla #requires-instruktioner som placeras efter det kommentarsbaserade hjälpblocket ignoreras av Get-PSScriptFileInfo och Publish-PSResource.