Update-Help

Référence

Module:: Microsoft.PowerShell.Core

Télécharge et installe les fichiers d’aide les plus récents sur votre ordinateur.

Syntaxe

Update-Help
      [[-Module] <String[]>]
      [-FullyQualifiedModule <ModuleSpecification[]>]
      [[-SourcePath] <String[]>]
      [-Recurse]
      [[-UICulture] <CultureInfo[]>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Update-Help
      [[-Module] <String[]>]
      [-FullyQualifiedModule <ModuleSpecification[]>]
      [-LiteralPath <String[]>]
      [-Recurse]
      [[-UICulture] <CultureInfo[]>]
      [-Credential <PSCredential>]
      [-UseDefaultCredentials]
      [-Force]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

L’applet de commande Update-Help télécharge les fichiers d’aide les plus récents pour les modules PowerShell et les installe sur votre ordinateur. Vous n’avez pas besoin de redémarrer PowerShell pour effectuer la modification. Vous pouvez utiliser l’applet de commande Get-Help pour afficher immédiatement les nouveaux fichiers d’aide.

Update-Help vérifie la version des fichiers d’aide sur votre ordinateur. Si vous n’avez pas de fichiers d’aide pour un module ou si vos fichiers d’aide sont obsolètes, Update-Help télécharge les fichiers d’aide les plus récents. Les fichiers d’aide peuvent être téléchargés et installés à partir d’Internet ou d’un partage de fichiers.

Sans paramètres, Update-Help met à jour les fichiers d’aide pour les modules de la session et pour tous les modules installés qui prennent en charge l’aide pouvant être mise à jour. Les modules installés mais non chargés dans la session active sont inclus. Les modules PowerShell sont stockés dans un emplacement répertorié dans la variable d’environnement $env:PSModulePath. Pour plus d’informations, consultez about_Updatable_Help.

Vous pouvez utiliser le paramètre Module pour mettre à jour les fichiers d’aide d’un module particulier. Utilisez le paramètre UICulture pour télécharger des fichiers d’aide dans plusieurs langues et paramètres régionaux.

Vous pouvez utiliser Update-Help sur les ordinateurs qui ne sont pas connectés à Internet. Utilisez l’applet de commande Save-Help pour télécharger des fichiers d’aide à partir d’Internet et les enregistrer dans un emplacement de système de fichiers, tel qu’un dossier partagé ou un répertoire de système de fichiers. Utilisez ensuite le paramètre SourcePath de Update-Help pour télécharger les fichiers d’aide mis à jour à partir d’un emplacement de système de fichiers et les installer sur l’ordinateur.

Vous pouvez automatiser les mises à jour d’aide en ajoutant l’applet de commande Update-Help à votre profil PowerShell. Par défaut, Update-Help n’exécute qu’une seule fois par jour sur chaque ordinateur. Pour remplacer la limite une fois par jour, utilisez le paramètre Forcer.

L’applet de commande Update-Help a été introduite dans Windows PowerShell 3.0.

Important

Update-Help nécessite des privilèges d’administration.

Vous devez être membre du groupe Administrateurs sur l’ordinateur pour mettre à jour les fichiers d’aide des modules PowerShell Core.

Pour télécharger ou mettre à jour les fichiers d’aide pour les modules dans le répertoire d’installation de PowerShell ($PSHOME\Modules), y compris les modules PowerShell Core, démarrez PowerShell à l’aide de l’option Exécuter en tant qu’administrateur. Par exemple : Start-Process powershell.exe -Verb RunAs.

Vous pouvez également mettre à jour les fichiers d’aide à l’aide de l’élément de menu Mettre à jour windows PowerShell Help dans le menu Aide dans l’environnement de script intégré Windows PowerShell (ISE).

L’élément d’aide De Windows PowerShell Update exécute une applet de commande Update-Help sans paramètres. Pour mettre à jour l’aide des modules dans le répertoire $PSHOME, démarrez Windows PowerShell ISE à l’aide de l’option Exécuter en tant qu’administrateur.

Exemples

Exemple 1 : Mettre à jour les fichiers d’aide pour tous les modules

La Update-Help applet de commande met à jour les fichiers d’aide pour les modules installés qui prennent en charge l’aide pouvant être mise à jour. Le langage de culture de l’interface utilisateur est défini dans le système d’exploitation.

Update-Help

Exemple 2 : Mettre à jour les fichiers d’aide pour les modules spécifiés

L’applet de commande Update-Help met à jour les fichiers d’aide uniquement pour les noms de modules commençant par Microsoft.PowerShell.

Update-Help -Module Microsoft.PowerShell*

Exemple 3 : Mettre à jour les fichiers d’aide pour différentes langues

L’applet de commande Update-Help met à jour les fichiers d’aide japonais (ja-JP) et anglais (en-US) pour tous les modules.

Si un module ne fournit pas de fichiers d’aide pour une culture d’interface utilisateur spécifiée, un message d’erreur s’affiche pour le module et la culture de l’interface utilisateur. Dans cet exemple, le message d’erreur indique que les fichiers d’aide ja-JP n’ont pas été trouvés pour le module 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.

Exemple 4 : Mettre à jour automatiquement les fichiers d’aide

Cet exemple crée un travail planifié qui met à jour l’aide de tous les modules tous les jours à 3h00.

$jobParams = @{
  Name = 'UpdateHelpJob'
  Credential = 'Domain01\User01'
  ScriptBlock = '{Update-Help}'
  Trigger = (New-JobTrigger -Daily -At "3 AM")
}
Register-ScheduledJob @jobParams

Id         Name            JobTriggers     Command                                  Enabled
--         ----            -----------     -------                                  -------
1          UpdateHelpJob   1               Update-Help                              True

L’applet de commande Register-ScheduledJob crée un travail planifié qui exécute une commande Update-Help. La commande utilise le paramètre Credential pour exécuter Update-Help à l’aide des informations d’identification d’un membre du groupe Administrateurs sur l’ordinateur. La valeur du paramètre Déclencheur est une commande New-JobTrigger qui crée un déclencheur de travail qui démarre le travail tous les jours à 3h00.

Pour exécuter la commande Register-ScheduledJob, démarrez PowerShell à l’aide de l’option Exécuter en tant qu’administrateur. PowerShell vous invite à entrer le mot de passe de l’utilisateur spécifié dans le paramètre Credential . Les informations d’identification sont stockées avec le travail planifié. Vous n’êtes pas invité à exécuter le travail.

Vous pouvez utiliser l’applet de commande Get-ScheduledJob pour afficher le travail planifié, utiliser l’applet de commande Set-ScheduledJob pour la modifier et utiliser l’applet de commande Unregister-ScheduledJob pour la supprimer. Vous pouvez également afficher et gérer le travail planifié dans le Planificateur de tâches dans le chemin d’accès suivant :

Task Scheduler Library\Microsoft\Windows\PowerShell\ScheduledJobs.

Exemple 5 : Mettre à jour les fichiers d’aide sur plusieurs ordinateurs à partir d’un partage de fichiers

Dans cet exemple, les fichiers d’aide mis à jour sont téléchargés à partir d’Internet et enregistrés dans un partage de fichiers. Les informations d’identification de l’utilisateur sont nécessaires pour accéder au partage de fichiers et installer les mises à jour. Lorsqu’un partage de fichiers est utilisé, il est possible de mettre à jour des ordinateurs derrière des pare-feu ou qui ne sont pas connectés à Internet.

PS> Save-Help -DestinationPath \\Server01\Share\PSHelp -Credential Domain01\Admin01
PS> Invoke-Command -ComputerName (Get-Content Servers.txt) -ScriptBlock {
     Update-Help -SourcePath \\Server01\Share\PSHelp -Credential Domain01\Admin01
}

La commande Save-Help télécharge les fichiers d’aide les plus récents pour tous les modules qui prennent en charge l’aide pouvant être mise à jour. Le paramètre DestinationPath enregistre les fichiers dans le partage de fichiers \\Server01\Share\PSHelp. Le paramètre Credential spécifie un utilisateur autorisé à accéder au partage de fichiers.

L’applet de commande Invoke-Command exécute des commandes de Update-Help distantes sur plusieurs ordinateurs. Le paramètre ComputerName obtient la liste des ordinateurs distants à partir du fichier Servers.txt. Le paramètre ScriptBlock exécute la commande Update-Help et utilise le paramètre SourcePath pour spécifier le partage de fichiers qui contient les fichiers d’aide mis à jour. Le paramètre Credential spécifie un utilisateur qui peut accéder au partage de fichiers et exécuter la commande Update-Help distante.

Exemple 6 : Obtenir la liste des fichiers d’aide mis à jour

La Update-Help aide sur les mises à jour de l’applet de commande pour un module spécifié. L’applet de commande utilise le Verbose paramètre commun pour afficher la liste des fichiers d’aide mis à jour. Vous pouvez utiliser détaillé pour afficher la sortie de tous les fichiers d’aide ou fichiers d’aide pour un module spécifique.

Sans le paramètre Verbose, Update-Help n’affiche pas les résultats de la commande. La sortie du paramètre détaillé est utile pour vérifier que les fichiers d’aide ont été mis à jour ou si la dernière version est installée.

Update-Help -Module Microsoft.PowerShell.Utility -Verbose

Exemple 7 : Rechercher des modules qui prennent en charge l’aide pouvant être mise à jour

Cet exemple répertorie les modules qui prennent en charge l’aide pouvant être mise à jour. La commande utilise la propriété HelpInfoUri du module pour identifier les modules qui prennent en charge l’aide pouvant être mise à jour. La propriété HelpInfoUri contient une adresse redirigée lorsque l’applet de commande Update-Help est exécutée.

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, ... }

