Partager via

Update-PSScriptFileInfo

Module:
Microsoft.PowerShell.PSResourceGet Module

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

Syntaxe

Default (Par défaut) 

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 des commentaires dans un fichier de .ps1 de script existant. Ceci 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 modifie la version 2.0.0.0. L’applet de commande Get-Content 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.

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-CompanyName

Nom de l’entreprise propriétaire du script.

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Copyright

Informations sur le droit d’auteur pour le script.

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Description

Description du script.

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ExternalModuleDependencies

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

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ExternalScriptDependencies

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

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Guid

Identificateur unique du script au format GUID.

Propriétés des paramètres

Type:Guid
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-IconUri

URI (Uniform Resource Identifier) pointant vers l’icône associée au script.

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-LicenseUri

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

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Path

Nom de fichier et emplacement du script.

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:0
Obligatoire:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-PrivateData

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

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ProjectUri

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

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-ReleaseNotes

Notes de publication du script.

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-RemoveSignature

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

Propriétés des paramètres

Type:SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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 a les clés suivantes.

  • ModuleName - Obligatoire Spécifie le nom du module.
  • GUID - facultatif spécifie le GUID du module.
  • Il est également obligatoire pour 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.

Propriétés des paramètres

Type:

Hashtable[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-RequiredScripts

Liste des scripts requis par le script.

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants: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 de balise.

Propriétés des paramètres

Type:

String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Tag

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Version

Version du script.

Propriétés des paramètres

Type:String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

None

Sorties

Object

Notes

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