New-PSScriptFileInfo

  • Référence
Module:
Microsoft.PowerShell.PSResourceGet

L’applet de commande crée un fichier de script, y compris les métadonnées relatives au script.

Syntaxe

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

L’applet de commande crée un fichier de script contenant les métadonnées requises pour publier un package de script.

Exemples

Exemple 1 : Création d’un script vide avec un minimum d’informations

Cet exemple exécute l’applet de commande en utilisant uniquement les paramètres requis. Le paramètre Path spécifie le nane et l’emplacement du script. Le paramètre Description fournit la description utilisée dans l’aide basée sur les commentaires pour le 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.

#>

Exemple 2 : Création d’un script avec les modules requis

Cet exemple exécute l’applet de commande avec des paramètres supplémentaires, notamment RequiredModules. RequiredModules est un tableau de spécifications de module.

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

#>

Paramètres

-Author

Nom de l’auteur du script.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-CompanyName

Nom de la société propriétaire du script.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Copyright

Informations de copyright pour le script.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Description

Description du script.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ExternalModuleDependencies

Liste des dépendances de module externe prises par ce script.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ExternalScriptDependencies

Liste des dépendances de script externe prises par ce script.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Force

Force l’applet de commande à remplacer tout fichier existant.

Type:SwitchParameter
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Guid

Identificateur unique du script au format GUID. Si vous ne fournissez pas de GUID, l’applet de commande en crée un automatiquement.

Type:Guid
Position:Named
Valeur par défaut:Randomly generated
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-IconUri

URI pointant vers l’icône associée au script.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-LicenseUri

URI pointant vers le fichier de contrat de licence associé au script.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Path

Nom de fichier et emplacement où le script est créé.

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-PrivateData

Données privées associées au script.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ProjectUri

URI pointant vers le site de projet associé au script.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ReleaseNotes

Notes de publication du script.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RequiredModules

Le paramètre prend un tableau de tables de hachage de spécification de module. Une spécification de module est une table de hachage qui contient les clés suivantes.

  • ModuleName - Obligatoire Spécifie le nom du module.
  • GUID - Optionnel Spécifie le GUID du module.
  • Il est également obligatoire de spécifier au moins l’une des trois clés ci-dessous.
    • ModuleVersion - Spécifie une version minimale acceptable du module.
    • MaximumVersion - Spécifie la version maximale acceptable du module.
    • RequiredVersion - Spécifie une version exacte et requise du module. Cela ne peut pas être utilisé avec les autres clés de version.
Type:Hashtable[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-RequiredScripts

Liste des scripts requis par le script.

Type:String[]
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Tags

Balises associées au script. Les valeurs de balise sont des chaînes qui ne doivent pas contenir d’espaces. Pour plus d’informations, consultez Détails des balises.

Type:String[]
Alias:Tag
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Version

Version du script. Si aucune valeur n’est fournie , la version est définie par défaut sur 1.0.0.0.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

None

Sorties

Object

Notes

Les New-PSScriptFileInfo applets de commande et Update-PSScriptFileInfo placent les #requires instructions pour les modules requis entre les blocs d’aide basés sur les <#PSScriptInfo commentaires et du fichier d’aide. Le Get-PSScriptFileInfo s’attend à ce que les instructions soient placées #requires quelque part avant le bloc d’aide basé sur les commentaires. Toutes #requires les instructions placées après le bloc d’aide basé sur les commentaires sont ignorées par Get-PSScriptFileInfo et Publish-PSResource.