New-UsageInfo
Crea un objeto de PowerShell que representa una definición de uso de Crescendo.
Sintaxis
Default (valor predeterminado)
New-UsageInfo
[-usage] <String>
[<CommonParameters>]
Description
Importante
A fecha de mayo de 2026, el proyecto Crescendo ya no se mantiene activamente. Este proyecto debe considerarse archivado desde un punto de vista de ingeniería.
Crea un objeto de PowerShell que representa una definición de uso de Crescendo. Puede asignar valores a las propiedades del objeto . El objeto resultante se puede agregar a la propiedad Usage de un objeto de comando o se puede convertir a JSON para insertarse en el archivo de configuración. El Synopsis del objeto se inserta en el módulo como ayuda basada en comentarios en la palabra clave .SYNOPSIS.
Ejemplos
Ejemplo 1: Creación de un objeto Usage y conversión a 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
Texto que describe el propósito del cmdlet.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | 0 |
| Obligatorio: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
CommonParameters
Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.
