Partilhar via

Import-YamlModuleFile

Módulo:
Microsoft.PowerShell.PlatyPS Module

Importa um arquivo de módulo do Yaml para um objeto ModuleHelp do .

Sintaxe

Path (Padrão) 

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

LiteralPath 

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

Descrição

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

Exemplos

Exemplo 1 - Importar um arquivo de módulo do Yaml para um objeto **ModuleHelp**

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

Parâmetros

-AsDictionary

Por padrão, o comando retorna um objeto ModuleHelp. Quando você usa esse parâmetro, o comando retorna o ModuleHelp dados de um objeto de dicionário.

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 módulo 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:True
Valor do pipeline por nome da propriedade:False
Valor dos argumentos restantes:False

-Path

Especifica um caminho para um ou mais locais que contêm arquivos de módulo do Yaml.

Propriedades dos parâmetros

Tipo:

String[]

Valor padrão:None
Suporta curingas:True
DontShow:False

Conjuntos de parâmetros

Path
Posição:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome da propriedade:False
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

Microsoft.PowerShell.PlatyPS.ModuleFileInfo