New-ScriptFileInfo

Référence

Module:: PowerShellGet

Crée un fichier de script avec des métadonnées.

Syntax

New-ScriptFileInfo
   [[-Path] <String>]
   [-Version <String>]
   [-Author <String>]
   -Description <String>
   [-Guid <Guid>]
   [-CompanyName <String>]
   [-Copyright <String>]
   [-RequiredModules <Object[]>]
   [-ExternalModuleDependencies <String[]>]
   [-RequiredScripts <String[]>]
   [-ExternalScriptDependencies <String[]>]
   [-Tags <String[]>]
   [-ProjectUri <Uri>]
   [-LicenseUri <Uri>]
   [-IconUri <Uri>]
   [-ReleaseNotes <String[]>]
   [-PrivateData <String>]
   [-PassThru]
   [-Force]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

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

Il s’agit d’une applet de commande proxy pour l’applet New-PSScriptFileInfode commande dans Microsoft.PowerShell.PSResourceGet. Pour plus d’informations, consultez New-PSScriptFileInfo.

Exemples

Exemple 1 : Créer un fichier de script et spécifier sa version, son auteur et sa description

Dans cet exemple, un fichier de script est créé et son contenu est affiché dans la console PowerShell.

$Parms = @{
  Path = "C:\Test\Temp-Scriptfile.ps1"
  Version = "1.0"
  Author = "pattif@contoso.com"
  Description = "My test script file description goes here"
  }
New-ScriptFileInfo @Parms
Get-Content -Path C:\Test\Temp-Scriptfile.ps1

<#PSScriptInfo

.VERSION 1.0

.GUID 3bb10ee7-38c1-41b9-88ea-16899164fc19

.AUTHOR pattif@contoso.com

.COMPANYNAME

.COPYRIGHT

.TAGS

.LICENSEURI

.PROJECTURI

.ICONURI

.EXTERNALMODULEDEPENDENCIES

.REQUIREDSCRIPTS

.EXTERNALSCRIPTDEPENDENCIES

.RELEASENOTES

.PRIVATEDATA

#>

<#

.DESCRIPTION
 My test script file description goes here

#>
Param()

L’applet New-ScriptFileInfo de commande utilise la platissement pour configurer plusieurs paramètres pour le script. Path définit l’emplacement et le nom du script. Version spécifie le numéro de version du script. Author est l’adresse e-mail de la personne qui a créé le script. La description explique l’objectif du script.

Une fois le script créé, Get-Content utilise le paramètre Path pour localiser le script. Le contenu du script s’affiche dans la console PowerShell.

Exemple 2 : Tester un fichier de script

Dans cet exemple, les métadonnées du script créé dans l’exemple 1 sont testées.

Test-ScriptFileInfo -Path C:\Test\Temp-Scriptfile.ps1

Version   Name                  Author               Description
-------   ----                  ------               -----------
1.0       Temp-Scriptfile       pattif@contoso.com   My test script file description goes here

L’applet Test-ScriptFileInfo de commande utilise le paramètre Path pour spécifier l’emplacement du fichier de script.

Exemple 3 : Créer un fichier de script avec toutes les propriétés de métadonnées

Cet exemple utilise la platissement pour créer un fichier de script nommé New-ScriptFile.ps1 qui inclut toutes ses propriétés de métadonnées. Le paramètre Verbose spécifie que la sortie détaillée s’affiche lors de la création du script.

$Parms = @{
 Path = "C:\Test\New-ScriptFile.ps1"
 Verbose = $True
 Version = "1.0"
 Author = "pattif@contoso.com"
 Description = "My new script file test"
 CompanyName = "Contoso Corporation"
 Copyright = "2019 Contoso Corporation. All rights reserved."
 ExternalModuleDependencies = "ff","bb"
 RequiredScripts = "Start-WFContosoServer", "Stop-ContosoServerScript"
 ExternalScriptDependencies = "Stop-ContosoServerScript"
 Tags = @("Tag1", "Tag2", "Tag3")
 ProjectUri = "https://contoso.com"
 LicenseUri = "https://contoso.com/License"
 IconUri = "https://contoso.com/Icon"
 PassThru = $True
 ReleaseNotes = @("Contoso script now supports the following features:",
   "Feature 1",
   "Feature 2",
   "Feature 3",
   "Feature 4",
   "Feature 5")
 RequiredModules =
   "1",
   "2",
   "RequiredModule1",
   @{ModuleName="RequiredModule2";ModuleVersion="1.0"},
   @{ModuleName="RequiredModule3";RequiredVersion="2.0"},
   "ExternalModule1"
 }
New-ScriptFileInfo @Parms

VERBOSE: Performing the operation "Creating the 'C:\Test\New-ScriptFile.ps1'
  PowerShell Script file" on target "C:\Test\New-ScriptFile.ps1".

