Condividi tramite

Set-Variable

  • Riferimento
Modulo:
Microsoft.PowerShell.Utility

Imposta il valore di una variabile. Crea la variabile se non ne esiste una con il nome richiesto.

Sintassi

Set-Variable
   [-Name] <String[]>
   [[-Value] <Object>]
   [-Include <String[]>]
   [-Exclude <String[]>]
   [-Description <String>]
   [-Option <ScopedItemOptions>]
   [-Force]
   [-Visibility <SessionStateEntryVisibility>]
   [-PassThru]
   [-Scope <String>]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Descrizione

Il cmdlet Set-Variable assegna un valore a una variabile specificata o modifica il valore corrente. Se la variabile non esiste, il cmdlet la crea.

Esempio

Esempio 1: Impostare una variabile e ottenere il relativo valore

PS C:\> Set-Variable -Name "desc" -Value "A description"
PS C:\> Get-Variable -Name "desc"

Questi comandi impostano il valore della variabile desc su A description e quindi ottiene il valore della variabile.

Esempio 2: Impostare una variabile globale, di sola lettura

PS C:\> Set-Variable -Name "processes" -Value (Get-Process) -Option constant -Scope global -Description "All processes" -PassThru | Format-List -Property *

Questo comando crea una variabile globale di sola lettura che contiene tutti i processi nel sistema e quindi visualizza tutte le proprietà della variabile.

Il comando usa il cmdlet Set-Variable per creare la variabile. Usa il parametro PassThru per creare un oggetto che rappresenta la nuova variabile e usa l'operatore della pipeline (|) per passare l'oggetto al cmdlet Format-List. Usa il parametro Property di Format-List con un valore di tutti (*) per visualizzare tutte le proprietà della variabile appena creata.

Il valore "(Get-Process)" è racchiuso tra parentesi per assicurare che venga eseguito prima dell'archiviazione nella variabile. In caso contrario, la variabile contiene la dicitura "Get-Process".

Esempio 3: Comprendere le variabili pubbliche e private

PS C:\> New-Variable -Name "counter" -Visibility Public -Value 26
PS C:\> $Counter
26
PS C:\> Get-Variable c*

Name                  Value
----                  -----
Culture               en-US
ConsoleFileName
ConfirmPreference     High
CommandLineParameters {}
Counter               26

PS C:\> Set-Variable -Name "counter" -Visibility Private
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"

PS C:\> .\use-counter.ps1
#Commands completed successfully.

Questo comando illustra come modificare la visibilità di una variabile in Privato. Questa variabile può essere letta e modificata mediante script con le autorizzazioni necessarie, ma non è visibile all'utente.

L'output di esempio mostra la differenza di comportamento tra le variabili pubbliche e private.

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 la descrizione della variabile.

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

-Exclude

Specifica una matrice di elementi esclusi dal cmdlet dall'operazione. Il valore di questo parametro qualifica il parametro Path. Immettere un elemento o un modello del percorso, ad esempio *.txt. I caratteri jolly sono consentiti.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Force

Consente di creare una variabile con lo stesso nome di una variabile di sola lettura esistente o di modificare il valore di una variabile di sola lettura.

Per impostazione predefinita, è possibile sovrascrivere una variabile, a meno che la variabile non abbia un valore di opzione ReadOnly o Constant. Per altre informazioni, vedere il parametro Option .

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Include

Specifica una matrice di elementi inclusi nel cmdlet nell'operazione. Il valore di questo parametro qualifica il parametro Name . Immettere un nome o un modello di nome, ad esempio c*. I caratteri jolly sono consentiti.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:True

-Name

Specifica il nome della 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 sono:

  • Nessuno: imposta nessuna opzione. ("None" è il valore predefinito).
  • ReadOnly: può essere eliminato. Impossibile modificare, tranne usando il parametro Force.
  • Costante: non è possibile eliminare o modificare. Il valore "Constant" è valido solo quando si crea una nuova variabile. Non è possibile impostare le opzioni di una variabile esistente su "Constant".
  • Privato: la variabile è disponibile solo nell'ambito corrente.
  • AllScope: la variabile viene copiata in tutti i nuovi ambiti creati.

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 la nuova variabile. Per impostazione predefinita, il cmdlet non genera alcun output.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Scope

Specifica l'ambito della variabile. I valori accettabili per questo parametro sono:

  • Globale
  • Locale
  • Script
  • Privato
  • Numero relativo all'ambito corrente (0 al numero di ambiti, dove 0 è l'ambito corrente e 1 è il relativo padre).

Local è il valore predefinito.

Per altre informazioni, vedere about_Scopes.

Type:String
Position:Named
Default value:Local
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Value

Specifica il valore 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 sono:

  • Public: la variabile è visibile. ("Public" è il valore predefinito).
  • Privato: la variabile non è visibile.

Quando una variabile è privata, non viene visualizzata negli elenchi di variabili, ad esempio quelli restituiti da Get-Variable, o nelle visualizzazioni 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:Public
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

Object

È possibile eseguire la pipe di un oggetto che rappresenta il valore della variabile su Set-Variable.

Output

None or System.Management.Automation.PSVariable

Quando si usa il parametro PassThru , Set-Variable genera un oggetto System.Management.Automation.PSVariable che rappresenta la nuova variabile o modificata. In caso contrario, il cmdlet non genera alcun output.