Update-Help
Transfere e instala os ficheiros de ajuda mais recentes no 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 os módulos do PowerShell e os instala em seu computador. Não é necessário reiniciar o PowerShell para tornar a alteração efetiva. Você pode usar o Get-Help cmdlet para exibir os novos arquivos de ajuda imediatamente.
Update-Help Verifica a versão dos ficheiros de ajuda no computador. Se não tiver ficheiros de ajuda para um módulo ou se os seus ficheiros de ajuda estiverem desatualizados, Update-Help transfira os ficheiros de ajuda mais recentes. Os ficheiros de ajuda podem ser descarregados e instalados a partir da Internet ou de uma partilha de ficheiros.
Sem parâmetros, Update-Help atualiza os arquivos de ajuda para módulos que suportam ajuda atualizável e são carregados na sessão ou instalados em um local incluído no $env:PSModulePath. Para obter mais informações, consulte about_Updatable_Help.
Update-Help verifica a versão da ajuda instalada. Se Update-Help não conseguir encontrar arquivos de ajuda atualizados para um módulo, ele continuará silenciosamente sem exibir uma mensagem de erro. Use o parâmetro Force para ignorar a verificação de versão. Use o parâmetro Verbose para ver os detalhes de status e progresso. Use o parâmetro Module para atualizar os arquivos de ajuda de um módulo específico.
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 acessível ao sistema não conectado à Internet. Em seguida, use o parâmetro SourcePath de Update-Help para baixar os arquivos de ajuda atualizados do compartilhado e instalá-los no computador.
O Update-Help cmdlet foi introduzido no Windows PowerShell 3.0.
Importante
Update-Help requer privilégios administrativos no PowerShell 6.0 e inferior. O PowerShell 6.1 e superior definem o Escopo padrão como CurrentUser. Antes do PowerShell 6.1, o parâmetro Scope não estava disponível.
Você deve ser membro do grupo Administradores no computador para atualizar os arquivos de ajuda para os módulos principais do PowerShell.
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 principais do PowerShell, 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 os arquivos de ajuda para os módulos instalados que oferecem suporte à Ajuda Atualizável. A linguagem de cultura da interface do usuário (UI) é definida no sistema operacional.
Update-HelpExemplo 2: Atualizar arquivos de ajuda para módulos especificados
O Update-Help cmdlet atualiza os arquivos de ajuda somente para nomes de módulos que começam com Microsoft.PowerShell.
Update-Help -Module Microsoft.PowerShell*Exemplo 3: Atualizando a ajuda em um sistema não definido para a localidade en-US
O Update-Help cmdlet foi projetado para baixar a ajuda em vários idiomas. No entanto, quando não há ajuda disponível para o idioma usado pelo sistema, uma mensagem de erro é exibida para o módulo e a cultura da interface do usuário.
Neste exemplo, Update-Help está sendo executado em um sistema definido para a en-GB localidade.
Update-Help Microsoft.PowerShell.Utility -Force
Update-Help: Failed to update Help for the module(s) 'Microsoft.PowerShell.Utility' with
UI culture(s) {en-GB} : The specified culture is not supported: en-GB. Specify a culture
from the following list: {en-US}..
English-US help content is available and can be installed using: Update-Help -UICulture en-US.Os arquivos de ajuda são sempre publicados para a en-US localidade. Para baixar a ajuda em inglês, execute Update-Help com o parâmetro UICulture e especifique a en-US localidade.
Exemplo 4: Atualizar ficheiros de ajuda em vários computadores a partir de uma partilha de ficheiros
Neste exemplo, os arquivos de ajuda atualizados são baixados da Internet e salvos em um compartilhamento de arquivos. São necessárias credenciais de utilizador com permissões para aceder à partilha de ficheiros e instalar atualizações. Quando um compartilhamento de arquivos é usado, é possível atualizar computadores que estão protegidos por firewalls ou 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 suportam a 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 Credential especifica um usuário que pode acessar o compartilhamento de arquivos e executar o comando remoto Update-Help .
Exemplo 5: Obter uma lista de ficheiros de ajuda atualizados
O Update-Help cmdlet atualiza a ajuda para um módulo especificado. O cmdlet usa o parâmetro Verbose common para exibir a lista de arquivos de ajuda que foram atualizados. Você pode usar o 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 suportam a Ajuda Atualizável
Este exemplo lista os módulos que suportam a Ajuda Atualizável. O comando usa a propriedade HelpInfoUri do módulo para identificar módulos que suportam a Ajuda atualizável. A propriedade HelpInfoUri contém uma URL que é redirecionada 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: Inventário de arquivos de ajuda atualizados
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 suportam a Ajuda atualizável usando a propriedade HelpInfoUri dos módulos. Para módulos que suportam a Ajuda Atualizável, o script procura e analisa o arquivo de informações de ajuda (*helpinfo.xml) para encontrar o número da versão mais recente.
O script utiliza a classe PSCustomObject e uma tabela hash para criar um objeto de saída personalizado.
# Get-UpdateHelpVersion.ps1
Param(
[parameter(Mandatory=$False)]
[String[]]
$Module
)
$HelpInfoNamespace = @{helpInfo='http://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 a 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 escrever um nome de utilizador, ser-lhe-á pedido que introduza a palavra-passe.
As credenciais são armazenadas em um objeto PSCredential e a senha é armazenada como um SecureString.
Nota
Para obter mais informações sobre a proteção de dados do SecureString , consulte Quão seguro é o 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 , inclua 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
O valor pode ser um nome de módulo, uma especificação de módulo completo ou um caminho para um arquivo de módulo.
Quando o valor é um caminho, o caminho pode ser totalmente qualificado ou relativo. Um caminho relativo é resolvido em relação ao script que contém a instrução using.
Quando o valor é um nome ou especificação de módulo, o PowerShell procura o módulo especificado no PSModulePath .
Uma especificação de módulo é uma hashtable que tem as seguintes chaves.
ModuleName- Obrigatório Especifica o nome do módulo.GUID- Opcional Especifica o GUID do módulo.- Também é necessário especificar pelo menos uma das três chaves abaixo.
ModuleVersion- Especifica uma versão mínima aceitável do módulo.MaximumVersion- Especifica a versão máxima aceitável do módulo.RequiredVersion- Especifica uma versão exata e obrigatória do módulo. Isso não pode ser usado com as outras chaves de versão.
Não é possível 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 este parâmetro ou SourcePath se tiver usado o Save-Help cmdlet para baixar arquivos de ajuda para um diretório.
Você pode canalizar um objeto de diretório, como dos cmdlets ou Get-ChildItem para Update-Help.Get-Item
Ao contrário do valor de SourcePath, o valor de LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como caracteres curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. 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
Ajuda de atualizações 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 liste um nome de módulo em cada linha. Caracteres curinga são permitidos. Você pode canalizar módulos do Get-Module cmdlet para o Update-Help cmdlet.
Os módulos especificados devem ser instalados no computador, mas não precisam ser importados para a sessão atual. Você pode especificar qualquer módulo na sessão ou qualquer módulo instalado em um local listado $env:PSModulePath na variável de ambiente.
Um valor de (todas) as tentativas de * atualizar a ajuda para todos os módulos instalados no computador.
Os módulos que não suportam a Ajuda Atualizável estão incluídos. Esse valor pode gerar erros quando o comando encontra módulos que não suportam a 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 de 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 onde a ajuda é atualizada. As atualizações no escopo 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. AllUsers pode ser especificado para instalar ou atualizar a ajuda para todos os usuários. Em sistemas sudo Unix 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 os arquivos de ajuda são atualizados, em vez de baixá-los da Internet. Insira o caminho de uma pasta. Não especifique um nome de arquivo ou extensão de nome de arquivo. Você pode canalizar uma pasta, como uma dos Get-Item cmdlets ou Get-ChildItem para Update-Help.
Por padrão, Update-Help baixa arquivos de ajuda atualizados da Internet. Use SourcePath quando tiver usado o Save-Help cmdlet para baixar arquivos de ajuda atualizados para um diretório.
Para especificar um valor padrão para SourcePath, vá para Diretiva de Grupo, Configuração do Computador e Defina o caminho de origem padrão para Update-Help. Esta definição de Política de Grupo impede que os utilizadores utilizem Update-Help para transferir ficheiros de ajuda da Internet.
Para obter mais informações, veja 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 para os quais esse cmdlet obtém arquivos de ajuda atualizados. Insira um ou mais códigos de idioma, 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.
Por padrão, Update-Help obtém arquivos de ajuda no conjunto de cultura da interface do usuário para o sistema operacional ou sua cultura de fallback. Se você especificar o parâmetro UICulture , Update-Help procurará apenas ajuda para o idioma especificado.
A partir do PowerShell 7.4, você pode usar um código de idioma parcial, como en para baixar a ajuda em inglês para qualquer região.
Nota
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 suportada, como en-US. Isso pode ocorrer em qualquer plataforma que use um valor sem suporte.
| 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ó é efetivo quando o download da Web usa NT LAN Manager (NTLM), negociar ou autenticação baseada em Kerberos.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Apresenta o que aconteceria mediante a execução do cmdlet. 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 objeto de caminho de diretório para esse cmdlet.
Você pode canalizar um objeto de módulo para este cmdlet.
Saídas
None
Este cmdlet não retorna nenhuma saída.
Notas
Para atualizar a ajuda para os módulos principais do PowerShell, 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 principais do PowerShell, os comandos instalados junto com o PowerShell e para os $PSHOME\Modules módulos na pasta. Se não tiver permissão para atualizar os ficheiros de ajuda, pode ler os ficheiros de ajuda online. Por exemplo, Get-Help Update-Help -Online.
Os módulos são a menor unidade de ajuda atualizável. Não é possível 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 module, o cmdlet pode instalar o Update-Help 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.
O Update-Help cmdlet foi introduzido no Windows PowerShell 3.0. Ele não funciona em versões anteriores do PowerShell. Em computadores com Windows PowerShell 2.0 e Windows PowerShell 3.0, use o cmdlet em uma sessão do Update-Help Windows PowerShell 3.0 para baixar e atualizar arquivos de ajuda. Os arquivos de ajuda estão disponíveis para o Windows PowerShell 2.0 e o Windows PowerShell 3.0.
Os Update-Help cmdlets e Save-Help usam as seguintes portas para baixar arquivos de ajuda: Porta 80 para HTTP e porta 443 para HTTPS.
Update-Help suporta todos os módulos e os principais snap-ins do PowerShell. Não suporta quaisquer outros snap-ins.
Para atualizar a ajuda para um módulo em um local que não está listado $env:PSModulePath na variável de 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 Update-Help cmdlets e Save-Help não aceita o caminho completo de um arquivo de módulo ou arquivo de manifesto de módulo.
Qualquer módulo pode suportar a Ajuda Atualizável. Para obter instruções sobre como dar suporte à Ajuda Atualizável nos módulos criados, consulte Suporte à Ajuda Atualizável.
Os Update-Help cmdlets e Save-Help não são suportados no Ambiente de Pré-instalação do Windows (Windows PE).
Ligações Relacionadas
Comentários
Brevemente: Ao longo de 2024, vamos descontinuar progressivamente o GitHub Issues como mecanismo de feedback para conteúdos e substituí-lo por um novo sistema de feedback. Para obter mais informações, veja: https://aka.ms/ContentUserFeedback.
Submeter e ver comentários