Update-Help

Sintaxe

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.

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-Help

Exemplo 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 -Verbose

Exemplo 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.0

Parâmetros

-Confirm

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-Scope

-SourcePath

-UICulture

-UseDefaultCredentials

-WhatIf

Entradas

DirectoryInfo

Você pode canalizar um objeto de caminho de diretório para esse cmdlet.

PSModuleInfo

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

• Get-Culture
• Get-Help
• Get-Module
• Get-UICulture
• Start-Job
• Save-Help