<#PSScriptInfo

.VERSION 1.0

.GUID 4fabe8c7-7862-45b1-a72e-1352a433b77d

.AUTHOR pattif@contoso.com

.COMPANYNAME Contoso Corporation

.COPYRIGHT 2019 Contoso Corporation. All rights reserved.

.TAGS Tag1 Tag2 Tag3

.LICENSEURI https://contoso.com/License

.PROJECTURI https://contoso.com/

.ICONURI https://contoso.com/Icon

.EXTERNALMODULEDEPENDENCIES ff,bb

.REQUIREDSCRIPTS Start-WFContosoServer,Stop-ContosoServerScript

.EXTERNALSCRIPTDEPENDENCIES Stop-ContosoServerScript

.RELEASENOTES
Contoso script now supports the following features:
Feature 1
Feature 2
Feature 3
Feature 4
Feature 5

.PRIVATEDATA

#>

#Requires -Module 1
#Requires -Module 2
#Requires -Module RequiredModule1
#Requires -Module @{ModuleName = 'RequiredModule2'; ModuleVersion = '1.0'}
#Requires -Module @{RequiredVersion = '2.0'; ModuleName = 'RequiredModule3'}
#Requires -Module ExternalModule1

<#

.DESCRIPTION
 My new script file test

#>
Param()

Paramètres

-Author

Spécifie l’auteur du script.

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

-CompanyName

Spécifie l’entreprise ou le fournisseur qui a créé le script.

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

-Confirm

Vous invite à confirmer avant d’exécuter .New-ScriptFileInfo

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

-Copyright

Spécifie une instruction de copyright pour le script.

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

-Description

Spécifie une description pour le script.

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

-ExternalModuleDependencies

Spécifie un tableau de dépendances de module externe.

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

-ExternalScriptDependencies

Spécifie un tableau de dépendances de script externe.

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

-Force

Force l’exécution de la commande sans demander la confirmation de l’utilisateur.

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

-Guid

Spécifie un ID unique pour le script.

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

-IconUri

Spécifie l’URL d’une icône pour le script. L’icône spécifiée s’affiche sur la page web de la galerie pour le script.

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

-LicenseUri

Spécifie l’URL des termes de licence.

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

-PassThru

L’applet de commande proxy ignore ce paramètre, car il n’est pas pris en charge par New-PSScriptFileInfo.

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

-Path

Spécifie l’emplacement où le fichier de script est enregistré.

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

-PrivateData

Spécifie les données privées pour le script.

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

-ProjectUri

Spécifie l’URL d’une page web relative à ce projet.

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

-ReleaseNotes

Spécifie un tableau de chaînes qui contient des notes de publication ou des commentaires que vous souhaitez mettre à la disposition des utilisateurs de cette version du script.

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

-RequiredModules

Spécifie les modules qui doivent être dans l'état de session global. Si les modules requis ne sont pas à l’état de session globale, PowerShell les importe.

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

-RequiredScripts

Spécifie un tableau de scripts requis.

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

-Tags

Spécifie un tableau de balises.

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

-Version

Spécifie la version du script.

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

-WhatIf

Affiche ce qui se produirait en cas New-ScriptFileInfo d’exécution. L’applet de commande n’est pas exécutée.

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

Entrées

String

Sorties

Object

Partager via

New-ScriptFileInfo

Syntax

Description

Exemples

Exemple 1 : Créer un fichier de script et spécifier sa version, son auteur et sa description

Exemple 2 : Tester un fichier de script

Exemple 3 : Créer un fichier de script avec toutes les propriétés de métadonnées

Paramètres

-Author

-CompanyName

-Confirm

-Copyright

-Description

-ExternalModuleDependencies

-ExternalScriptDependencies

-Force

-Guid

-IconUri

-LicenseUri

-PassThru

-Path

-PrivateData

-ProjectUri

-ReleaseNotes

-RequiredModules

-RequiredScripts

-Tags

-Version

-WhatIf

Entrées

Sorties

Ressources supplémentaires

Partager via

New-ScriptFileInfo

Syntax

Description

Exemples

Exemple 1 : Créer un fichier de script et spécifier sa version, son auteur et sa description

Exemple 2 : Tester un fichier de script

Exemple 3 : Créer un fichier de script avec toutes les propriétés de métadonnées

Paramètres

-Author

-CompanyName

-Confirm

-Copyright

-Description

-ExternalModuleDependencies

-ExternalScriptDependencies

-Force

-Guid

-IconUri

-LicenseUri

-PassThru

-Path

-PrivateData

-ProjectUri

-ReleaseNotes

-RequiredModules

-RequiredScripts

-Tags

-Version

-WhatIf

Entrées

Sorties

Liens associés

Ressources supplémentaires