New-Variable
Crea una nuova variabile.
Sintassi
New-Variable
[-Name] <String>
[[-Value] <Object>]
[-Description <String>]
[-Option <ScopedItemOptions>]
[-Visibility <SessionStateEntryVisibility>]
[-Force]
[-PassThru]
[-Scope <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Descrizione
Il New-Variable
cmdlet crea una nuova variabile in PowerShell. È possibile assegnare un valore alla variabile durante la creazione o assegnare o modificare il valore dopo averla creata.
È possibile usare i parametri di New-Variable
per impostare le proprietà della variabile, impostare l'ambito di una variabile e determinare se le variabili sono pubbliche o private.
In genere, si crea una nuova variabile digitando il nome della variabile e il relativo valore, ad esempio $Var = 3
, ma è possibile usare il cmdlet per usare i New-Variable
relativi parametri.
Esempio
Esempio 1: Create una variabile
New-Variable days
Questo comando crea una nuova variabile denominata giorni. Non è necessario digitare il parametro Name .
Esempio 2: Create una variabile e assegnargli un valore
New-Variable -Name "zipcode" -Value 98033
Questo comando crea una variabile denominata zipcode e lo assegna al valore 98033.
Esempio 3: Create una variabile con l'opzione ReadOnly
PS C:\> New-Variable -Name Max -Value 256 -Option ReadOnly
PS C:\> New-Variable -Name max -Value 1024
New-Variable : A variable with name 'max' already exists.
At line:1 char:1
+ New-Variable -Name max -Value 1024
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+ CategoryInfo : ResourceExists: (max:String) [New-Variable], SessionStateException
+ FullyQualifiedErrorId : VariableAlreadyExists,Microsoft.PowerShell.Commands.NewVariableCommand
PS C:\> New-Variable -Name max -Value 1024 -Force
In questo esempio viene illustrato come usare l'opzione ReadOnly
di New-Variable
per proteggere una variabile da sovrascrivere.
Il primo comando crea una nuova variabile denominata Max e imposta il relativo valore su 256. Usa il parametro Option con un valore di ReadOnly
.
Il secondo comando tenta di creare una seconda variabile con lo stesso nome. Questo comando restituisce un errore, perché per la variabile è stata impostata l'opzione di sola lettura.
Il terzo comando usa il parametro Force per eseguire l'override della protezione di sola lettura nella variabile. In questo caso, il comando per creare una nuova variabile con lo stesso nome riesce.
Esempio 4: Assegnare più opzioni a una variabile
New-Variable -Name 'TestVariable' -Value 'Test Value' -Option AllScope,Constant
In questo esempio viene creata una variabile e vengono assegnate le AllScope
opzioni e Constant
in modo che la variabile sia disponibile nell'ambito corrente e non sia possibile modificare o eliminare eventuali nuovi ambiti.
Esempio 5: Create una variabile privata
Questo comando mostra il comportamento di una variabile privata in un modulo. Il modulo contiene il Get-Counter
cmdlet, con una variabile privata denominata Counter. Il comando usa il parametro Visibilità con un valore privato per creare la variabile.
PS C:\> New-Variable -Name counter -Visibility Private
#Effect of private variable in a module.
PS C:\> Get-Variable c*
Name Value
---- -----
Culture en-US
ConsoleFileName
ConfirmPreference High
CommandLineParameters {}
PS C:\> $counter
"Cannot access the variable '$counter' because it is a private variable"
At line:1 char:1
+ $counter
+ ~~~~~~~~
+ CategoryInfo : PermissionDenied: (counter:String) [], SessionStateException
+ FullyQualifiedErrorId : VariableIsPrivate
PS C:\> Get-Counter
Name Value
---- -----
Counter1 3.1415
...
L'output di esempio mostra il comportamento di una variabile privata. L'utente che ha caricato il modulo non può visualizzare o modificare il valore della variabile Counter, ma la variabile Counter può essere letta e modificata dai comandi nel modulo.
Esempio 6: Create una variabile con uno spazio
In questo esempio viene illustrato che è possibile creare variabili con spazi. È possibile accedere alle variabili usando il Get-Variable
cmdlet o delimitando direttamente una variabile con parentesi graffe.
PS C:\> New-Variable -Name 'with space' -Value 'abc123xyz'
PS C:\> Get-Variable -Name 'with space'
Name Value
---- -----
with space abc123xyz
PS C:\> ${with space}
abc123xyz
Parametri
-Confirm
Richiede la conferma dell'utente prima di eseguire il cmdlet.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Description
Specifica una descrizione della variabile.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Indica che il cmdlet crea una variabile con lo stesso nome di una variabile di sola lettura esistente.
Per impostazione predefinita, è possibile sovrascrivere una variabile a meno che la variabile non abbia un valore di opzione o ReadOnly
Constant
. Per altre informazioni, vedere il parametro Option .
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Specifica un nome per la nuova variabile.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Option
Specifica il valore della proprietà Options della variabile. I valori validi per questo parametro sono:
None
- Imposta nessuna opzione.None
è l'impostazione predefinita.ReadOnly
- Può essere eliminato. Impossibile modificare, tranne usando il parametro Force .Private
- La variabile è disponibile solo nell'ambito corrente.AllScope
- La variabile viene copiata in tutti i nuovi ambiti creati.Constant
- Impossibile eliminare o modificare.Constant
è valido solo quando si crea una variabile. Non è possibile modificare le opzioni di una variabile esistente inConstant
.
Questi valori sono definiti come enumerazione basata su flag. È possibile combinare più valori per impostare più flag usando questo parametro. I valori possono essere passati al parametro Option come matrice di valori o come stringa delimitata da virgole di tali valori. Il cmdlet combina i valori usando un'operazione binary-OR. Il passaggio di valori come matrice è l'opzione più semplice e consente anche di usare il completamento della scheda sui valori.
Per visualizzare la proprietà Options di tutte le variabili nella sessione, digitare Get-Variable | Format-Table -Property name, options -AutoSize
.
Type: | ScopedItemOptions |
Accepted values: | None, ReadOnly, Constant, Private, AllScope, Unspecified |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Restituisce un oggetto che rappresenta l'elemento in uso. Per impostazione predefinita, il cmdlet non genera alcun output.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Scope
Specifica l'ambito della nuova variabile. I valori validi per questo parametro sono:
Global
- Le variabili create nell'ambito globale sono accessibili ovunque in un processo di PowerShell.Local
- L'ambito locale fa riferimento all'ambito corrente, questo può essere qualsiasi ambito a seconda del contesto.Local
è l'ambito predefinito quando il parametro di ambito non è specificato.Script
- Le variabili create nell'ambito dello script sono accessibili solo all'interno del file di script o del modulo in cui vengono create.- Numero relativo all'ambito corrente (da 0 al numero di ambiti, in cui 0 è l'ambito corrente, 1 è padre, 2 padre dell'ambito padre e così via). I numeri negativi non possono essere usati.
Nota
Il parametro accetta anche il valore di Private
. Private
non è effettivamente un ambito, ma un'impostazione facoltativa per una variabile. Tuttavia, l'uso del Private
valore con questo cmdlet non modifica la visibilità della variabile. Per altre informazioni, vedere about_Scopes.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Value
Specifica il valore iniziale della variabile.
Type: | Object |
Position: | 1 |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Visibility
Determina se la variabile è visibile all'esterno della sessione in cui è stata creata. Questo parametro è progettato per l'uso negli script e nei comandi che verranno recapitati ad altri utenti. I valori validi per questo parametro sono:
Public
- La variabile è visibile.Public
è l'impostazione predefinita.Private
- La variabile non è visibile.
Quando una variabile è privata, non viene visualizzata in elenchi di variabili, ad esempio quelle restituite da Get-Variable
o in visualizzazione dell'unità Variable:
. I comandi per leggere o modificare il valore di una variabile privata restituiscono un errore. Tuttavia, l'utente può eseguire comandi che usano una variabile privata se i comandi sono stati scritti nella sessione in cui è stata definita la variabile.
Type: | SessionStateEntryVisibility |
Accepted values: | Public, Private |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Mostra l'esito in caso di esecuzione del cmdlet. Il cmdlet non viene eseguito.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Input
È possibile eseguire la pipe di qualsiasi oggetto in New-Variable
.
Output
None
Per impostazione predefinita, questo cmdlet non restituisce alcun output.
Quando si usa il parametro PassThru , questo cmdlet restituisce un oggetto PSVariable che rappresenta la nuova variabile.
Note
PowerShell include gli alias seguenti per New-Variable
:
- Tutte le piattaforme:
nv