New-ExampleInfo
Cria um objeto do PowerShell que representa um exemplo usado em um objeto de comando Crescendo.
Sintaxe
Default (Predefinição)
New-ExampleInfo
[-command] <String>
[-description] <String>
[[-originalCommand] <String>]
[<CommonParameters>]
Description
Cria um objeto do PowerShell que representa um exemplo usado em um objeto de comando Crescendo. O objeto resultante pode ser convertido em JSON para ser inserido em um arquivo de configuração ou adicionado a uma conversão de objeto de comando para JSON posteriormente.
Exemplos
Exemplo 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"
}
Parâmetros
-command
A linha de comando para o exemplo que está sendo descrito.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-description
A descrição do exemplo.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | 1 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-originalCommand
O comando nativo original executado para este exemplo de cmdlet.
Propriedades dos parâmetros
| Tipo: | String |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | 2 |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
