Delen via

New-PSScriptFileInfo

  • Referentie
Module:
Microsoft.PowerShell.PSResourceGet

De cmdlet maakt een nieuw scriptbestand, inclusief metagegevens over het script.

Syntaxis

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

De cmdlet maakt een nieuw scriptbestand met de vereiste metagegevens die nodig zijn om een scriptpakket te publiceren.

Voorbeelden

Voorbeeld 1: Een leeg script maken met minimale informatie

In dit voorbeeld wordt de cmdlet uitgevoerd met alleen vereiste parameters. De parameter Path specificeert de nane en de locatie van het script. De parameter Description geeft de beschrijving op die wordt gebruikt in de hulp op basis van opmerkingen voor het script.

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.

#>

Voorbeeld 2: Een script maken met vereiste modules

In dit voorbeeld wordt de cmdlet uitgevoerd met extra parameters, waaronder RequiredModules. RequiredModules is een matrix van modulespecificaties.

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

#>

Parameters

-Author

De naam van de auteur van het script.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-CompanyName

De naam van het bedrijf dat eigenaar is van het script.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Copyright

De copyrightinformatie voor het script.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Description

De beschrijving van het script.

Type:String
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-ExternalModuleDependencies

De lijst met externe moduleafhankelijkheden die door dit script worden genomen.

Type:String[]
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-ExternalScriptDependencies

De lijst met externe scriptafhankelijkheden die door dit script worden genomen.

Type:String[]
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Force

Hiermee dwingt u af dat de cmdlet een bestaand bestand overschrijft.

Type:SwitchParameter
Position:Named
Default value:False
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Guid

De unieke id voor het script in GUID-indeling. Als u geen GUID opgeeft, maakt de cmdlet automatisch een nieuwe.

Type:Guid
Position:Named
Default value:Randomly generated
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-IconUri

Een URI (Uniform Resource Identifier) die verwijst naar het pictogram dat aan het script is gekoppeld.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-LicenseUri

De URI die verwijst naar het licentieovereenkomstbestand dat is gekoppeld aan het script.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Path

De bestandsnaam en locatie waar het script is gemaakt.

Type:String
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-PrivateData

De persoonlijke gegevens die aan het script zijn gekoppeld.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-ProjectUri

De URI die verwijst naar de projectsite die is gekoppeld aan het script.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-ReleaseNotes

De releaseopmerkingen voor het script.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-RequiredModules

De parameter neemt een matrix van modulespecificatie-hashtabellen. Een modulespecificatie is een hashtabel met de volgende sleutels.

  • ModuleName - Vereist Geeft de modulenaam op.
  • GUID - Optionele Geeft de GUID van de module aan.
  • Het is ook Vereist om ten minste een van de drie onderstaande sleutels op te geven.
    • ModuleVersion - Hiermee geeft u een minimaal acceptabele versie van de module op.
    • MaximumVersion - Hiermee geeft u de maximaal acceptabele versie van de module.
    • RequiredVersion - Hiermee geeft u een exacte, vereiste versie van de module op. Dit kan niet worden gebruikt met de andere versiesleutels.
Type:Hashtable[]
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-RequiredScripts

De lijst met scripts die vereist zijn voor het script.

Type:String[]
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Tags

De tags die aan het script zijn gekoppeld. Tagwaarden zijn tekenreeksen die geen spaties mogen bevatten. Zie Tagdetailsvoor meer informatie.

Type:String[]
Aliassen:Tag
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

-Version

De versie van het script. Als er geen waarde wordt opgegeven versie standaard ingesteld op 1.0.0.0.

Type:String
Position:Named
Default value:None
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

None

Uitvoerwaarden

Notities

De cmdlets New-PSScriptFileInfo en Update-PSScriptFileInfo plaatsen de #requires instructies voor vereiste modules tussen de helpblokken <#PSScriptInfo en op opmerkingen gebaseerde helpblokken van het Help-bestand. De Get-PSScriptFileInfo verwacht dat #requires instructies ergens vóór het helpblok op basis van opmerkingen worden geplaatst. Alle #requires instructies die na het hulpblok op basis van opmerkingen worden geplaatst, worden genegeerd door Get-PSScriptFileInfo en Publish-PSResource.