Share via

New-PSScriptFileInfo

  • Referentie
Module:
Microsoft.PowerShell.PSResourceGet

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

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

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 path parameter geeft de nane en de locatie van het script. De parameter Description bevat de beschrijving die wordt gebruikt in de op opmerkingen gebaseerde Help 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 met de vereiste modules maken

In dit voorbeeld wordt de cmdlet uitgevoerd met aanvullende parameters, waaronder RequiredModules. RequiredModules is een matrix met 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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-CompanyName

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

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

-Copyright

De copyrightinformatie voor het script.

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

-Description

De beschrijving van het script.

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

-ExternalModuleDependencies

De lijst met afhankelijkheden van externe modules die door dit script worden gemaakt.

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

-ExternalScriptDependencies

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

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

-Force

Hiermee dwingt u de cmdlet om een bestaand bestand te overschrijven.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters: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
Required:False
Accept pipeline input:False
Accept wildcard characters: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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LicenseUri

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

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

-Path

De bestandsnaam en locatie waar het script is gemaakt.

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

-PrivateData

De persoonlijke gegevens die zijn gekoppeld aan het script.

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

-ProjectUri

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

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

-ReleaseNotes

De releaseopmerkingen voor het script.

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

-RequiredModules

De parameter gebruikt een matrix met hashtabellen voor modulespecificatie. Een modulespecificatie is een hashtabel met de volgende sleutels.

  • ModuleName - Vereist Hiermee geeft u de naam van de module.
  • GUID - Optionele Hiermee geeft u de GUID van de module.
  • Het is ook Vereist om ten minste een van de drie onderstaande sleutels op te geven.
    • ModuleVersion - Hiermee geeft u een minimaal aanvaardbare versie van de module op.
    • MaximumVersion - Hiermee geeft u de maximaal aanvaardbare versie van de module op.
    • 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
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RequiredScripts

De lijst met scripts die vereist zijn voor het script.

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

-Tags

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

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

-Version

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

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

Invoerwaarden

None

Uitvoerwaarden

Object

Notities

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