Exemple 8 : Fichiers d’aide mis à jour de l’inventaire

Dans cet exemple, le script Get-UpdateHelpVersion.ps1 crée un inventaire des fichiers d’aide pouvant être mis à jour pour chaque module et leurs numéros de version.

Le script identifie les modules qui prennent en charge l’aide pouvant être mise à jour à l’aide de la propriété HelpInfoUri des modules. Pour les modules qui prennent en charge l’aide pouvant être mise à jour, le script recherche et analyse le fichier d’informations d’aide (*helpinfo.xml) pour trouver le numéro de version le plus récent.

Le script utilise la classe PSCustomObject et une table de hachage pour créer un objet de sortie personnalisé.

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

Paramètres

-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 les informations d’identification d’un utilisateur autorisé à accéder à l’emplacement du système de fichiers spécifié par SourcePath. Ce paramètre est valide uniquement lorsque le paramètre SourcePath ou LiteralPath est utilisé dans la commande.

Le paramètre Credential vous permet d’exécuter des commandes Update-Help avec le paramètre SourcePath sur les ordinateurs distants. En fournissant des informations d’identification explicites, vous pouvez exécuter la commande sur un ordinateur distant et accéder à un partage de fichiers sur un troisième ordinateur sans rencontrer d’erreur d’accès refusé ou utiliser l’authentification CredSSP pour déléguer les informations d’identification.

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

