Install-Script
Instala um script.
Syntax
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
O Install-Script
cmdlet adquire uma carga de script de um repositório, verifica se o conteúdo é um script válido do PowerShell e copia o arquivo de script para um local de instalação especificado.
Os repositórios Install-Script
padrão que operam em são configuráveis por meio dos Register-PSRepository
cmdlets , Set-PSRepository
Unregister-PSRepository
, e Get-PSRepository
. Ao operar em vários repositórios, Install-Script
o instala o primeiro script que corresponde aos critérios de pesquisa especificados (Name, MinimumVersion ou MaximumVersion) do primeiro repositório sem nenhum erro.
Exemplos
Exemplo 1: localizar um script e instalá-lo
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
O primeiro comando localiza o script chamado Required-Script2
do repositório Local1 e exibe os resultados.
O segundo comando localiza o Required-Script2
script e, em seguida, usa o operador de pipeline para passá-lo para o Install-Script
cmdlet para instalá-lo.
O terceiro comando usa o Get-Command
cmdlet para obter Required-Script2
e exibe os resultados.
O quarto comando usa o Get-InstalledScript
cmdlet para obter Required-Script2
e exibir os resultados.
O quinto comando obtém Required-Script2
e usa o operador de pipeline para passá-lo para o Format-List
cmdlet para formatar a saída.
Exemplo 2: instalar um script com escopo 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
O primeiro comando instala o script chamado Required-Script3
e atribui a ele o escopo AllUsers.
O segundo comando obtém o script Required-Script3
instalado e exibe informações sobre ele.
O terceiro comando obtém Required-Script3
e usa o operador de pipeline para passá-lo para o Format-List
cmdlet para formatar a saída.
Exemplo 3: instalar um script e suas dependências
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
O primeiro comando localiza o script chamado Script-WithDependencies2
e suas dependências no repositório Local1 e exibe os resultados.
O segundo comando instala Script-WithDependencies2
o .
O terceiro comando usa o Get-InstalledScript
cmdlet de script para obter scripts instalados e exibir os resultados.
O quarto comando usa o Get-InstalledModule
cmdlet para obter módulos instalados e exibir os resultados.
O quinto comando usa o Find-Script
cmdlet para localizar scripts com Required-Script
os quais o nome começa e exibir os resultados.
O sexto comando instala os scripts em Required-Script
que o nome começa no repositório Local1.
O comando final obtém scripts instalados e exibe os resultados.
Parâmetros
-AcceptLicense
Aceite automaticamente o contrato de licença durante a instalação se o módulo exigir.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-AllowPrerelease
Permite que você instale um script marcado como pré-lançamento.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Confirm
Solicita sua confirmação antes de executar o cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Credential
Especifica uma conta de usuário que tem direitos para instalar um script para um provedor de pacote ou fonte especificado.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Force
Força o comando a ser executado sem solicitar a confirmação do usuário.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Usado para entrada de pipeline. Um erro será gerado se um valor fornecido diretamente para InputObject. Use o pipeline para passar objetos com o parâmetro InputObject .
Type: | PSObject[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-MaximumVersion
Especifica a versão máxima de um único script a ser instalado. Você não poderá adicionar esse parâmetro se estiver tentando instalar vários scripts. Os parâmetros MaximumVersion e RequiredVersion são mutuamente exclusivos; não é possível usar os dois parâmetros no mesmo comando.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-MinimumVersion
Especifica a versão mínima de um único script a ser instalado. Você não poderá adicionar esse parâmetro se estiver tentando instalar vários scripts. Os parâmetros MinimumVersion e RequiredVersion são mutuamente exclusivos; não é possível usar os dois parâmetros no mesmo comando.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Name
Especifica uma matriz de nomes de scripts a serem instalados.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-NoPathUpdate
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Proxy
Especifica um servidor proxy para a solicitação, em vez de se conectar diretamente ao recurso da Internet.
Type: | Uri |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-ProxyCredential
Especifica uma conta de usuário com permissão para conectar-se aos computadores especificados pelo parâmetro Proxy.
Type: | PSCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Repository
Especifica o nome amigável de um repositório que foi registrado com o Register-PSRepository
cmdlet . O padrão é todos os repositórios registrados.
Type: | String[] |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-RequiredVersion
Especifica o número de versão exato do script a ser instalado.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Scope
Especifica o escopo de instalação do script. Os valores válidos são: AllUsers e CurrentUser.
O escopo AllUsers permite que os módulos sejam instalados em um local acessível a todos os usuários do computador, ou seja, $env:ProgramFiles\WindowsPowerShell\Scripts
.
O escopo CurrentUser permite que os módulos sejam instalados somente no , de $HOME\Documents\WindowsPowerShell\Scripts
modo que o módulo esteja disponível apenas para o usuário atual.
Quando nenhum Escopo for definido, o padrão será definido com base na sessão atual:
- Para uma sessão do PowerShell com privilégios elevados, o escopo usa como padrão AllUsers;
- Para sessões do PowerShell não elevadas no PowerShellObter versões 2.0.0 e superiores, Escopo é CurrentUser;
- Para sessões não elevadas do PowerShell no PowerShellObter versões 1.6.7 e anteriores, o Escopo é indefinido e
Install-Module
falha.
Type: | String |
Accepted values: | CurrentUser, AllUsers |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Mostra o que aconteceria se o cmdlet fosse executado. O cmdlet não é executado.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Entradas
String[]
PSObject[]
Saídas
Observações
Importante
A partir de abril de 2020, a Galeria do PowerShell não dará mais suporte às versões 1.0 e 1.1 do protocolo TLS. Se você não estiver usando o TLS 1.2 ou posterior, receberá um erro ao tentar acessar a Galeria do PowerShell. Use o seguinte comando para garantir que esteja usando o TLS 1.2:
[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12
Para obter mais informações, confira o comunicado no blog do PowerShell.