Partager via

Install-Script

  • Référence
Module:
PowerShellGet

Installe un script.

Syntaxe

Install-Script
       [-Name] <String[]>
       [-MinimumVersion <String>]
       [-MaximumVersion <String>]
       [-RequiredVersion <String>]
       [-Repository <String[]>]
       [-Scope <String>]
       [-NoPathUpdate]
       [-Proxy <Uri>]
       [-ProxyCredential <PSCredential>]
       [-Credential <PSCredential>]
       [-Force]
       [-AllowPrerelease]
       [-AcceptLicense]
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]
Install-Script
       [-InputObject] <PSObject[]>
       [-Scope <String>]
       [-NoPathUpdate]
       [-Proxy <Uri>]
       [-ProxyCredential <PSCredential>]
       [-Credential <PSCredential>]
       [-Force]
       [-AcceptLicense]
       [-PassThru]
       [-WhatIf]
       [-Confirm]
       [<CommonParameters>]

Description

L’applet Install-Script de commande acquiert une charge utile de script à partir d’un référentiel, vérifie que la charge utile est un script PowerShell valide et copie le fichier de script à un emplacement d’installation spécifié.

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

Exemples

Exemple 1 : Rechercher un script et l’installer

PS C:\> Find-Script -Repository "Local1" -Name "Required-Script2"
Version    Name                           Type       Repository           Description
-------    ----                           ----       ----------           -----------
2.5        Required-Script2               Script     local1               Description for the Required-Script2 script

PS C:\> Find-Script -Repository "Local1" -Name "Required-Script2" | Install-Script
PS C:\> Get-Command -Name "Required-Script2"
CommandType     Name                      Version    Source
-----------     ----                      -------    ------
ExternalScript  Required-Script2.ps1      2.0       C:\Users\pattif\Documents\WindowsPowerShell\Scripts\Required-Script2.ps1

PS C:\> Get-InstalledScript -Name "Required-Script2"
Version    Name                  Type     Repository           Description
-------    ----                  ----     ----------           -----------
2.5        Required-Script2      Script   local1               Description for the Required-Script2 script

PS C:\> Get-InstalledScript -Name "Required-Script2" | Format-List *
Name                       : Required-Script2
Version                    : 2.5
Type                       : Script
Description                : Description for the Required-Script2 script
Author                     : pattif
CompanyName                :
Copyright                  : 2015 Microsoft Corporation. All rights reserved.
PublishedDate              : 8/15/2015 12:42:39 AM
LicenseUri                 : http://required-script2.com/license
ProjectUri                 : http://required-script2.com/
IconUri                    : http://required-script2.com/icon
Tags                       : {Tag1, Tag2, Tag-Required-Script2-2.5, PSScript...}
Includes                   : {Function, DscResource, Cmdlet, Command}
PowerShellGetFormatVersion :
ReleaseNotes               : Required-Script2 release notes
Dependencies               : {}
RepositorySourceLocation   : http://pattif-dev:8765/api/v2/
Repository                 : local1
PackageManagementProvider  : NuGet
InstalledLocation          : C:\Users\pattif\Documents\WindowsPowerShell\Scripts

La première commande recherche le script nommé Required-Script2 à partir du référentiel Local1 et affiche les résultats.

La deuxième commande recherche le Required-Script2 script, puis utilise l’opérateur de pipeline pour le transmettre à l’applet Install-Script de commande pour l’installer.

La troisième commande utilise l’applet Get-Command de commande pour obtenir Required-Script2, puis affiche les résultats.

La quatrième commande utilise l’applet Get-InstalledScript de commande pour obtenir Required-Script2 et afficher les résultats.

La cinquième commande obtient Required-Script2 et utilise l’opérateur de pipeline pour le transmettre à l’applet Format-List de commande pour mettre en forme la sortie.

Exemple 2 : Installer un script avec l’étendue AllUsers

PS C:\> Install-Script -Repository "Local1" -Name "Required-Script3" -Scope "AllUsers"
PS C:\> Get-InstalledScript -Name "Required-Script3"
Version    Name                  Type       Repository    Description
-------    ----                  ----       ----------    -----------
2.5        Required-Script3      Script     local1        Description for the Required-Script3 script