-Force

Indique que cette applet de commande ne suit pas la limitation une fois par jour, ignore la vérification des versions et télécharge les fichiers qui dépassent la limite de 1 Go.

Sans ce paramètre, Update-Help s’exécute une seule fois sur chaque période de 24 heures. Les téléchargements sont limités à 1 Go de contenu non compressé par module et les fichiers d’aide sont installés uniquement lorsqu’ils sont plus récents que les fichiers existants sur l’ordinateur.

La limite une fois par jour protège les serveurs qui hébergent les fichiers d’aide et vous permet d’ajouter une commande Update-Help à votre profil PowerShell sans entraîner le coût des ressources des connexions répétées ou des téléchargements.

Pour mettre à jour l’aide d’un module dans plusieurs cultures d’interface utilisateur sans le paramètre Forcer, incluez toutes les cultures d’interface utilisateur dans la même commande, par exemple :

Update-Help -Module PSScheduledJobs -UICulture en-US, fr-FR, pt-BR

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

-FullyQualifiedModule

Spécifie les modules avec des noms spécifiés sous la forme d’objets ModuleSpecification. Ces modules sont décrits dans la section Notes de ModuleSpecification Constructor (Hashtable).

Par exemple, le paramètre FullyQualifiedModule accepte un nom de module spécifié au format :

