New-PSScriptFileInfo

Modul:: Microsoft.PowerShell.PSResourceGet Module

Das Cmdlet erstellt eine neue Skriptdatei, einschließlich Metadaten zum Skript.

Syntax

Default (Standardwert)

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>]

Beschreibung

Das Cmdlet erstellt eine neue Skriptdatei mit den erforderlichen Metadaten, die zum Veröffentlichen eines Skriptpakets erforderlich sind.

Beispiele

Beispiel 1: Erstellen eines leeren Skripts mit minimalen Informationen

In diesem Beispiel wird das Cmdlet nur mit erforderlichen Parametern ausgeführt. Der parameter Path gibt den Nane und die Position des Skripts an. Der parameter Description liefert die Beschreibung, die in der kommentarbasierten Hilfe für das Skript verwendet wird.

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.

#>

Beispiel 2: Erstellen eines Skripts mit erforderlichen Modulen

In diesem Beispiel wird das Cmdlet mit zusätzlichen Parametern ausgeführt, einschließlich RequiredModules. RequiredModules ist ein Array von Modulspezifikationen.

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

#>

Parameter

-Author

Der Name des Autors des Skripts.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-CompanyName

Der Name des Unternehmens, das das Skript besitzt.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Copyright

Die Copyrightinformationen für das Skript.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Description

Die Beschreibung des Skripts.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	True
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-ExternalModuleDependencies

Die Liste der externen Modulabhängigkeiten, die von diesem Skript übernommen wurden.

Parametereigenschaften

Typ:	String[]
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-ExternalScriptDependencies

Die Liste der externen Skriptabhängigkeiten, die von diesem Skript übernommen wurden.

Parametereigenschaften

Typ:	String[]
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Force

Erzwingt das Cmdlet, eine vorhandene Datei zu überschreiben.

Parametereigenschaften

Typ:	SwitchParameter
Standardwert:	False
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Guid

Der eindeutige Bezeichner für das Skript im GUID-Format. Wenn Sie keine GUID bereitstellen, erstellt das Cmdlet automatisch ein neues.

Parametereigenschaften

Typ:	Guid
Standardwert:	Randomly generated
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-IconUri

Ein URI (Uniform Resource Identifier), der auf das dem Skript zugeordnete Symbol zeigt.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-LicenseUri

Der URI, der auf die Lizenzvertragsdatei verweist, die dem Skript zugeordnet ist.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Path

Der Dateiname und der Speicherort, an dem das Skript erstellt wird.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	0
Obligatorisch.:	True
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-PrivateData

Die privaten Daten, die dem Skript zugeordnet sind.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-ProjectUri

Der URI, der auf die Projektwebsite zeigt, die dem Skript zugeordnet ist.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-ReleaseNotes

Die Versionshinweise für das Skript.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-RequiredModules

Der Parameter verwendet ein Array von Modulspezifikationshashtables. Eine Modulspezifikation ist eine Hashtabelle mit den folgenden Schlüsseln.

ModuleName - Erforderlicher Gibt den Modulnamen an.
GUID - Optionaler Gibt die GUID des Moduls an.
Außerdem Erforderlicher, um mindestens einen der drei folgenden Tasten anzugeben.
- ModuleVersion – Gibt eine akzeptable Mindestversion des Moduls an.
- MaximumVersion – Gibt die maximal zulässige Version des Moduls an.
- RequiredVersion – Gibt eine genaue, erforderliche Version des Moduls an. Dies kann nicht mit den anderen Versionsschlüsseln verwendet werden.

Parametereigenschaften

Typ:	Hashtable[]
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-RequiredScripts

Die Liste der Skripts, die für das Skript erforderlich sind.

Parametereigenschaften

Typ:	String[]
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Tags

Die tags, die dem Skript zugeordnet sind. Tagwerte sind Zeichenfolgen, die keine Leerzeichen enthalten sollen. Weitere Informationen finden Sie unter Tagdetails.

Parametereigenschaften

Typ:	String[]
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False
Aliase:	Tag

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

-Version

Die Version des Skripts. Wenn kein Wert angegeben wird, wird Version standardmäßig auf 1.0.0.0festgelegt.

Parametereigenschaften

Typ:	String
Standardwert:	None
Unterstützt Platzhalter:	False
Nicht anzeigen:	False

Parametersätze

(All)

Position:	Named
Obligatorisch.:	False
Wert aus Pipeline:	False
Wert aus Pipeline nach dem Eigenschaftsnamen:	False
Wert aus verbleibenden Argumenten:	False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

None

Ausgaben

Object

Hinweise

Die Cmdlets New-PSScriptFileInfo und Update-PSScriptFileInfo platzieren die #requires Anweisungen für erforderliche Module zwischen den <#PSScriptInfo und kommentarbasierten Hilfeblöcken der Hilfedatei. Die Get-PSScriptFileInfo erwartet, dass #requires Anweisungen irgendwo vor dem kommentarbasierten Hilfeblock platziert werden. Alle #requires Anweisungen, die nach dem kommentarbasierten Hilfeblock platziert wurden, werden von Get-PSScriptFileInfo und Publish-PSResourceignoriert.

Freigeben über

New-PSScriptFileInfo

Syntax

Default (Standardwert)

Beschreibung

Beispiele

Beispiel 1: Erstellen eines leeren Skripts mit minimalen Informationen

Beispiel 2: Erstellen eines Skripts mit erforderlichen Modulen

Parameter

-Author

Parametereigenschaften

Parametersätze

-CompanyName

Parametereigenschaften

Parametersätze

-Copyright

Parametereigenschaften

Parametersätze

-Description

Parametereigenschaften

Parametersätze

-ExternalModuleDependencies

Parametereigenschaften

Parametersätze

-ExternalScriptDependencies

Parametereigenschaften

Parametersätze

-Force

Parametereigenschaften

Parametersätze

-Guid

Parametereigenschaften

Parametersätze

-IconUri

Parametereigenschaften

Parametersätze

-LicenseUri

Parametereigenschaften

Parametersätze

-Path

Parametereigenschaften

Parametersätze

-PrivateData

Parametereigenschaften

Parametersätze

-ProjectUri

Parametereigenschaften

Parametersätze

-ReleaseNotes

Parametereigenschaften

Parametersätze

-RequiredModules

Parametereigenschaften

Parametersätze

-RequiredScripts

Parametereigenschaften

Parametersätze

-Tags

Parametereigenschaften

Parametersätze

-Version

Parametereigenschaften

Parametersätze

CommonParameters

Eingaben

None

Ausgaben

Object

Hinweise

Ähnliche Themen

Feedback