Compartilhar via

Export-YamlModuleFile

Módulo:
Microsoft.PowerShell.PlatyPS Module

Exporta um objeto ModuleFileInfo para um arquivo Yaml.

Sintaxe

__AllParameterSets 

Export-YamlModuleFile
    [-ModuleFileInfo] <ModuleFileInfo[]>
    [-Encoding <Encoding>]
    [-Force]
    [-OutputFolder <string>]
    [-Metadata <hashtable>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Esse comando exporta um objeto ModuleFileInfo para um arquivo markdown. Você pode obter um objeto ModuleFileInfo usando o cmdlet Import-MarkdownModuleFile. Você pode importar um arquivo de módulo escrito no formato antigo e exportá-lo para o novo formato.

Exemplos

Exemplo 1 – Exportar um objeto ModuleFileInfo para um arquivo markdown

Neste exemplo, um objeto ModuleFileInfo importando um arquivo markdown do módulo. Em seguida, esse objeto é exportado para um arquivo Yaml usando o Export-YamlModuleFile.

Import-MarkdownModuleFile -Path .\v2\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md |
    Export-YamlModuleFile -OutputFolder .\v2\yaml

    Directory: D:\Git\PS-Src\platyPS\v2docs\v2\yaml

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           8/26/2024  4:00 PM           2594 Microsoft.PowerShell.PlatyPS.yml

Parâmetros

-Confirm

Solicita sua confirmação antes de executar o cmdlet.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:cf

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Encoding

A codificação a ser usada ao gravar o arquivo markdown. Se nenhum valor for especificado, a codificação usará como padrão o valor da variável de preferência $OutputEncoding.

Propriedades do parâmetro

Tipo:Encoding
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Force

Use o parâmetro Force para substituir o arquivo de saída se ele já existir.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Metadata

Os metadados a serem adicionados ao arquivo markdown. Os metadados são um hashtable que contém pares chave-valor.

Propriedades do parâmetro

Tipo:Hashtable
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ModuleFileInfo

O objeto ModuleFileInfo a ser exportado. Você pode passar o objeto ModuleFileInfo no pipeline ou usando o parâmetro ModuleFileIn fo.

Propriedades do parâmetro

Tipo:

Microsoft.PowerShell.PlatyPS.ModuleFileInfo[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:0
Obrigatório:True
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-OutputFolder

O objeto ModuleFileInfo exportar para um arquivo markdown. Esse objeto é criado pelo cmdlet Import-MarkdownModuleFile.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-WhatIf

Executa o comando em um modo que relata apenas o que aconteceria sem executar as ações.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:False
Dá suporte a curingas:False
DontShow:False
Aliases:wi

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo 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

Microsoft.PowerShell.PlatyPS.ModuleFileInfo

Saídas

FileInfo