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 de metadata som krävs för att publicera ett skriptpaket.

Exempel

Exempel 1: Skapa ett tomt skript med minimal information

I det här exemplet körs cmdleten med endast obligatoriska parametrar. Parametern Path anger nane och platsen för skriptet. Parametern Beskrivning anger beskrivningen 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å skriptförfattaren.

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 hash-tabell 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 får 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

Skriptets version. Om inget värde anges är Versionen 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

Object

Kommentarer

New-PSScriptFileInfo Cmdletarna och Update-PSScriptFileInfo placerar #requires instruktionerna för nödvändiga moduler mellan de <#PSScriptInfo och kommentarsbaserade hjälpblocken i hjälpfilen. Förväntar Get-PSScriptFileInfo sig #requires att 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.