Import-YamlModuleFile
Hiermee importeert u een Yaml-modulebestand in een ModuleHelp-object.
Syntaxis
Path (Standaard)
Import-YamlModuleFile
[-Path] <string[]>
[-AsDictionary]
[<CommonParameters>]
LiteralPath
Import-YamlModuleFile
-LiteralPath <string[]>
[-AsDictionary]
[<CommonParameters>]
Description
Met de opdracht importeert u Yaml-bestanden met modulehulp en maakt u ModuleHelp-objecten. Het ModuleHelp-object is een gestructureerde weergave van de Help-inhoud die kan worden gebruikt voor het exporteren naar verschillende indelingen.
Voorbeelden
Voorbeeld 1: een Yaml-modulebestand importeren in een **ModuleHelp**-object
Import-YamlModuleFile .\v2\yaml\Microsoft.PowerShell.PlatyPS.yml
Metadata : {[document type, module], [HelpInfoUri, ], [Locale, en-US], [Module Guid,
0bdcabef-a4b7-4a6d-bf7e-d879817ebbff]…}
Title : Microsoft.PowerShell.PlatyPS Module
Module : Microsoft.PowerShell.PlatyPS
ModuleGuid : 0bdcabef-a4b7-4a6d-bf7e-d879817ebbff
Description : This module contains cmdlets to help with the creation help content for PowerShell commands.
Locale : en-US
CommandGroups : {Microsoft.PowerShell.PlatyPS.ModuleCommandGroup}
Diagnostics : Microsoft.PowerShell.PlatyPS.Model.Diagnostics
Parameters
-AsDictionary
De opdracht retourneert standaard een ModuleHelp--object. Wanneer u deze parameter gebruikt, retourneert de opdracht de ModuleHelp gegevens een woordenlijstobject.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | False |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-LiteralPath
Hiermee geeft u een pad naar een of meer Yaml-modulebestanden. De waarde van LiteralPath- wordt precies gebruikt zoals deze is getypt. Er worden geen tekens geïnterpreteerd als jokertekens. Als het pad escape-tekens bevat, zet het dan tussen enkele aanhalingstekens. Enkele aanhalingstekens zorgen ervoor dat PowerShell geen tekens als escapesequenties interpreteert.
Zie about_Quoting_Rulesvoor meer informatie.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
| Aliassen: | PSPath, LP |
Parametersets
LiteralPath
| Position: | Named |
| Verplicht: | True |
| Waarde uit pijplijn: | True |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Path
Hiermee geeft u een pad naar een of meer locaties met Yaml-modulebestanden.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | True |
| DontShow: | False |
Parametersets
Path
| Position: | 0 |
| Verplicht: | True |
| Waarde uit pijplijn: | True |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
CommonParameters
Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.