@{ModuleName = "modulename"; ModuleVersion = "version_number"}

@{ModuleName = "modulename"; ModuleVersion = "version_number"; Guid = "GUID"}.

moduleName et ModuleVersion sont obligatoires, mais Guid est facultatif.

Vous ne pouvez pas spécifier le paramètre FullyQualifiedModule dans la même commande qu’un paramètre Module.

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

-LiteralPath

Spécifie le dossier des fichiers d’aide mis à jour au lieu de les télécharger à partir d’Internet. Utilisez ce paramètre ou SourcePath si vous avez utilisé l’applet de commande Save-Help pour télécharger des fichiers d’aide dans un répertoire.

Vous pouvez pipeliner un objet de répertoire, tel que des applets de commande Get-Item ou Get-ChildItem, vers Update-Help.

Contrairement à la valeur de SourcePath, la valeur de LiteralPath est utilisée exactement comme typé. Aucun caractère n’est interprété comme des caractères génériques. Si le chemin inclut des caractères d’échappement, placez-le entre guillemets simples. Les guillemets simples indiquent à PowerShell de ne pas interpréter de caractères comme séquences d’échappement.

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

-Module

Aide sur les mises à jour pour les modules spécifiés. Entrez un ou plusieurs noms de module ou modèles de nom dans une liste séparée par des virgules, ou spécifiez un fichier qui répertorie un nom de module sur chaque ligne. Les caractères génériques sont autorisés. Vous pouvez pipeliner des modules de l’applet de commande Get-Module vers l’applet de commande Update-Help.

Les modules que vous spécifiez doivent être installés sur l’ordinateur, mais ils ne doivent pas être importés dans la session active. Vous pouvez spécifier n’importe quel module dans la session ou n’importe quel module installé dans un emplacement répertorié dans la variable d’environnement $env:PSModulePath.

Valeur de * (tous) tente de mettre à jour l’aide pour tous les modules installés sur l’ordinateur. Les modules qui ne prennent pas en charge l’aide pouvant être mise à jour sont inclus. Cette valeur peut générer des erreurs lorsque la commande rencontre des modules qui ne prennent pas en charge l’aide pouvant être mise à jour. Au lieu de cela, exécutez Update-Help sans paramètres.

Le paramètre module de l’applet de commande Update-Help n’accepte pas le chemin complet d’un fichier de module ou d’un fichier manifeste de module. Pour mettre à jour l’aide d’un module qui n’est pas dans un emplacement $env:PSModulePath, importez le module dans la session active avant d’exécuter la commande Update-Help.

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

-Recurse

Effectue une recherche récursive pour les fichiers d’aide dans le répertoire spécifié. Ce paramètre est valide uniquement lorsque la commande utilise le paramètre SourcePath.

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

-SourcePath

Spécifie un dossier de système de fichiers dans lequel Update-Help obtient des fichiers d’aide mis à jour, au lieu de les télécharger à partir d’Internet. Entrez le chemin d’accès d’un dossier. Ne spécifiez pas de nom de fichier ou d’extension de nom de fichier. Vous pouvez pipeliner un dossier, tel qu’un des applets de commande Get-Item ou Get-ChildItem, vers Update-Help.

