Partilhar via

Import-YamlCommandHelp

Módulo:
Microsoft.PowerShell.PlatyPS Module

Importa conteúdo de ajuda do Yaml para objetos CommandHelp.

Sintaxe

Path (Padrão) 

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

LiteralPath 

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

Descrição

O comando importa arquivos do Yaml contendo ajuda de comando e cria objetos CommandHelp. O objeto CommandHelp é uma representação estruturada do conteúdo da ajuda que pode ser usado para exportar para diferentes formatos.

Exemplos

Exemplo 1 - Importar todos os arquivos do cmdlet Yaml em uma pasta

O exemplo a seguir importa arquivos Markdown do cmdlet em uma pasta e os converte em objetos CommandHelp. Esses objetos podem ser usados para exportar para diferentes formatos.

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

Parâmetros

-AsDictionary

Por padrão, esse cmdlet retorna objetos CommandHelp. Quando você usa esse parâmetro. o cmdlet retorna as mesmas informações que um objeto OrderedDictionary.

Propriedades dos parâmetros

Tipo:SwitchParameter
Valor padrão:False
Suporta curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Posição:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-LiteralPath

Especifica um caminho para um ou mais arquivos de comando do Yaml. O valor de LiteralPath é usado exatamente como é digitado. Nenhum caractere é interpretado como carta curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples indicam ao PowerShell para não interpretar quaisquer caracteres como sequências de escape.

Para obter mais informações, consulte about_Quoting_Rules.

Propriedades dos parâmetros

Tipo:

String[]

Valor padrão:None
Suporta curingas:False
DontShow:False
Pseudónimos:PSPath, LP

Conjuntos de parâmetros

LiteralPath
Posição:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-Path

O caminho para o arquivo de comando do Yaml. Especifica um caminho para um ou mais locais.

Propriedades dos parâmetros

Tipo:

String[]

Valor padrão:None
Suporta curingas:True
DontShow:False
Pseudónimos:Nome Completo

Conjuntos de parâmetros

Path
Posição:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome da propriedade:True
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.

Entradas

String

Saídas

OrderedDictionary

Esse cmdlet retorna um objeto OrderedDictionary quando você usa o parâmetro AsDictionary.

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Por padrão, esse cmdlet retorna objetos CommandHelp.