ARGOMENTO
about_Command_Syntax
DESCRIZIONE BREVE
Descrive la notazione utilizzata per la sintassi di Windows
PowerShell nella Guida.
DESCRIZIONE DETTAGLIATA
Il cmdlet Get-Help visualizza l'utilizzo del parametro per un
cmdlet. Il cmdlet Get-Help utilizza i seguenti simboli speciali:
Le parentesi angolari (<>) indicano il testo segnaposto.
Le parentesi quadre([]) indicano gli elementi facoltativi. Le
parentesi graffe ({}) indicano una scelta tra valori.
Alcuni cmdlet dispongono di più set di parametri. Set di
parametri distinti possono condividere alcuni parametri. Il
cmdlet Get-Help visualizza tutti i set di parametri per un cmdlet.
È possibile trovare informazioni aggiuntive su un parametro nella
descrizione del parametro e nella tabella degli attributi dei
parametri. Per visualizzare le informazioni complete su un parametro,
utilizzare i parametri Full o Parameter di Get-Help.
Sintassi
La Guida al cmdlet di Windows PowerShell, gli argomenti della
Guida e altra documentazione utilizzano la notazione seguente
per i cmdlet nelle descrizioni di sintassi.
<nome-cmdlet> -<nome parametro obbligatorio> <valore parametro
obbligatorio>
[-<nome parametro facoltativo> <valore parametro
facoltativo>]
[-<parametro opzionale>]
[-<nome parametro facoltativo>] <valore parametro
obbligatorio>
Di seguito è riportata la sintassi del cmdlet New-Alias:
New-Alias [-Force] [-PassThru] [-Scope <string>]
[-Option {None | ReadOnly | Constant | Private | AllScope}]
[-Description <stringa>] [-Name] <stringa> [-Value]
<stringa>
[-confirm] [-whatif] [<ParametriComuni>]
Per migliorare la leggibilità nella sintassi vengono utilizzate
le lettere maiuscole, ma Windows PowerShell non rileva la
distinzione tra maiuscole e minuscole.
I parametri vengono visualizzati in ordine. L'ordine dei parametri è
significativo solo quando i nomi dei parametri sono facoltativi.
Se non si specificano i nomi dei parametri durante l'utilizzo di
un cmdlet, Windows PowerShell assegna valori ai parametri in
base a posizione e tipo.
I nomi dei parametri sono preceduti da un trattino (-). I parametri
opzionali vengono visualizzati senza tipo di valore. Gli altri
parametri vengono visualizzati con il tipo Microsoft .NET Framework
dell'argomento necessario o con un'enumerazione di valori possibili.
Per ulteriori informazioni sui tipi .NET Framework,
vedere https://go.microsoft.com/fwlink/?LinkId=143682.
Le parentesi angolari (<>) indicano il testo segnaposto. Questo
testo può descrivere il
tipo di un elemento (ad esempio una stringa o un oggetto
processo). Può inoltre essere un segnaposto per uno o più
parametri comuni.
Le parentesi quadre([]) indicano gli elementi facoltativi. Un
parametro può essere facoltativo oppure può essere facoltativo
il nome di un parametro obbligatorio. I parametri opzionali
sono sempre facoltativi.
Le parentesi graffe ({}) racchiudono i valori di un'enumerazione.
Nell'esempio del cmdlet New-Alias, il parametro Option può disporre
di uno qualsiasi dei valori elencati.
Elementi facoltativi
Le parentesi quadre([]) racchiudono gli elementi facoltativi.
Ad esempio, nella descrizione della sintassi del cmdlet
New-Alias, il parametro Scope è facoltativo. Ciò viene indicato
nella sintassi dalle parentesi quadre che racchiudono il tipo e
il nome del parametro:
[-Scope <string>]
Entrambi gli esempi seguenti rappresentano utilizzi corretti
del cmdlet New-Alias:
New-Alias -Name utd -Value Update-TypeData New-Alias -Name
utd -Value Update-TypeData -Scope global
Il nome di un parametro può essere facoltativo anche se il
valore di tale parametro è obbligatorio. Ciò viene indicato
nella sintassi dalle parentesi quadre che racchiudono il nome del
parametro ma non il tipo di parametro, come in questo esempio dal
cmdlet New-Alias:
[-Name] <stringa> [-Value] <stringa>
Nei comandi seguenti viene utilizzato il cmdlet New-Alias.
Questi comandi producono lo stesso risultato:
New-Alias -Name utd -Value Update-TypeData New-Alias -Name
utd Update-TypeData
New-Alias utd -Value Update-TypeData
New-Alias utd Update-TypeData
Se il nome del parametro non è incluso nell'istruzione
digitata, Windows PowerShell tenta di utilizzare la posizione degli
argomenti per assegnare i valori ai parametri.
L'esempio seguente non è completo:
New-Alias utd
Questo cmdlet richiede i valori per entrambi i parametri Name e
Value.
Negli esempi di sintassi, le parentesi quadre vengono inoltre
utilizzate nella denominazione e nelle operazioni di casting
sui tipi .NET Framework. In questo contesto, le parentesi quadre non
indicano che un elemento è facoltativo.
Argomenti di matrice
Le parentesi quadre vengono inoltre utilizzate nelle descrizioni di
sintassi per rappresentare una matrice. Nell'esempio seguente viene
riportata la sintassi del cmdlet Restart-Service:
Restart-Service [-Name] <string[]> [-Include <string[]>]
[-Exclude <string[]>] [-Force] [-PassThru] [-Confirm] [-WhatIf]
[<ParametriComuni>]
Il parametro Name richiede un argomento. In particolare, è
necessario il nome del servizio da riavviare. È possibile
utilizzare un elenco di servizi separati da virgole, come
nell'esempio seguente:
Restart-Service RasAuto, RasMan, RemoteAccess
VEDERE ANCHE
Get-Help