Par défaut, Update-Help télécharge les fichiers d’aide mis à jour à partir d’Internet. Utilisez SourcePath lorsque vous avez utilisé l’applet de commande Save-Help pour télécharger les fichiers d’aide mis à jour dans un répertoire.

Pour spécifier une valeur par défaut pour SourcePath, accédez à stratégie de groupe, configuration ordinateuret définir le chemin d’accès source par défaut pour leUpdate-Help . Ce paramètre de stratégie de groupe empêche les utilisateurs d’utiliser Update-Help pour télécharger des fichiers d’aide à partir d’Internet. Pour plus d’informations, consultez about_Group_Policy_Settings.

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

-UICulture

Spécifie les valeurs de culture de l’interface utilisateur que Update-Help utilise pour obtenir des fichiers d’aide mis à jour. Entrez un ou plusieurs codes de langage, tels que es-ES, une variable qui contient des objets de culture ou une commande qui obtient des objets de culture, tels qu’une commande Get-Culture ou Get-UICulture. Les caractères génériques ne sont pas autorisés et vous ne pouvez pas envoyer de code de langage partiel, tel que de.

Par défaut, Update-Help obtient des fichiers d’aide dans la culture de l’interface utilisateur définie pour le système d’exploitation. Si vous spécifiez le paramètre UICulture , recherche de l’aide uniquement pour la culture d’interface utilisateur spécifiée.

Les commandes qui utilisent le paramètre UICulture réussissent uniquement lorsque le module fournit des fichiers d’aide pour la culture d’interface utilisateur spécifiée. Si la commande échoue, car la culture d’interface utilisateur spécifiée n’est pas prise en charge, un message d’erreur s’affiche.

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

-UseDefaultCredentials

Indique que Update-Help exécute la commande, y compris le téléchargement Internet, à l’aide des informations d’identification de l’utilisateur actuel. Par défaut, la commande s’exécute sans informations d’identification explicites.

Ce paramètre est effectif uniquement lorsque le téléchargement web utilise NT LAN Manager (NTLM), négocie ou authentification Kerberos.

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

-WhatIf

Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.

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

DirectoryInfo

Vous pouvez diriger un chemin d’accès au répertoire vers Update-Help.

PSModuleInfo

Vous pouvez diriger un objet de module à partir de l’applet de commande Get-Module vers Update-Help.

Sorties

None

Update-Help ne génère aucune sortie.

Notes

Pour mettre à jour l’aide des modules PowerShell Core, qui contiennent les commandes installées avec PowerShell ou tout module du répertoire $PSHOME\Modules, démarrez PowerShell avec l’option permettant de Exécuter en tant qu’administrateur.

Seuls les membres du groupe Administrateurs sur l’ordinateur peuvent mettre à jour l’aide pour les modules PowerShell Core, les commandes installées avec PowerShell et pour les modules du dossier $PSHOME\Modules. Si vous n’êtes pas autorisé à mettre à jour les fichiers d’aide, vous pouvez lire les fichiers d’aide en ligne. Par exemple, Get-Help Update-Help -Online.

Les modules sont la plus petite unité d’aide pouvant être mise à jour. Vous ne pouvez pas mettre à jour l’aide d’une applet de commande particulière. Pour rechercher le module qui contient une applet de commande particulière, utilisez la propriété ModuleName de l’applet de commande Get-Command, par exemple, (Get-Command Update-Help).ModuleName.

Étant donné que les fichiers d’aide sont installés dans le répertoire du module, l’applet de commande Update-Help peut installer le fichier d’aide mis à jour uniquement pour les modules installés sur l’ordinateur. Toutefois, l’applet de commande Save-Help peut enregistrer de l’aide pour les modules qui ne sont pas installés sur l’ordinateur.