PS C:\> Get-InstalledScript -Name "Required-Script3" | Format-List *
Name                       : Required-Script3
Version                    : 2.5
Type                       : Script
Description                : Description for the Required-Script3 script
Author                     : pattif
CompanyName                :
Copyright                  : 2015 Microsoft Corporation. All rights reserved.
PublishedDate              : 8/15/2015 12:42:45 AM
LicenseUri                 : http://required-script3.com/license
ProjectUri                 : http://required-script3.com/
IconUri                    : http://required-script3.com/icon
Tags                       : {Tag1, Tag2, Tag-Required-Script3-2.5, PSScript...}
Includes                   : {Function, DscResource, Cmdlet, Command}
PowerShellGetFormatVersion :
ReleaseNotes               : Required-Script3 release notes
Dependencies               : {}
RepositorySourceLocation   : http://pattif-dev:8765/api/v2/
Repository                 : local1
PackageManagementProvider  : NuGet
InstalledLocation          : C:\Program Files\WindowsPowerShell\Scripts

La première commande installe le script nommé Required-Script3 et lui affecte l’étendue AllUsers.

La deuxième commande obtient le script Required-Script3 installé et affiche des informations sur celui-ci.

La troisième commande obtient Required-Script3 et utilise l’opérateur de pipeline pour le transmettre à l’applet Format-List de commande pour mettre en forme la sortie.

Exemple 3 : Installer un script et ses dépendances

PS C:\> Find-Script -Repository "Local1" -Name "Script-WithDependencies2" -IncludeDependencies
Version    Name                        Type       Repository    Description
-------    ----                        ----       ----------    -----------
2.0        Script-WithDependencies2    Script     local1        Description for the Script-WithDependencies2 script
2.5        RequiredModule1             Module     local1        RequiredModule1 module
2.5        RequiredModule2             Module     local1        RequiredModule2 module
2.5        RequiredModule3             Module     local1        RequiredModule3 module
2.5        Required-Script1            Script     local1        Description for the Required-Script1 script
2.5        Required-Script2            Script     local1        Description for the Required-Script2 script
2.5        Required-Script3            Script     local1        Description for the Required-Script3 script

PS C:\> Install-Script -Repository "Local1" -Name "Script-WithDependencies2"
PS C:\> Get-InstalledScript
Version    Name                        Type       Repository    Description
-------    ----                        ----       ----------    -----------
2.5        Required-Script1            Script     local1        Description for the Required-Script1 script
2.5        Required-Script2            Script     local1        Description for the Required-Script2 script
2.5        Required-Script3            Script     local1        Description for the Required-Script3 script
2.0        Script-WithDependencies2    Script     local1        Description for the Script-WithDependencies2 script

PS C:\> Get-InstalledModule
Version    Name                        Type       Repository    Description
-------    ----                        ----       ----------    -----------
2.5        RequiredModule1             Module     local1        RequiredModule1 module
2.5        RequiredModule2             Module     local1        RequiredModule2 module
2.5        RequiredModule3             Module     local1        RequiredModule3 module

PS C:\> Find-Script -Repository "Local1" -Name "Required-Script*"
Version    Name                        Type       Repository    Description
-------    ----                        ----       ----------    -----------
2.5        Required-Script1            Script     local1        Description for the Required-Script1 script
2.5        Required-Script2            Script     local1        Description for the Required-Script2 script
2.5        Required-Script3            Script     local1        Description for the Required-Script3 script

PS C:\> Install-Script -Repository "Local1" -Name "Required-Script*"
PS C:\> Get-InstalledScript
Version    Name                        Type       Repository    Description
-------    ----                        ----       ----------    -----------
2.5        Required-Script1            Script     local1        Description for the Required-Script1 script
2.5        Required-Script2            Script     local1        Description for the Required-Script2 script
2.5        Required-Script3            Script     local1        Description for the Required-Script3 script

La première commande recherche le script nommé Script-WithDependencies2 et ses dépendances dans le référentiel Local1 et affiche les résultats.

La deuxième commande installe Script-WithDependencies2.

