Partager via

Import-YamlCommandHelp

Module:
Microsoft.PowerShell.PlatyPS Module

Importe du contenu d’aide Yaml dans objets CommandHelp.

Syntaxe

Path (Par défaut) 

Import-YamlCommandHelp
    [-Path] <string[]>
    [-AsDictionary]
    [<CommonParameters>]

LiteralPath 

Import-YamlCommandHelp
    -LiteralPath <string[]>
    [-AsDictionary]
    [<CommonParameters>]

Description

La commande importe des fichiers Yaml contenant de l’aide de commande et crée objets CommandHelp. L’objet CommandHelp est une représentation structurée du contenu d’aide qui peut être utilisé pour exporter vers différents formats.

Exemples

Exemple 1 - Importer tous les fichiers Yaml d’applet de commande dans un dossier

L’exemple suivant importe les fichiers Markdown de l’applet de commande dans un dossier et les convertit en objets CommandHelp. Ces objets peuvent être utilisés pour exporter vers différents formats.

Import-YamlCommandHelp -Path .\v2\yaml\*-*.yml | Select-Object Title

Title
-----
Compare-CommandHelp
Export-MamlCommandHelp
Export-MarkdownCommandHelp
Export-MarkdownModuleFile
Export-YamlCommandHelp
Export-YamlModuleFile
Import-MamlHelp
Import-MarkdownCommandHelp
Import-MarkdownModuleFile
Import-YamlCommandHelp
Import-YamlModuleFile
Measure-PlatyPSMarkdown
New-CommandHelp
New-MarkdownCommandHelp
New-MarkdownModuleFile
Test-MarkdownCommandHelp
Update-CommandHelp
Update-MarkdownCommandHelp
Update-MarkdownModuleFile

Paramètres

-AsDictionary

Par défaut, cette applet de commande retourne objets CommandHelp. Lorsque vous utilisez ce paramètre. l’applet de commande retourne les mêmes informations qu’un objet OrderedDictionary.

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

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

-LiteralPath

Spécifie un chemin d’accès à un ou plusieurs fichiers de commande Yaml. La valeur de LiteralPath est utilisée exactement comme elle est typée. 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.

Pour plus d'informations, consultez la section sur les règles de citation.

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:True
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Path

Chemin d’accès au fichier de commande Yaml. Spécifie un chemin d’accès à un ou plusieurs emplacements.

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 complet

Jeux de paramètres

Path
Position:0
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
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

String

Sorties

OrderedDictionary

Cette applet de commande retourne un objet OrderedDictionary lorsque vous utilisez le paramètre AsDictionary.

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Par défaut, cette applet de commande retourne objets CommandHelp.