Freigeben über

Export-YamlModuleFile

Modul:
Microsoft.PowerShell.PlatyPS Module

Exportiert ein ModuleFileInfo- -Objekt in eine Yaml-Datei.

Syntax

__AllParameterSets 

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

Beschreibung

Mit diesem Befehl wird ein ModuleFileInfo--Objekt in eine Markdowndatei exportiert. Mit dem cmdlet können Sie ein Import-MarkdownModuleFile-Objekt abrufen. Sie können eine Moduldatei importieren, die im alten Format geschrieben und in das neue Format exportiert wird.

Beispiele

Beispiel 1 : Exportieren eines ModuleFileInfo-Objekts in eine Markdowndatei

In diesem Beispiel ModuleFileInfo Objekt durch Importieren einer Modul-Markdown-Datei. Dieses Objekt wird dann mithilfe der Export-YamlModuleFilein eine Yaml-Datei exportiert.

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

Parameter

-Confirm

Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:vgl

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Encoding

Die Codierung, die beim Schreiben der Markdowndatei verwendet werden soll. Wenn kein Wert angegeben ist, wird standardmäßig der Wert der $OutputEncoding Einstellungsvariablen codiert.

Parametereigenschaften

Typ:Encoding
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Force

Verwenden Sie den parameter Force, um die Ausgabedatei zu überschreiben, sofern sie bereits vorhanden ist.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-Metadata

Die Metadaten, die der Markdowndatei hinzugefügt werden sollen. Die Metadaten sind eine Hashtabelle, die Schlüsselwertpaare enthält.

Parametereigenschaften

Typ:Hashtable
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-ModuleFileInfo

Das zu exportierende ModuleFileInfo-Objekt. Sie können das ModuleFileInfo-objekt an die Pipeline übergeben oder den parameter ModuleFileInfo verwenden.

Parametereigenschaften

Typ:

Microsoft.PowerShell.PlatyPS.ModuleFileInfo[]

Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:0
Obligatorisch.:True
Wert aus Pipeline:True
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-OutputFolder

Das ModuleFileInfo Objekt, das in eine Markdowndatei exportiert werden soll. Dieses Objekt wird vom Cmdlet Import-MarkdownModuleFile erstellt.

Parametereigenschaften

Typ:String
Standardwert:None
Unterstützt Platzhalter:False
Nicht anzeigen:False

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

-WhatIf

Führt den Befehl in einem Modus aus, der nur meldet, was passieren würde, ohne die Aktionen auszuführen.

Parametereigenschaften

Typ:SwitchParameter
Standardwert:False
Unterstützt Platzhalter:False
Nicht anzeigen:False
Aliase:Wi

Parametersätze

(All)
Position:Named
Obligatorisch.:False
Wert aus Pipeline:False
Wert aus Pipeline nach dem Eigenschaftsnamen:False
Wert aus verbleibenden Argumenten:False

CommonParameters

Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.

Eingaben

Microsoft.PowerShell.PlatyPS.ModuleFileInfo

Ausgaben

FileInfo