Sdílet prostřednictvím

New-PSScriptFileInfo

  • Reference
Modul:
Microsoft.PowerShell.PSResourceGet

Rutina vytvoří nový soubor skriptu, včetně metadat o skriptu.

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

Rutina vytvoří nový soubor skriptu obsahující požadovaná metadata potřebná k publikování balíčku skriptu.

Příklady

Příklad 1: Vytvoření prázdného skriptu s minimálními informacemi

Tento příklad spustí rutinu pouze s použitím požadovaných parametrů. Parametr Path určuje nane a umístění skriptu. Parametr Description poskytuje popis použitý v nápovědě založené na komentářích pro skript.

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.

#>

Příklad 2: Vytvoření skriptu s požadovanými moduly

Tento příklad spustí rutinu s dalšími parametry, včetně RequiredModules. RequiredModules je pole specifikací modulu.

$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.

#>

Parametry

-Author

Jméno autora skriptu.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CompanyName

Název společnosti, která skript vlastní.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Copyright

Informace o autorských právech pro skript.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Popis skriptu.

Type:String
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-ExternalModuleDependencies

Seznam závislostí externích modulů pořízených tímto skriptem

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ExternalScriptDependencies

Seznam závislostí externích skriptů pořízených tímto skriptem.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Force

Vynutí, aby rutina přepsala jakýkoli existující soubor.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Guid

Jedinečný identifikátor skriptu ve formátu GUID. Pokud identifikátor GUID nezadáte, rutina automaticky vytvoří nový.

Type:Guid
Position:Named
Default value:Randomly generated
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-IconUri

Identifikátor URI (Uniform Resource Identifier) odkazující na ikonu přidruženou ke skriptu.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LicenseUri

Identifikátor URI odkazující na soubor licenční smlouvy přidružený ke skriptu.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Path

Název souboru a umístění, kde je skript vytvořen.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PrivateData

Soukromá data přidružená ke skriptu.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ProjectUri

Identifikátor URI odkazující na web projektu přidružený ke skriptu.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ReleaseNotes

Poznámky k verzi skriptu

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RequiredModules

Parametr přebírá pole hodnot hashtables specifikace modulu. Specifikace modulu je zatřiďovací tabulka, která má následující klíče.

  • ModuleName - Požadované Určuje název modulu.
  • GUID - Volitelné Určuje identifikátor GUID modulu.
  • Je také nutné zadat alespoň jeden ze tří níže uvedených klíčů.
    • ModuleVersion – Určuje minimální přijatelnou verzi modulu.
    • MaximumVersion – Určuje maximální přijatelnou verzi modulu.
    • RequiredVersion – Určuje přesnou a požadovanou verzi modulu. Tuto možnost nelze použít s jinými klíči verze.
Type:Hashtable[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RequiredScripts

Seznam skriptů vyžadovaných skriptem

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Tags

Značky přidružené ke skriptu. Hodnoty značek jsou řetězce, které by neměly obsahovat mezery. Další informace najdete v tématu Podrobnosti o značkách.

Type:String[]
Aliases:Tag
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Version

Verze skriptu. Pokud není zadaná žádná hodnota , verze bude ve výchozím nastavení nastavena na 1.0.0.0.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Vstupy

None

Výstupy

Object

Poznámky

Rutiny New-PSScriptFileInfo a Update-PSScriptFileInfo umístí #requires příkazy pro požadované moduly mezi <#PSScriptInfo bloky nápovědy a bloky nápovědy založené na komentářích v souboru nápovědy. Očekává Get-PSScriptFileInfo , že příkazy budou umístěny někde před blokem nápovědy #requires založeným na komentářích. Všechny #requires příkazy umístěné za blokem nápovědy založeném na komentářích jsou ignorovány a Get-PSScriptFileInfoPublish-PSResource.