New-UsageInfo
Cria um objeto PowerShell que representa uma definição de Uso crescente.
Sintaxe
Default (Predefinição)
New-UsageInfo
[-usage] <String>
[<CommonParameters>]
Description
Importante
Em maio de 2026, o projeto Crescendo já não está a ser mantido ativamente. Este projeto deve ser considerado arquivado do ponto de vista da engenharia.
Cria um objeto PowerShell que representa uma definição de Uso crescente. Você pode atribuir valores às propriedades do objeto. O objeto resultante pode ser adicionado à propriedade Usage de um objeto de comando ou pode ser convertido em JSON para ser inserido no arquivo de configuração. A Sinopse do objeto é inserida no módulo como ajuda baseada em comentários sob a palavra-chave .SYNOPSIS.
Exemplos
Exemplo 1 - Criar um objeto Usage e convertê-lo em JSON
$usage = New-UsageInfo -usage 'This is a description for how to use the cmdlet.'
$usage | ConvertTo-Json
{
"Synopsis": "This is a description for how to use the cmdlet.",
"SupportsFlags": false,
"HasOptions": false,
"OriginalText": null
}
Parâmetros
-usage
O texto que descreve a finalidade do cmdlet.
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 |
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.
