| external help file | Module Name | ms.date | online version | schema |
|---|---|---|---|---|
Microsoft.PowerShell.Crescendo-help.xml |
Microsoft.PowerShell.Crescendo |
12/13/2022 |
2.0.0 |
Creates a PowerShell object representing an example used in a Crescendo command object.
New-ExampleInfo [-command] <String> [-description] <String> [[-originalCommand] <String>]
[<CommonParameters>]
Creates a PowerShell object representing an example used in a Crescendo command object. The resulting object can be converted to JSON to be inserted into a configuration file or added to a command object conversion to JSON later.
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"
}
The command line for the example being described.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe description of the example.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe original native command that's run for this cmdlet example.
Type: System.String
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.