New-ExampleInfo
Crescendo コマンド オブジェクトで使用される例を表す PowerShell オブジェクトを作成します。
構文
Default (既定)
New-ExampleInfo
[-command] <String>
[-description] <String>
[[-originalCommand] <String>]
[<CommonParameters>]
説明
Crescendo コマンド オブジェクトで使用される例を表す PowerShell オブジェクトを作成します。 結果のオブジェクトは、JSON に変換して構成ファイルに挿入することも、後でコマンド オブジェクトから JSON に変換するために追加することもできます。
例
例 1
New-ExampleInfo -command Get-Something -originalCommand native.exe -description 'this is some text' |
ConvertTo-Json
{
"Command": "Get-Something",
"OriginalCommand": "native.exe",
"Description": "this is some text"
}
パラメーター
-command
説明されている例のコマンド ライン。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 0 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-description
例の説明。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 1 |
| 必須: | True |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
-originalCommand
このコマンドレットの例で実行される元のネイティブ コマンド。
パラメーターのプロパティ
| 型: | String |
| 規定値: | None |
| ワイルドカードのサポート: | False |
| DontShow: | False |
パラメーター セット
(All)
| 配置: | 2 |
| 必須: | False |
| パイプラインからの値: | False |
| プロパティ名別のパイプラインからの値: | False |
| 残りの引数からの値: | False |
CommonParameters
このコマンドレットでは、一般的なパラメーター -Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction、-WarningVariable の各パラメーターがサポートされています。 詳細については、about_CommonParametersを参照してください。