Dela via

Import-YamlCommandHelp

Modul:
Microsoft.PowerShell.PlatyPS Module

Importerar Yaml-hjälpinnehåll till CommandHelp- objekt.

Syntax

Path (Standard) 

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

LiteralPath 

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

Description

Kommandot importerar Yaml-filer som innehåller kommandohjälp och skapar CommandHelp objekt. Objektet CommandHelp är en strukturerad representation av hjälpinnehållet som kan användas för att exportera till olika format.

Exempel

Exempel 1 – Importera alla yaml-cmdlet-filer i en mapp

I följande exempel importerar du markdown-filer i en mapp och konverterar dem till CommandHelp- objekt. Dessa objekt kan användas för att exportera till olika format.

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

Parametrar

-AsDictionary

Som standard returnerar den här cmdleten CommandHelp- objekt. När du använder den här parametern. cmdleten returnerar samma information som ett OrderedDictionary-objekt.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokertecken:False
DontShow:False

Parameteruppsättningar

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-LiteralPath

Anger en sökväg till en eller flera Yaml-kommandofiler. Värdet för LiteralPath används exakt som det skrivs. Inga tecken tolkas som wildcards. Om sökvägen innehåller escape-tecken omger du den med enkla citattecken. Enkla citattecken gör att PowerShell inte tolkar några tecken som escape-sekvenser.

Mer information finns i about_Quoting_Rules.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:False
DontShow:False
Alias:PSPath, SP

Parameteruppsättningar

LiteralPath
Position:Named
Obligatorisk:True
Värde från pipeline:False
Värde från pipeline efter egenskapsnamn:False
Värde från återstående argument:False

-Path

Sökvägen till Yaml-kommandofilen. Anger en sökväg till en eller flera platser.

Parameteregenskaper

Typ:

String[]

Standardvärde:None
Stöder jokertecken:True
DontShow:False
Alias:Fullständigt namn

Parameteruppsättningar

Path
Position:0
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter egenskapsnamn:True
Värde från återstående argument:False

CommonParameters

Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.

Indata

String

Utdata

OrderedDictionary

Den här cmdleten returnerar ett OrderedDictionary-objekt när du använder parametern AsDictionary.

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Som standard returnerar den här cmdleten CommandHelp- objekt.