New-PSScriptFileInfo

Modul:

Microsoft.PowerShell.PSResourceGet Module

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

Syntax

Default (Výchozí)

New-PSScriptFileInfo
    [-Path] <string>
    -Description <string>
    [-Version <string>]
    [-Author <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 požadovanými parametry. Parametr Path určuje název a umístění skriptu. Parametr Popis zadejte popis použitý v nápovědě k komentáři 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í modulů.

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

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-CompanyName

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

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Copyright

Informace o autorských právech pro skript

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Description

Popis skriptu.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	True
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ExternalModuleDependencies

Seznam závislostí externích modulů přijatých tímto skriptem

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ExternalScriptDependencies

Seznam závislostí externích skriptů přijatých tímto skriptem

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Force

Vynutí rutinu, aby přepsala všechny existující soubory.

Vlastnosti parametru

Typ:	SwitchParameter
Default value:	False
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Guid

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

Vlastnosti parametru

Typ:	Guid
Default value:	Randomly generated
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-IconUri

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

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-LicenseUri

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

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Path

Název souboru a umístění, kam se skript vytvoří.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	0
Povinné:	True
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-PrivateData

Privátní data přidružená ke skriptu.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ProjectUri

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

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-ReleaseNotes

Poznámky k verzi skriptu.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-RequiredModules

Parametr přebírá pole hashtable specifikace modulu. Specifikace modulu je hashovatelná tabulka s následujícími klíči.

• ModuleName - Povinný Určuje název modulu.
• GUID - Volitelné Určuje identifikátor GUID modulu.
• Je také Povinné zadat aspoň jeden z následujících tří klíčů.
  • ModuleVersion – Určuje minimální přijatelnou verzi modulu.
  • MaximumVersion – Určuje maximální přijatelnou verzi modulu.
  • RequiredVersion – Určuje přesnou požadovanou verzi modulu. Tuto možnost nelze použít s jinými klíči verze.

Vlastnosti parametru

Typ:	Hashtable[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-RequiredScripts

Seznam skriptů požadovaných skriptem

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	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 značky.

Vlastnosti parametru

Typ:	String[]
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False
Aliasy:	Štítek

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

-Version

Verze skriptu. Pokud není k dispozici žádná hodnota verze výchozí hodnota 1.0.0.0.

Vlastnosti parametru

Typ:	String
Default value:	None
Podporuje zástupné znaky:	False
DontShow:	False

Sady parametrů

(All)

Position:	Named
Povinné:	False
Hodnota z kanálu:	False
Hodnota z kanálu podle názvu vlastnosti:	False
Hodnota ze zbývajících argumentů:	False

CommonParameters

Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.

Vstupy

None

Výstupy

Object

Poznámky

Rutiny New-PSScriptFileInfo a Update-PSScriptFileInfo umístí příkazy #requires pro požadované moduly mezi bloky nápovědy <#PSScriptInfo a bloky nápovědy založené na komentářích. Get-PSScriptFileInfo očekává, že se #requires příkazy umístí někam před blok nápovědy založený na komentáři. Všechny příkazy #requires umístěné po bloku nápovědy založené na komentářích se ignorují Get-PSScriptFileInfo a Publish-PSResource.

Související odkazy

• Get-PSScriptFileInfo
• Update-PSScriptFileInfo
• Test-PSScriptFileInfo
• Pokyny a osvědčené postupy pro publikování v PowerShellGallery
• Hodnoty manifestu balíčku, které mají vliv na uživatelské rozhraní galerie Prostředí PowerShell