Si Update-Help ne trouve pas les fichiers d’aide mis à jour pour un module ou si vous ne trouvez pas d’aide mise à jour dans la langue spécifiée, il continue en mode silencieux sans afficher de message d’erreur. Pour afficher les détails de l’état et de la progression, utilisez le paramètre détaillé .

L’applet de commande Update-Help a été introduite dans Windows PowerShell 3.0. Elle ne fonctionne pas dans les versions antérieures de Windows PowerShell. Sur les ordinateurs qui ont Windows PowerShell 2.0 et Windows PowerShell 3.0, utilisez l’applet de commande Update-Help dans une session Windows PowerShell 3.0 pour télécharger et mettre à jour les fichiers d’aide. Les fichiers d’aide sont disponibles pour Windows PowerShell 2.0 et Windows PowerShell 3.0.

Les applets de commande Update-Help et Save-Help utilisent les ports suivants pour télécharger les fichiers d’aide : port 80 pour HTTP et port 443 pour HTTPS.

Update-Help prend en charge tous les modules et les composants logiciels enfichables PowerShell Core. Elle ne prend pas en charge d’autres composants logiciels enfichables.

Pour mettre à jour l’aide d’un module dans un emplacement qui n’est pas répertorié dans la variable d’environnement $env:PSModulePath, importez le module dans la session active, puis exécutez une commande Update-Help. Exécutez sans paramètres ou utilisez le paramètre module pour spécifier le nom du module. Le paramètre Module des applets de commande Update-Help et Save-Help n’accepte pas le chemin complet d’un fichier de module ou d’un fichier manifeste de module.

N’importe quel module peut prendre en charge l’aide pouvant être mise à jour. Pour obtenir des instructions sur la prise en charge de l’aide pouvant être mise à jour dans les modules que vous créez, consultez Prise en charge de l’aide pouvant être mise à jour.

Les applets de commande Update-Help et Save-Help ne sont pas prises en charge sur l’environnement de préinstallation Windows (Windows PE).

Partager via

Update-Help

Syntaxe

Description

Exemples

Exemple 1 : Mettre à jour les fichiers d’aide pour tous les modules

Exemple 2 : Mettre à jour les fichiers d’aide pour les modules spécifiés

Exemple 3 : Mettre à jour les fichiers d’aide pour différentes langues

Exemple 4 : Mettre à jour automatiquement les fichiers d’aide

Exemple 5 : Mettre à jour les fichiers d’aide sur plusieurs ordinateurs à partir d’un partage de fichiers

Exemple 6 : Obtenir la liste des fichiers d’aide mis à jour

Exemple 7 : Rechercher des modules qui prennent en charge l’aide pouvant être mise à jour

Exemple 8 : Fichiers d’aide mis à jour de l’inventaire

Paramètres

-Confirm

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-SourcePath

-UICulture

-UseDefaultCredentials

-WhatIf

Entrées

Sorties

Notes

Ressources supplémentaires

Partager via

Update-Help

Syntaxe

Description

Exemples

Exemple 1 : Mettre à jour les fichiers d’aide pour tous les modules

Exemple 2 : Mettre à jour les fichiers d’aide pour les modules spécifiés

Exemple 3 : Mettre à jour les fichiers d’aide pour différentes langues

Exemple 4 : Mettre à jour automatiquement les fichiers d’aide

Exemple 5 : Mettre à jour les fichiers d’aide sur plusieurs ordinateurs à partir d’un partage de fichiers

Exemple 6 : Obtenir la liste des fichiers d’aide mis à jour

Exemple 7 : Rechercher des modules qui prennent en charge l’aide pouvant être mise à jour

Exemple 8 : Fichiers d’aide mis à jour de l’inventaire

Paramètres

-Confirm

-Credential

-Force

-FullyQualifiedModule

-LiteralPath

-Module

-Recurse

-SourcePath

-UICulture

-UseDefaultCredentials

-WhatIf

Entrées

Sorties

Notes

Liens associés

Ressources supplémentaires