Dela via

New-PSScriptFileInfo

  • Referens
Modul:
Microsoft.PowerShell.PSResourceGet

Cmdleten skapar en ny skriptfil, inklusive metadata om skriptet.

Syntax

New-PSScriptFileInfo
   [-Path] <String>
   [-Version <String>]
   [-Author <String>]
   -Description <String>
   [-Guid <Guid>]
   [-CompanyName <String>]
   [-Copyright <String>]
   [-RequiredModules <Hashtable[]>]
   [-ExternalModuleDependencies <String[]>]
   [-RequiredScripts <String[]>]
   [-ExternalScriptDependencies <String[]>]
   [-Tags <String[]>]
   [-ProjectUri <String>]
   [-LicenseUri <String>]
   [-IconUri <String>]
   [-ReleaseNotes <String>]
   [-PrivateData <String>]
   [-Force]
   [<CommonParameters>]

Description

Cmdleten skapar en ny skriptfil som innehåller nödvändiga metadata som krävs för att publicera ett skriptpaket.

Exempel

Exempel 1: Skapa ett tomt skript med minimal information

Det här exemplet kör cmdleten med endast obligatoriska parametrar. Parametern Path anger parametern nane och platsen för skriptet. Parametern Description anger den beskrivning som används i den kommentarsbaserade hjälpen för skriptet.

New-PSScriptFileInfo -Path ./test_script.ps1 -Description 'This is a test script.'
Get-Content ./test_script.ps1

<#PSScriptInfo

.VERSION 1.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.

#>

Exempel 2: Skapa ett skript med nödvändiga moduler

Det här exemplet kör cmdleten med ytterligare parametrar, inklusive RequiredModules. RequiredModules är en matris med modulspecifikationer.

$parameters = @{
    Path = './test_script2.ps1'
    Description = 'This is a test script.'
    Version = '2.0.0.0'
    Author = 'janedoe'
    RequiredModules =  @(
        @{ModuleName = 'PackageManagement'; ModuleVersion = '1.0.0.0' },
        @{ModuleName = 'PSReadLine'}
    )
}
New-PSScriptFileInfo @parameters
Get-Content ./test_script2.ps1

<#PSScriptInfo

.VERSION 2.0.0.0

.GUID 7ec4832e-a4e1-562b-8a8c-241e535ad7d7

.AUTHOR janedoe

.COMPANYNAME

.COPYRIGHT

.TAGS

.LICENSEURI

.PROJECTURI

.ICONURI

.EXTERNALMODULEDEPENDENCIES

.REQUIREDSCRIPTS

.EXTERNALSCRIPTDEPENDENCIES

.RELEASENOTES

.PRIVATEDATA

#>

#Requires -Module PSReadLine
#Requires -Module @{ ModuleName = 'PackageManagement'; ModuleVersion = '1.0.0.0' }

<#

.DESCRIPTION
This is a test script.

#>

Parametrar

-Author

Namnet på författaren till skriptet.

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

-CompanyName

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

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

-Copyright

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:True
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

-Force

Tvingar cmdleten att skriva över alla befintliga filer.

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

-Guid

Den unika identifieraren för skriptet i GUID-format. Om du inte anger ett GUID skapar cmdleten en ny automatiskt.

Typ:Guid
Position:Named
Standardvärde:Randomly generated
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

Filnamnet och platsen där skriptet skapas.

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

-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.
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 Tag-information.

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

-Version

Versionen av skriptet. Om inget värde anges version standardvärdet 1.0.0.0.

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

Indata

None

Utdata

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.