Import-YamlModuleFile

Yaml modül dosyasını bir ModuleHelp nesnesine aktarır.

Syntax

Path (Varsayılan)

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

LiteralPath

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

Description

komutu modül yardımı içeren Yaml dosyalarını içeri aktarır ve modulehelp nesneleri oluşturur. ModuleHelp nesnesi, farklı biçimlere dışarı aktarmak için kullanılabilecek yardım içeriğinin yapılandırılmış bir gösterimidir.

Örnekler

Örnek 1 - Yaml modül dosyasını **ModuleHelp** nesnesine içeri aktarma

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

Parametreler

-AsDictionary

Varsayılan olarak, komut bir ModuleHelp nesnesi döndürür. Bu parametreyi kullandığınızda, komut ModuleHelp veri bir sözlük nesnesi döndürür.

Parametre özellikleri

Tür:SwitchParameter
Default value:False
Joker karakterleri destekler:False
DontShow:False

Parametre kümeleri

(All)
Position:Named
Zorunlu:False
İşlem hattından gelen değer:False
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-LiteralPath

Bir veya daha fazla Yaml modül dosyasının yolunu belirtir. LiteralPath değeri tam olarak yazıldığı gibi kullanılır. Hiçbir karakter joker karakter olarak yorumlanmamıştır. Yol kaçış karakterleri içeriyorsa, yolu tek tırnak işaretleriyle çevreleyin. Tek tırnak işaretleri, PowerShell'in hiçbir karakteri kaçış dizisi olarak yorumlamamasını sağlar.

Daha fazla bilgi için bkz. about_Quoting_Rules.

Parametre özellikleri

Tür:

String[]

Default value:None
Joker karakterleri destekler:False
DontShow:False
Diğer adlar:PSPath, LP

Parametre kümeleri

LiteralPath
Position:Named
Zorunlu:True
İşlem hattından gelen değer:True
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

-Path

Yaml modül dosyalarını içeren bir veya daha fazla konumun yolunu belirtir.

Parametre özellikleri

Tür:

String[]

Default value:None
Joker karakterleri destekler:True
DontShow:False

Parametre kümeleri

Path
Position:0
Zorunlu:True
İşlem hattından gelen değer:True
Özellik adına göre işlem hattından gelen değer:False
Kalan bağımsız değişkenlerden elde edilen değer:False

CommonParameters

Bu cmdlet yaygın parametreleri destekler: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction ve -WarningVariable. Daha fazla bilgi için bkz. about_CommonParameters.

Girişler

String

Çıkışlar

Microsoft.PowerShell.PlatyPS.ModuleFileInfo