Update-PSScriptFileInfo

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

Cette applet de commande met à jour les métadonnées basées sur les commentaires dans un fichier de script .ps1 existant.

Syntaxe

Update-PSScriptFileInfo
      [-Author <String>]
      [-CompanyName <String>]
      [-Copyright <String>]
      [-Description <String>]
      [-ExternalModuleDependencies <String[]>]
      [-ExternalScriptDependencies <String[]>]
      [-Guid <Guid>]
      [-IconUri <String>]
      [-LicenseUri <String>]
      [-Path] <String>
      [-PrivateData <String>]
      [-ProjectUri <String>]
      [-ReleaseNotes <String>]
      [-RemoveSignature]
      [-RequiredModules <Hashtable[]>]
      [-RequiredScripts <String[]>]
      [-Tags <String[]>]
      [-Version <String>]
      [<CommonParameters>]

Description

Cette applet de commande met à jour les métadonnées basées sur les commentaires dans un fichier de script .ps1 existant. Cette valeur est similaire à Update-ModuleManifest.

Exemples

Exemple 1 : Mettre à jour la version d’un script

Dans cet exemple, un script est créé avec Version définie sur 1.0.0.0. Update-PSScriptFileInfo remplace la version' par 2.0.0.0. L’applet Get-Content de commande affiche le contenu mis à jour du script.

$parameters = @{
    FilePath = "C:\Users\johndoe\MyScripts\test_script.ps1"
    Version = "1.0.0.0"
    Description = "this is a test script"
}
New-PSScriptFileInfo @parameters
$parameters.Version = "2.0.0.0"
Update-PSScriptFileInfo @parameters
Get-Content $parameters.FilePath

<#PSScriptInfo

.VERSION 2.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

#>

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:False
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

-Guid

Identificateur unique du script au format GUID.

Type:Guid
Position:Named
Valeur par défaut:None
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 du script.

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

-RemoveSignature

Supprime la signature d’un fichier signé .ps1 , ce qui vous permet de mettre à jour le script. Vous devez signer à nouveau le après la mise à jour du fichier.

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

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

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