Export-CrescendoModule
PowerShell Crescendo JSON 構成ファイルからモジュールを作成します
構文
Default (既定)
Export-CrescendoModule
[-ConfigurationFile] <String[]>
[-ModuleName] <String>
[-Force]
[-NoClobberManifest]
[-PassThru]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
説明
このコマンドレットは、プラットフォーム固有のコマンドのプロキシとして機能する関数に変換できるオブジェクトをエクスポートします。 結果のモジュール ファイルは、PowerShell のバージョン 5.1 まで実行可能である必要があります。
このコマンドレットは、モジュール .psm1 とモジュール マニフェスト .psd1 ファイルの両方を作成します。 これにより、Crescendo のスコープを超えてモジュール マニフェストをカスタマイズした場合に問題が発生する可能性があります。 マニフェストの上書きを防ぐには、NoClobberManifest パラメーターを使用します。
例
例 1
Export-CrescendoModule -ModuleName netsh -ConfigurationFile netsh*.json
Import-Module ./netsh.psm1
例 2
Export-CrescendoModule netsh netsh*.json -force
パラメーター
-ConfigurationFile
これは、モジュールのプロキシを表す JSON ファイルの一覧です。
パラメーターのプロパティ
| 型: | String[] |
| 規定値: | None |
| ワイルドカードのサポート: | True |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | True |
| 残りの引数からの値: | False |
-Confirm
コマンドレットを実行する前に確認を求めるメッセージが表示されます。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | cf |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-Force
既定では、Export-CrescendoModule が既存のモジュールを上書きしない場合。
Force パラメーターを使用して既存のファイルを上書きするか、Export-CrescendoModuleを実行する前に削除します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | False |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-ModuleName
作成するモジュール ファイルの名前。 末尾の .psm1は省略できます。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-NoClobberManifest
モジュール マニフェストの上書きを防止します。
新しいコマンドレットと設定を使用してマニフェストを手動で更新する必要があります。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-PassThru
.psm1 へのパスと New-ModuleManifest への引数を持つオブジェクトを出力します。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-WhatIf
コマンドレットを実行した場合の動作を示します。 コマンドレットは実行されません。
パラメーターのプロパティ
| 型: | SwitchParameter |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
| Aliases: | ウィスコンシン |
パラメーター セット
(All)
| 配置: | Named |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。
入力
String
出力
Object
メモ
内部的には、この関数はコマンド オブジェクトを返す Import-CommandConfiguration コマンドレットを呼び出します。 その後、ConfigurationFile パラメーターで指定されたすべてのファイルを使用して、個々の関数を作成します。 最後に、すべてのプロキシを使用して Export-ModuleMember コマンド呼び出しを作成するため、結果のモジュールがインポートされると、モジュールにはすべてのコマンド プロキシが使用可能になります。
Export-CrescendoModule は、CrescendoBuilt タグをモジュール マニフェストに追加します。 このタグを使用すると、Crescendo を使用して作成された PowerShell ギャラリー内のモジュールを検索できます。 詳細については、以下を参照してください。