La troisième commande utilise l’applet de commande de Get-InstalledScript script pour obtenir des scripts installés et afficher les résultats.

La quatrième commande utilise l’applet Get-InstalledModule de commande pour obtenir les modules installés et afficher les résultats.

La cinquième commande utilise l’applet Find-Script de commande pour rechercher des scripts dans lesquels le nom commence Required-Script et affiche les résultats.

La sixième commande installe les scripts dans lesquels le nom commence Required-Script dans le référentiel Local1.

La commande finale obtient les scripts installés et affiche les résultats.

Paramètres

-AcceptLicense

Acceptez automatiquement le contrat de licence pendant l’installation si le module l’exige.

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

-AllowPrerelease

Vous permet d’installer un script marqué comme préversion.

L’applet de commande proxy mappe ce paramètre au paramètre Prerelease de Install-PSResource.

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

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

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

-Credential

Spécifie un compte d’utilisateur disposant des droits d’installation d’un script pour un fournisseur de package ou une source de package spécifié.

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

-Force

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

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

-InputObject

Utilisé pour l’entrée de pipeline. Une erreur est levée si une valeur fournie directement à InputObject. Utilisez le pipeline pour passer des objets avec le paramètre InputObject .

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

-MaximumVersion

L’applet de commande proxy utilise la valeur de ce paramètre pour créer une chaîne de recherche de version NuGet à utiliser avec le paramètre Version de Install-PSResource.

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

-MinimumVersion

L’applet de commande proxy utilise la valeur de ce paramètre pour créer une chaîne de recherche de version NuGet à utiliser avec le paramètre Version de Install-PSResource.

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

-Name

Spécifie un tableau de noms de scripts à installer.

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

-NoPathUpdate

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

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

-PassThru

Lorsque vous utilisez le paramètre PassThru , Install-Script génère un objet PSRepositoryItemInfo pour le module. Il s’agit des mêmes informations que celles que vous obtenez à partir de l’applet Find-Script de commande.

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

-Proxy

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

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

-ProxyCredential

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

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

-Repository

Spécifie le nom convivial d’un référentiel qui a été inscrit auprès de l’applet Register-PSRepository de commande. La valeur par défaut est tous les référentiels inscrits.

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

-RequiredVersion

L’applet de commande proxy utilise la valeur de ce paramètre pour créer une chaîne de recherche de version NuGet à utiliser avec le paramètre Version de Install-PSResource.

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

-Scope

Spécifie l’étendue d’installation du script. Les valeurs valides sont : AllUsers et CurrentUser.

L’étendue AllUsers permet aux modules d’être installés dans un emplacement accessible à tous les utilisateurs de l’ordinateur, autrement dit. $env:ProgramFiles\WindowsPowerShell\Scripts

L’étendue CurrentUser permet aux modules d’être installés uniquement $HOME\Documents\WindowsPowerShell\Scriptspour que le module soit disponible uniquement pour l’utilisateur actuel.

Quand aucune étendue n’est définie, la valeur par défaut est définie en fonction de la session active :

  • Pour une session PowerShell avec élévation de privilèges, l’étendue est définie par défaut sur AllUsers ;
  • Pour les sessions PowerShell non élevées dans PowerShellGet versions 2.0.0 et ultérieures, l’étendue est CurrentUser ;
  • Pour les sessions PowerShell non élevées dans PowerShellGet versions 1.6.7 et antérieures, l’étendue n’est pas définie et Install-Module échoue.
Type:String
Valeurs acceptées:CurrentUser, AllUsers
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande ne s’exécute pas.

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

Entrées

String[]

PSObject[]

String

Uri

PSCredential

Sorties

Object

Notes

Important

Depuis avril 2020, PowerShell Gallery ne prend plus en charge les versions TLS (Transport Layer Security) 1.0 et 1.1. Si vous n’utilisez pas TLS 1.2 ou version ultérieure, vous recevez une erreur lors de la tentative d’accès à PowerShell Gallery. Utilisez la commande suivante pour vous assurer que vous utilisez TLS 1.2 :

[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12

Pour plus d’informations, consultez l’annonce dans le blog PowerShell.