Update-Help
Télécharge et installe les fichiers d’aide les plus récents sur votre ordinateur.
Syntaxe
Path (Par défaut)
Update-Help
[[-Module] <String[]>]
[[-SourcePath] <String[]>]
[[-UICulture] <CultureInfo[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-Recurse]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
LiteralPath
Update-Help
[[-Module] <String[]>]
[[-UICulture] <CultureInfo[]>]
[-FullyQualifiedModule <ModuleSpecification[]>]
[-LiteralPath <String[]>]
[-Recurse]
[-Credential <PSCredential>]
[-UseDefaultCredentials]
[-Force]
[-Scope <UpdateHelpScope>]
[-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 que la modification soit effective. 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 qui prennent en charge l’aide pouvant être mise à jour et sont chargés dans la session ou installés dans un emplacement inclus dans le $Env:PSModulePath. Pour plus d’informations, voir about_Updatable_Help.
Update-Help vérifie la version de l’aide installée. Si Update-Help vous ne trouvez pas les fichiers d’aide mis à jour pour un module, il continue en mode silencieux sans afficher de message d’erreur. Utilisez le paramètre Force pour ignorer la vérification de version. Utilisez le paramètre Verbose pour afficher les détails de l’état et de la progression. Utilisez le paramètre Module pour mettre à jour les fichiers d’aide d’un module particulier.
Vous pouvez également utiliser Update-Help sur des ordinateurs qui ne sont pas connectés à Internet. Tout d’abord, utilisez l’applet Save-Helpde commande pour télécharger des fichiers d’aide à partir d’Internet et enregistrez-les dans un dossier partagé accessible au système qui n’est pas connecté à Internet. Utilisez ensuite le paramètre SourcePath pour Update-Help télécharger les fichiers d’aide mis à jour à partir du partage et les installer sur l’ordinateur.
L’applet de commande Update-Help a été introduite dans Windows PowerShell 3.0.
Important
Update-Help nécessite des privilèges d’administration dans PowerShell 6.0 et versions ultérieures. PowerShell 6.1 et versions ultérieures définissent l’étendue par défaut sur CurrentUser. Avant PowerShell 6.1, le paramètre Scope n’était pas disponible.
Vous devez être membre du groupe Administrateurs sur l’ordinateur pour mettre à jour les fichiers d’aide pour les modules PowerShell principaux.
Pour télécharger ou mettre à jour les fichiers d’aide pour les modules dans le répertoire d’installation de PowerShell ($PSHOME\Modulesy compris les modules PowerShell Core), démarrez PowerShell à l’aide de l’option Exécuter en tant qu’administrateur . Par exemple : Start-Process pwsh.exe -Verb RunAs.
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 : Mise à jour de l’aide sur un système qui n’est pas définie sur les paramètres régionaux en-US
L’applet de commande est conçue pour télécharger de l’aide Update-Help dans plusieurs langues. Toutefois, lorsqu’aucune aide n’est disponible pour la langue utilisée par votre système, un message d’erreur s’affiche pour la culture du module et de l’interface utilisateur.
Dans cet exemple, Update-Help est exécuté sur un système défini sur les en-GB paramètres régionaux.
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.
Les fichiers d’aide sont toujours publiés pour les en-US paramètres régionaux. Pour télécharger l’aide anglaise, exécutez Update-Help avec le paramètre UICulture et spécifiez les en-US paramètres régionaux.
Exemple 4 : 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.
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
}
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 Update-Help commande et utilise le paramètre SourcePath pour spécifier le partage de fichiers contenant 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 5 : 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é
Update-Help -Module Microsoft.PowerShell.Utility -Verbose
Exemple 6 : 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 URL redirigée lors de l’exécution de l’applet Update-Help de commande.
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 7 : Inventaire des fichiers d’aide mis à jour
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
# 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
Paramètres
-Confirm
Vous invite à confirmer avant d’exécuter l’applet de commande.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | cf |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | 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.
Tapez un nom d’utilisateur, tel que User01 ou Domain01\User01, ou entrez un objet PSCredential généré par l’applet de commande Get-Credential. Si vous tapez un nom d’utilisateur, vous êtes invité à entrer le mot de passe.
Les informations d’identification sont stockées dans un objet PSCredential et le mot de passe est stocké en tant que SecureString.
Remarque
Pour plus d’informations sur la protection des données de SecureString, consultez Quelle est la sécurité de SecureString ?.
Propriétés du paramètre
| Type: | PSCredential |
| Valeur par défaut: | Current user |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | 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
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-FullyQualifiedModule
La valeur peut être un nom de module, une spécification complète du module ou un chemin d’accès à un fichier de module.
Lorsque la valeur est un chemin d’accès, le chemin d’accès peut être qualifié ou relatif complet. Un chemin relatif est résolu par rapport au script qui contient l’instruction using.
Lorsque la valeur est un nom ou une spécification de module, PowerShell recherche le PSModulePath pour le module spécifié.
Une spécification de module est une table de hachage qui a les clés suivantes.
-
ModuleName- Obligatoire Spécifie le nom du module. -
GUID- facultatif spécifie le GUID du module. - Il est également obligatoire pour spécifier au moins l’une des trois clés ci-dessous.
-
ModuleVersion: spécifie une version minimale acceptable du module. -
MaximumVersion: spécifie la version maximale acceptable du module. -
RequiredVersion: spécifie une version exacte et requise du module. Cela ne peut pas être utilisé avec les autres clés de version.
-
Vous ne pouvez pas spécifier le paramètre FullyQualifiedModule dans la même commande qu’un paramètre Module.
Propriétés du paramètre
| Type: | |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | 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é en tant que caractère générique. Si le chemin d’accès inclut des caractères d’échappement, mettez-le entre des guillemets simples. Les guillemets simples indiquent à PowerShell de ne pas interpréter de caractères comme séquences d’échappement.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | PSPath, DP |
Jeux de paramètres
LiteralPath
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | 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 tout module installé dans un emplacement répertorié dans la $Env:PSModulePath variable d’environnement.
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 Update-Help de commande n’accepte pas le chemin d’accès 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.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | True |
| DontShow: | False |
| Alias: | Nom |
Jeux de paramètres
(All)
| Position: | 0 |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-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.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Scope
Spécifie l’étendue du système dans laquelle l’aide est mise à jour. Les mises à jour dans l’étendue AllUsers nécessitent des privilèges d’administration sur les systèmes Windows. Le -Scope paramètre a été introduit dans PowerShell Core version 6.1.
CurrentUser est l’étendue par défaut des fichiers d’aide dans PowerShell 6.1 et versions ultérieures.
AllUsers peut être spécifié pour installer ou mettre à jour de l’aide pour tous les utilisateurs. Sur les privilèges des systèmes sudo Unix, vous devez mettre à jour l’aide de tous les utilisateurs. Par exemple : sudo pwsh -c Update-Help
Les valeurs acceptables sont les suivantes :
- Utilisateur actuel
- AllUsers
Propriétés du paramètre
| Type: | UpdateHelpScope |
| Valeur par défaut: | CurrentUser |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | 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.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | Chemin |
Jeux de paramètres
Path
| Position: | 1 |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-UICulture
Spécifie les valeurs de culture de l’interface utilisateur pour lesquelles cette applet de commande obtient les 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’un Get-Culture ou une commande Get-UICulture. Les caractères génériques ne sont pas autorisés.
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 ou sa culture de secours. Si vous spécifiez le paramètre UICulture, Update-Help recherche uniquement de l’aide pour la langue spécifiée.
À compter de PowerShell 7.4, vous pouvez utiliser un code de langue partiel, tel que en télécharger de l’aide en anglais pour n’importe quelle région.
Remarque
Ubuntu 18.04 a modifié le paramètre C.UTF.8de paramètres régionaux par défaut , ce qui n’est pas une culture d’interface utilisateur reconnue.
Update-Help Ne parvient pas à télécharger l’aide, sauf si vous utilisez ce paramètre avec des paramètres régionaux pris en charge comme en-US. Cela peut se produire sur n’importe quelle plateforme qui utilise une valeur non prise en charge.
Propriétés du paramètre
| Type: | |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | 2 |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-UseDefaultCredentials
Indique qu’elle 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.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | 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.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | Wi |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
Entrées
DirectoryInfo
Vous pouvez diriger un objet de chemin d’accès au répertoire vers cette applet de commande.
PSModuleInfo
Vous pouvez diriger un objet de module vers cette applet de commande.
Sorties
None
Cette applet de commande ne retourne aucune sortie.
Notes
Pour mettre à jour l’aide des modules PowerShell principaux, qui contiennent les commandes installées avec PowerShell ou tout module du $PSHOME\Modules répertoire, démarrez PowerShell avec l’option Exécuter en tant qu’administrateur.
Seuls les membres du groupe Administrateurs sur l’ordinateur peuvent mettre à jour l’aide pour les modules PowerShell principaux, les commandes installées avec PowerShell et pour les modules du $PSHOME\Modules dossier. 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 contenant une applet de commande particulière, utilisez la propriété ModuleName de l’applet Get-Command de commande, 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.
L’applet de commande Update-Help a été introduite dans Windows PowerShell 3.0. Elle ne fonctionne pas dans les versions antérieures de 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 principaux. 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 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).
