Condividi tramite

New-PSScriptFileInfo

  • Riferimento
Modulo:
Microsoft.PowerShell.PSResourceGet

Il cmdlet crea un nuovo file di script, inclusi i metadati relativi allo script.

Sintassi

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

Descrizione

Il cmdlet crea un nuovo file di script contenente i metadati necessari per pubblicare un pacchetto script.

Esempio

Esempio 1: Creazione di uno script vuoto con informazioni minime

Questo esempio esegue il cmdlet usando solo i parametri obbligatori. Il parametro Path specifica la nane e la posizione dello script. Il parametro Description fornisce la descrizione usata nella Guida basata su commenti per lo 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.

#>

Esempio 2: Creazione di uno script con i moduli necessari

In questo esempio viene eseguito il cmdlet con parametri aggiuntivi, inclusi RequiredModules. RequiredModules è una matrice di specifiche del modulo.

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

#>

Parametri

-Author

Nome dell'autore dello script.

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

-CompanyName

Nome della società proprietaria dello script.

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

-Copyright

Informazioni sul copyright per lo script.

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

-Description

Descrizione dello script.

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

-ExternalModuleDependencies

Elenco delle dipendenze del modulo esterno eseguite da questo script.

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

-ExternalScriptDependencies

Elenco delle dipendenze di script esterni eseguite da questo script.

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

-Force

Forza il cmdlet a sovrascrivere qualsiasi file esistente.

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

-Guid

Identificatore univoco dello script in formato GUID. Se non si specifica un GUID, il cmdlet ne crea automaticamente uno nuovo.

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

-IconUri

URI (Uniform Resource Identifier) che punta all'icona associata allo script.

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

-LicenseUri

URI che punta al file del contratto di licenza associato allo script.

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

-Path

Nome file e percorso in cui viene creato lo script.

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

-PrivateData

Dati privati associati allo script.

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

-ProjectUri

URI che punta al sito di progetto associato allo script.

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

-ReleaseNotes

Note sulla versione per lo script.

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

-RequiredModules

Il parametro accetta una matrice di tabelle hash della specifica del modulo. Una specifica del modulo è una tabella hash con le chiavi seguenti.

  • ModuleName - Obbligatorio Specifica il nome del modulo.
  • GUID - Opzionale Specifica il GUID del modulo.
  • È anche necessario specificare almeno una delle tre chiavi seguenti.
    • ModuleVersion - Specifica una versione minima accettabile del modulo.
    • MaximumVersion - Specifica la versione massima accettabile del modulo.
    • RequiredVersion - Specifica una versione esatta e obbligatoria del modulo. Non è possibile usare questa opzione con le altre chiavi version.
Type:Hashtable[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RequiredScripts

Elenco di script richiesti dallo script.

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

-Tags

Tag associati allo script. I valori dei tag sono stringhe che non devono contenere spazi. Per altre informazioni, vedere Dettagli dei tag.

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

-Version

Versione dello script. Se non viene specificato alcun valore, l'impostazione predefinita Version è 1.0.0.0.

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

Input

None

Output

Object

Note

I New-PSScriptFileInfo cmdlet e Update-PSScriptFileInfo inserisce le #requires istruzioni per i moduli necessari tra i blocchi della <#PSScriptInfo Guida basata su commenti e del file della Guida. L'oggetto Get-PSScriptFileInfo prevede #requires che le istruzioni vengano inserite in un punto qualsiasi prima del blocco della Guida basato su commenti. Tutte #requires le istruzioni inserite dopo il blocco della Guida basata su commenti vengono ignorate da Get-PSScriptFileInfo e Publish-PSResource.