Dela via

Export-YamlModuleFile

Modul:
Microsoft.PowerShell.PlatyPS Module

Exporterar ett ModuleFileInfo- objekt till en Yaml-fil.

Syntax

__AllParameterSets 

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

Beskrivning

Det här kommandot exporterar ett ModuleFileInfo--objekt till en markdown-fil. Du kan hämta ett ModuleFileInfo--objekt med hjälp av cmdleten Import-MarkdownModuleFile. Du kan importera en modulfil som är skriven i det gamla formatet och exportera den till det nya formatet.

Exempel

Exempel 1 – Exportera ett ModuleFileInfo-objekt till en markdown-fil

I det här exemplet ett ModuleFileInfo-objekt genom att importera en Markdown-modulfil. Objektet exporteras sedan till en Yaml-fil med hjälp av 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

Parametrar

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokrar:False
DontShow:False
Alias:jfr

Parametermängder

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

-Encoding

Den kodning som ska användas när du skriver markdown-filen. Om inget värde anges kodas som standard värdet för $OutputEncoding-inställningsvariabeln.

Parameteregenskaper

Typ:Encoding
Standardvärde:False
Stöder jokrar:False
DontShow:False

Parametermängder

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

-Force

Använd parametern Force för att skriva över utdatafilen om den redan finns.

Parameteregenskaper

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

Parametermängder

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

-Metadata

Metadata som ska läggas till i markdown-filen. Metadata är en hashtable som innehåller nyckel/värde-par.

Parameteregenskaper

Typ:Hashtable
Standardvärde:None
Stöder jokrar:False
DontShow:False

Parametermängder

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

-ModuleFileInfo

Objektet ModuleFileInfo som ska exporteras. Du kan skicka objektet ModuleFileInfo i pipelinen eller med parametern ModuleFileInfo.

Parameteregenskaper

Typ:

Microsoft.PowerShell.PlatyPS.ModuleFileInfo[]

Standardvärde:None
Stöder jokrar:False
DontShow:False

Parametermängder

(All)
Position:0
Obligatorisk:True
Värde från pipeline:True
Värde från pipeline efter fastighetsnamn:False
Värde från återstående argument:False

-OutputFolder

ModuleFileInfo objekt som ska exporteras till en markdown-fil. Det här objektet skapas av cmdleten Import-MarkdownModuleFile.

Parameteregenskaper

Typ:String
Standardvärde:None
Stöder jokrar:False
DontShow:False

Parametermängder

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

-WhatIf

Kör kommandot i ett läge som bara rapporterar vad som skulle hända utan att utföra åtgärderna.

Parameteregenskaper

Typ:SwitchParameter
Standardvärde:False
Stöder jokrar:False
DontShow:False
Alias:Wi

Parametermängder

(All)
Position:Named
Obligatorisk:False
Värde från pipeline:False
Värde från pipeline efter fastighetsnamn:False
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.

Ingångar

Microsoft.PowerShell.PlatyPS.ModuleFileInfo

Utgångar

FileInfo