Update-Help
Baixa e instala os arquivos de ajuda mais recentes em seu computador.
Syntax
Update-Help
[[-Module] <String[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[[-SourcePath] <String[]>]
[-Recurse]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Update-Help
[[-Module] <String[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-LiteralPath <String[]>]
[-Recurse]
[[-UICulture] <CultureInfo[]>]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]Description
O Update-Help cmdlet baixa os arquivos de ajuda mais recentes para módulos do PowerShell e os instala em seu computador. Você não precisa reiniciar o PowerShell para tornar a alteração eficaz. Você pode usar o Get-Help cmdlet para exibir os novos arquivos de ajuda imediatamente.
Update-Help verifica a versão dos arquivos de ajuda em seu computador. Se você não tiver arquivos de ajuda para um módulo ou se seus arquivos de ajuda estiverem desatualizados, Update-Help baixe os arquivos de ajuda mais recentes. Os arquivos de ajuda podem ser baixados e instalados na Internet ou em um compartilhamento de arquivos.
Sem parâmetros, Update-Help atualiza os arquivos de ajuda para módulos na sessão e para todos os módulos instalados que dão suporte à Ajuda Atualizável. Os módulos instalados, mas não carregados na sessão atual, estão incluídos. Os módulos do PowerShell são armazenados em um local listado na variável de $env:PSModulePath ambiente. Para obter mais informações, consulte about_Updatable_Help.
Você pode usar o parâmetro Module para atualizar arquivos de ajuda para um módulo específico. Use o parâmetro UICulture para baixar arquivos de ajuda em vários idiomas e localidades.
Você também pode usar Update-Help em computadores que não estão conectados à Internet. Primeiro, use o Save-Helpcmdlet para baixar arquivos de ajuda da Internet e salvá-los em uma pasta compartilhada que esteja acessível ao sistema não conectado à Internet. Em seguida, use o parâmetro Update-HelpSourcePath para baixar os arquivos de ajuda atualizados do compartilhado e instalá-los no computador.
Você pode automatizar atualizações de ajuda adicionando o Update-Help cmdlet ao seu perfil do PowerShell. Por padrão, Update-Help executa apenas uma vez por dia em cada computador. Para substituir o limite de uma vez por dia, use o parâmetro Force.
O Update-Help cmdlet foi introduzido no Windows PowerShell 3.0.
Importante
Update-Help requer privilégios administrativos no PowerShell 6.0 e abaixo.
O PowerShell 6.1 e superior definem o Escopo padrão como CurrentUser.
Antes do PowerShell 6.1, o parâmetro Escopo não estava disponível.
Você deve ser um membro do grupo Administradores no computador para atualizar os arquivos de ajuda para os módulos do PowerShell Core.
Para baixar ou atualizar os arquivos de ajuda para módulos no diretório de instalação do PowerShell ($PSHOME\Modules), incluindo os módulos do PowerShell Core, inicie o PowerShell usando a opção Executar como administrador .
Por exemplo: Start-Process pwsh.exe -Verb RunAs.
Exemplos
Exemplo 1: atualizar arquivos de ajuda para todos os módulos
O Update-Help cmdlet atualiza arquivos de ajuda para módulos instalados que dão suporte à Ajuda Atualizável. A linguagem de cultura interface do usuário (interface do usuário) é definida no sistema operacional.
Update-HelpExemplo 2: atualizar arquivos de ajuda para módulos especificados
As Update-Help atualizações de cmdlet ajudam os arquivos somente para nomes de módulo que começam com o Microsoft.PowerShell.
Update-Help -Module Microsoft.PowerShell*Exemplo 3: atualizar arquivos de ajuda para idiomas diferentes
O Update-Help cmdlet atualiza os arquivos de ajuda japonês (ja-JP) e inglês (en-US) para todos os módulos.
Se um módulo não fornecer arquivos de ajuda para uma cultura de interface do usuário especificada, uma mensagem de erro será exibida para o módulo e a cultura da interface do usuário. Neste exemplo, a mensagem de erro indica que os arquivos de ajuda ja-JP não foram encontrados para o módulo Microsoft.PowerShell.Utility.
Update-Help -UICulture ja-JP, en-US
Update-Help : Failed to update Help for the module(s) 'Microsoft.PowerShell.Utility' with UI culture(s) {ja-JP}
No UI culture was found that matches the following pattern: ja-JP.Exemplo 4: atualizar arquivos de ajuda em vários computadores de um compartilhamento de arquivos
Neste exemplo, os arquivos de ajuda atualizados são baixados da Internet e salvos em um compartilhamento de arquivos. As credenciais do usuário são necessárias que tenham permissões para acessar o compartilhamento de arquivos e instalar atualizações. Quando um compartilhamento de arquivos é usado, é possível atualizar computadores que estão por trás de firewalls ou que não estão conectados à Internet.
Save-Help -DestinationPath \\Server01\Share\PSHelp -Credential Domain01\Admin01
Invoke-Command -ComputerName (Get-Content Servers.txt) -ScriptBlock {
Update-Help -SourcePath \\Server01\Share\PSHelp -Credential Domain01\Admin01
}O Save-Help comando baixa os arquivos de ajuda mais recentes para todos os módulos que dão suporte à Ajuda Atualizável.
O parâmetro DestinationPath salva os arquivos no \\Server01\Share\PSHelp compartilhamento de arquivos. O parâmetro Credential especifica um usuário que tem permissão para acessar o compartilhamento de arquivos.
O Invoke-Command cmdlet executa comandos remotos Update-Help em vários computadores. O parâmetro ComputerName obtém uma lista de computadores remotos do arquivo Servers.txt . O parâmetro ScriptBlock executa o Update-Help comando e usa o parâmetro SourcePath para especificar o compartilhamento de arquivos que contém os arquivos de ajuda atualizados. O parâmetro Credencial especifica um usuário que pode acessar o compartilhamento de arquivos e executar o comando remoto Update-Help .
Exemplo 5: Obter uma lista de arquivos de ajuda atualizados
O Update-Help cmdlet atualiza a ajuda para um módulo especificado. O cmdlet usa o parâmetro comum Verbose para exibir a lista de arquivos de ajuda que foram atualizados. Você pode usar Verbose para exibir a saída de todos os arquivos de ajuda ou arquivos de ajuda para um módulo específico.
Sem o parâmetro Verbose , Update-Help não exibe os resultados do comando. A saída do parâmetro Verbose é útil para verificar se os arquivos de ajuda foram atualizados ou se a versão mais recente está instalada.
Update-Help -Module Microsoft.PowerShell.Utility -VerboseExemplo 6: localizar módulos que dão suporte à Ajuda Atualizável
Este exemplo lista módulos que dão suporte à Ajuda Atualizável. O comando usa a propriedade HelpInfoUri do módulo para identificar módulos que dão suporte à Ajuda Atualizável. A propriedade HelpInfoUri contém um endereço redirecionado quando o Update-Help cmdlet é executado.
Get-Module -ListAvailable | Where-Object -Property HelpInfoUri
Directory: C:\program files\powershell\6\Modules
ModuleType Version Name PSEdition ExportedCommands
---------- ------- ---- --------- ----------------
Manifest 6.1.0.0 CimCmdlets Core {Get-CimAssociatedInstance... }
Manifest 1.2.2.0 Microsoft.PowerShell.Archive Desk {Compress-Archive... }
Manifest 6.1.0.0 Microsoft.PowerShell.Diagnostics Core {Get-WinEvent, New-WinEvent}
Directory: C:\WINDOWS\system32\WindowsPowerShell\v1.0\Modules
ModuleType Version Name PSEdition ExportedCommands
---------- ------- ---- --------- ----------------
Manifest 2.0.1.0 Appx Core,Desk {Add-AppxPackage, ... }
Script 1.0.0.0 AssignedAccess Core,Desk {Clear-AssignedAccess, ... }
Manifest 1.0.0.0 BitLocker Core,Desk {Unlock-BitLocker, ... }Exemplo 7: Arquivos de ajuda atualizados de inventário
Neste exemplo, o script Get-UpdateHelpVersion.ps1 cria um inventário dos arquivos de Ajuda Atualizáveis para cada módulo e seus números de versão.
O script identifica módulos que dão suporte à Ajuda Atualizável usando a propriedade HelpInfoUri de módulos. Para módulos que dão suporte à Ajuda Atualizável, o script procura e analisa o arquivo de informações de ajuda (*helpinfo.xml) para localizar o número de versão mais recente.
O script usa a classe PSCustomObject e uma tabela de hash para criar um objeto de saída personalizado.
# Get-UpdateHelpVersion.ps1
Param(
[parameter(Mandatory=$False)]
[String[]]
$Module
)
$HelpInfoNamespace = @{helpInfo='https://schemas.microsoft.com/powershell/help/2010/05'}
if ($Module) { $Modules = Get-Module $Module -ListAvailable | where {$_.HelpInfoUri} }
else { $Modules = Get-Module -ListAvailable | where {$_.HelpInfoUri} }
foreach ($mModule in $Modules)
{
$mDir = $mModule.ModuleBase
if (Test-Path $mdir\*helpinfo.xml)
{
$mName=$mModule.Name
$mNodes = dir $mdir\*helpinfo.xml -ErrorAction SilentlyContinue |
Select-Xml -Namespace $HelpInfoNamespace -XPath "//helpInfo:UICulture"
foreach ($mNode in $mNodes)
{
$mCulture=$mNode.Node.UICultureName
$mVer=$mNode.Node.UICultureVersion
[PSCustomObject]@{"ModuleName"=$mName; "Culture"=$mCulture; "Version"=$mVer}
}
}
}
ModuleName Culture Version
---------- ------- -------
ActiveDirectory en-US 3.0.0.0
ADCSAdministration en-US 3.0.0.0
ADCSDeployment en-US 3.0.0.0
ADDSDeployment en-US 3.0.0.0
ADFS en-US 3.0.0.0Parâmetros
-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 as credenciais de um usuário que tem permissão para acessar o local do sistema de arquivos especificado pelo SourcePath. Esse parâmetro é válido somente quando o parâmetro SourcePath ou LiteralPath é usado no comando.
O parâmetro credential permite executar Update-Help comandos com o parâmetro SourcePath em computadores remotos. Ao fornecer credenciais explícitas, você pode executar o comando em um computador remoto e acessar um compartilhamento de arquivos em um terceiro computador sem encontrar um erro de acesso negado ou usar a autenticação CredSSP para delegar credenciais.
Digite um nome de usuário, como User01 ou Domain01\User01, ou insira um objeto PSCredential gerado pelo Get-Credential cmdlet. Se você digitar um nome de usuário, será solicitado que insira a senha.
As credenciais são armazenadas em um objeto PSCredential e a senha é armazenada como um SecureString.
Observação
Para obter mais informações sobre a proteção de dados SecureString , consulte Quão seguro é SecureString?.
| Type: | PSCredential |
| Position: | Named |
| Default value: | Current user |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
Indica que esse cmdlet não segue a limitação de uma vez por dia, ignora a verificação de versão e baixa arquivos que excedem o limite de 1 GB.
Sem esse parâmetro, Update-Help é executado apenas uma vez em cada período de 24 horas. Os downloads são limitados a 1 GB de conteúdo não compactado por módulo e os arquivos de ajuda só são instalados quando são mais recentes do que os arquivos existentes no computador.
O limite de uma vez por dia protege os servidores que hospedam os arquivos de ajuda e torna prático adicionar um Update-Help comando ao seu perfil do PowerShell sem incorrer no custo de recursos de conexões ou downloads repetidos.
Para atualizar a Ajuda para um módulo em várias culturas de interface do usuário sem o parâmetro Force, incluem todas as culturas de interface do usuário no mesmo comando, como:
Update-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FullyQualifiedModule
Especifica módulos com nomes especificados na forma de objetos ModuleSpecification . Esses módulos são descritos na seção Comentários do Construtor ModuleSpecification (Hashtable).
Por exemplo, o parâmetro FullyQualifiedModule aceita um nome de módulo especificado no formato:
@{ModuleName = "modulename"; ModuleVersion = "version_number"}
ou
@{ModuleName = "modulename"; ModuleVersion = "version_number"; Guid = "GUID"}.
ModuleName e ModuleVersion são obrigatórios, mas Guid é opcional.
Você não pode especificar o parâmetro FullyQualifiedModule no mesmo comando que um parâmetro module .
| Type: | ModuleSpecification[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-LiteralPath
Especifica a pasta para arquivos de ajuda atualizados em vez de baixá-los da Internet. Use esse parâmetro ou SourcePath se você tiver usado o Save-Help cmdlet para baixar arquivos de ajuda em um diretório.
Você pode pipeline de um objeto de diretório, como do Get-Item ou Get-ChildItem cmdlets, para Update-Help.
Ao contrário do valor de SourcePath, o valor de LiteralPath é usado exatamente como ele é digitado. Nenhum caractere é interpretado como caractere curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. As aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.
| Type: | String[] |
| Aliases: | PSPath, LP |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-Module
Atualizações de Ajuda para os módulos especificados. Insira um ou mais nomes de módulo ou padrões de nome em uma lista separada por vírgulas ou especifique um arquivo que lista um nome de módulo em cada linha. Caracteres curinga são permitidos. Você pode pipeline módulos do Get-Module cmdlet para o Update-Help cmdlet.
Os módulos especificados devem ser instalados no computador, mas eles não precisam ser importados para a sessão atual. Você pode especificar qualquer módulo na sessão ou em qualquer módulo instalado em um local listado na variável de $env:PSModulePath ambiente.
Um valor de * (todos) tenta atualizar a ajuda para todos os módulos instalados no computador.
Os módulos que não dão suporte à Ajuda Atualizável estão incluídos. Esse valor pode gerar erros quando o comando encontra módulos que não dão suporte à Ajuda Atualizável. Em vez disso, execute Update-Help sem parâmetros.
O parâmetro Module do Update-Help cmdlet não aceita o caminho completo de um arquivo de módulo ou arquivo de manifesto do módulo. Para atualizar a ajuda para um módulo que não está em um $env:PSModulePath local, importe o módulo para a sessão atual antes de executar o Update-Help comando.
| Type: | String[] |
| Aliases: | Name |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | True |
-Recurse
Executa uma pesquisa recursiva para arquivos de ajuda no diretório especificado. Esse parâmetro é válido somente quando o comando usa o parâmetro SourcePath .
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Scope
Especifica o escopo do sistema em que a ajuda é atualizada. Atualizações no escopo dos AllUsers exigem privilégios administrativos em sistemas Windows. O -Scope parâmetro foi introduzido no PowerShell Core versão 6.1.
CurrentUser é o escopo padrão para arquivos de ajuda no PowerShell 6.1 e superior. Os AllUsers podem ser especificados para instalar ou atualizar a ajuda para todos os usuários. Em sistemas sudo Unix, os privilégios são necessários para atualizar a ajuda para todos os usuários. Por exemplo: sudo pwsh -c Update-Help
Os valores aceitáveis são:
- CurrentUser
- Allusers
| Type: | UpdateHelpScope |
| Position: | Named |
| Default value: | CurrentUser |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-SourcePath
Especifica uma pasta do sistema de arquivos onde Update-Help obtém arquivos de ajuda atualizados, em vez de baixá-los da Internet. Insira o caminho de uma pasta. Não especifique um nome de arquivo ou uma extensão de nome de arquivo. Você pode fazer o pipeline de uma pasta, como uma dos Get-Item cmdlets ou Get-ChildItem dos cmdlets, para Update-Help.
Por padrão, Update-Help baixa arquivos de ajuda atualizados da Internet. Use o SourcePath quando você tiver usado o Save-Help cmdlet para baixar arquivos de ajuda atualizados em um diretório.
Para especificar um valor padrão para SourcePath, vá para Política de Grupo, Configuração do Computador e Definir o caminho de origem padrão para Update-Help. Essa configuração de Política de Grupo impede que os usuários usem Update-Help para baixar arquivos de ajuda da Internet.
Confira mais informações em about_Group_Policy_Settings.
| Type: | String[] |
| Aliases: | Path |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UICulture
Especifica os valores de cultura da interface do usuário que Update-Help usam para obter arquivos de ajuda atualizados. Insira um ou mais códigos de linguagem, como es-ES, uma variável que contém objetos de cultura ou um comando que obtém objetos de cultura, como um Get-Culture ou Get-UICulture comando. Caracteres curinga não são permitidos e você não pode enviar um código de linguagem parcial, como de.
Por padrão, Update-Help obtém arquivos de ajuda no conjunto de cultura da interface do usuário para o sistema operacional. Se você especificar o parâmetro UICulture , Update-Help procure ajuda apenas para a cultura de interface do usuário especificada.
Observação
O Ubuntu 18.04 alterou a configuração de localidade padrão para C.UTF.8, que não é uma cultura de interface do usuário reconhecida. Update-Help silenciosamente falha ao baixar a ajuda, a menos que você use esse parâmetro com uma localidade com suporte, como en-US. Isso pode ocorrer em qualquer plataforma que use um valor sem suporte.
Os comandos que utilizam o parâmetro UICulture têm êxito somente quando o módulo fornece arquivos de ajuda para a cultura da interface do usuário especificado. Se o comando falhar porque não há suporte para a cultura da interface do usuário especificada, uma mensagem de erro será exibida.
| Type: | CultureInfo[] |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseDefaultCredentials
Indica que Update-Help executa o comando, incluindo o download da Internet, usando as credenciais do usuário atual. Por padrão, o comando é executado sem credenciais explícitas.
Esse parâmetro só é eficaz quando o download na Web usa NTLM (NTLM), negociação ou autenticação baseada em Kerberos.
| Type: | SwitchParameter |
| 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
Você pode canalizar um caminho de diretório para Update-Help.
Você pode canalizar um objeto de módulo do Get-Module cmdlet para Update-Help.
Saídas
None
Update-Help não gera nenhuma saída.
Observações
Para atualizar a ajuda para os módulos do PowerShell Core, que contêm os comandos instalados com o PowerShell ou qualquer módulo no diretório, inicie o $PSHOME\Modules PowerShell com a opção executar como administrador.
Somente os membros do grupo Administradores no computador podem atualizar a ajuda para os módulos do PowerShell Core, os comandos instalados junto com o PowerShell e para módulos na $PSHOME\Modules pasta. Se você não tiver permissão para atualizar arquivos de ajuda, poderá ler os arquivos de ajuda online. Por exemplo, Get-Help Update-Help -Online.
Os módulos são a menor unidade da ajuda atualizável. Você não pode atualizar a ajuda para um cmdlet específico. Para localizar o módulo que contém um cmdlet específico, use a propriedade ModuleName do Get-Command cmdlet, por exemplo, (Get-Command Update-Help).ModuleName.
Como os arquivos de ajuda são instalados no diretório do módulo, o Update-Help cmdlet pode instalar o arquivo de ajuda atualizado somente para módulos instalados no computador. No entanto, o Save-Help cmdlet pode salvar a ajuda para módulos que não estão instalados no computador.
Se Update-Help não encontrar arquivos de ajuda atualizados para um módulo ou não encontrar ajuda atualizada no idioma especificado, ele continuará silenciosamente sem exibir uma mensagem de erro. Para ver os detalhes de status e o andamento, use o parâmetro Verbose.
O Update-Help cmdlet foi introduzido no Windows PowerShell 3.0. Ele não funciona em versões anteriores do PowerShell. Em computadores que têm Windows PowerShell 2.0 e Windows PowerShell 3.0, use o Update-Help cmdlet em uma sessão Windows PowerShell 3.0 para baixar e atualizar arquivos de ajuda. Os arquivos de ajuda estão disponíveis para Windows PowerShell 2.0 e Windows PowerShell 3.0.
Os Update-Help cmdlets e Save-Help os cmdlets usam as seguintes portas para baixar arquivos de ajuda: Porta 80 para HTTP e porta 443 para HTTPS.
Update-Help dá suporte a todos os módulos e snap-ins do PowerShell Core. Ele não dá suporte a outros snap-ins.
Para atualizar a ajuda de um módulo em um local que não está listado na variável de $env:PSModulePath ambiente, importe o módulo para a sessão atual e execute um Update-Help comando. Execute Update-Help sem parâmetros ou use o parâmetro Module para especificar o nome do módulo. O parâmetro Module dos cmdlets e Save-Help do Update-Help módulo não aceita o caminho completo de um arquivo de módulo ou arquivo de manifesto do módulo.
Qualquer módulo pode dar suporte a Ajuda atualizável. Para obter instruções sobre como dar suporte à Ajuda Atualizável nos módulos criados, consulte Suporte à Ajuda Atualizável.
Não Update-Help há suporte para os cmdlets e os Save-Help cmdlets no Windows PE (Ambiente de Pré-Instalação do Windows).