Condividi tramite

New-UsageInfo

  • Riferimento
Modulo:
Microsoft.PowerShell.Crescendo

Crea un oggetto PowerShell che rappresenta una definizione Di utilizzo Crescendo.

Sintassi

New-UsageInfo
   [-usage] <String>
   [<CommonParameters>]

Descrizione

Crea un oggetto PowerShell che rappresenta una definizione Di utilizzo Crescendo. È possibile assegnare valori alle proprietà dell'oggetto . L'oggetto risultante può essere aggiunto alla proprietà Usage di un oggetto comando oppure può essere convertito in JSON da inserire nel file di configurazione. La sintesi dell'oggetto viene inserita nel modulo come guida basata su commenti nella .SYNOPSIS parola chiave .

Esempio

Esempio 1- Creare un oggetto Usage e convertirlo in 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
}

Parametri

-usage

Testo che descrive lo scopo del cmdlet.

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Input

None

Output

Object