New-Variable
Hiermee maakt u een nieuwe variabele.
Syntaxis
Default (Standaard)
New-Variable
[-Name] <String>
[[-Value] <Object>]
[-Description <String>]
[-Option <ScopedItemOptions>]
[-Visibility <SessionStateEntryVisibility>]
[-Force]
[-PassThru]
[-Scope <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Met de New-Variable-cmdlet maakt u een nieuwe variabele in PowerShell. U kunt een waarde toewijzen aan de variabele tijdens het maken of de waarde toewijzen of wijzigen nadat deze is gemaakt.
U kunt de parameters van New-Variable gebruiken om de eigenschappen van de variabele in te stellen, het bereik van een variabele in te stellen en te bepalen of variabelen openbaar of privé zijn.
Normaal gesproken maakt u een nieuwe variabele door de naam van de variabele en de bijbehorende waarde te typen, zoals $Var = 3, maar u kunt de cmdlet New-Variable gebruiken om de parameters te gebruiken.
Voorbeelden
Voorbeeld 1: Een variabele maken
New-Variable days
Met deze opdracht maakt u een nieuwe variabele met de naam dagen. U hoeft de parameter Name niet te typen.
Voorbeeld 2: Een variabele maken en deze een waarde toewijzen
New-Variable -Name "zipcode" -Value 98033
Met deze opdracht maakt u een variabele met de naam postcode en wijst u deze toe aan de waarde 98033.
Voorbeeld 3: Een variabele maken met de optie 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 dit voorbeeld ziet u hoe u de ReadOnly optie van New-Variable gebruikt om een variabele te beschermen tegen overschrijven.
Met de eerste opdracht maakt u een nieuwe variabele met de naam Max en stelt u de waarde in op 256. Hierbij wordt de parameter Option gebruikt met een waarde van ReadOnly.
Met de tweede opdracht wordt geprobeerd een tweede variabele met dezelfde naam te maken. Met deze opdracht wordt een fout geretourneerd, omdat de optie alleen-lezen is ingesteld op de variabele.
De derde opdracht maakt gebruik van de parameter Forceren om de alleen-lezenbeveiliging voor de variabele te overschrijven. In dit geval slaagt de opdracht om een nieuwe variabele met dezelfde naam te maken.
Voorbeeld 4: Meerdere opties toewijzen aan een variabele
New-Variable -Name 'TestVariable' -Value 'Test Value' -Option AllScope,Constant
In dit voorbeeld wordt een variabele gemaakt en worden de opties AllScope en Constant toegewezen, zodat de variabele beschikbaar is in het huidige bereik en nieuwe bereiken die zijn gemaakt en niet kunnen worden gewijzigd of verwijderd.
Voorbeeld 5: Een privévariabele maken
Met deze opdracht wordt het gedrag van een privévariabele in een module gedemonstreert. De module bevat de Get-Counter cmdlet, met een privévariabele met de naam Counter. De opdracht maakt gebruik van de parameter Visibility met de waarde Private om de variabele te maken.
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
...
In de voorbeelduitvoer ziet u het gedrag van een privévariabele. De gebruiker die de module heeft geladen, kan de waarde van de tellervariabele niet weergeven of wijzigen, maar de tellervariabele kan worden gelezen en gewijzigd door de opdrachten in de module.
Voorbeeld 6: Een variabele maken met een spatie
In dit voorbeeld ziet u dat variabelen met spaties kunnen worden gemaakt. De variabelen kunnen worden geopend met behulp van de cmdlet Get-Variable of rechtstreeks door een variabele met accolades te scheiden.
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
Parameters
-Confirm
Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | False |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
| Aliassen: | Cf |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Description
Hiermee geeft u een beschrijving van de variabele.
Parametereigenschappen
| Type: | String |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Force
Geeft aan dat de cmdlet een variabele met dezelfde naam maakt als een bestaande alleen-lezenvariabele.
Standaard kunt u een variabele overschrijven, tenzij de variabele een optiewaarde van ReadOnly of Constantheeft. Zie de parameter Option voor meer informatie.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Name
Hiermee geeft u een naam voor de nieuwe variabele.
Parametereigenschappen
| Type: | String |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | 0 |
| Verplicht: | True |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | True |
| Waarde van resterende argumenten: | False |
-Option
Hiermee geeft u de waarde van de eigenschap Options van de variabele. De acceptabele waarden voor deze parameter zijn:
-
None- Hiermee stelt u geen opties in.Noneis de standaardwaarde. -
ReadOnly: kan worden verwijderd. Kan niet worden gewijzigd, behalve met behulp van de parameter Force. -
Private: de variabele is alleen beschikbaar in het huidige bereik. -
AllScope: de variabele wordt gekopieerd naar nieuwe bereiken die worden gemaakt. -
Constant: kan niet worden verwijderd of gewijzigd.Constantis alleen geldig wanneer u een variabele maakt. U kunt de opties van een bestaande variabele niet wijzigen inConstant.
Deze waarden worden gedefinieerd als een opsomming op basis van vlaggen. U kunt meerdere waarden combineren om meerdere vlaggen in te stellen met behulp van deze parameter. De waarden kunnen worden doorgegeven aan de parameter Option als een matrix met waarden of als een door komma's gescheiden tekenreeks van deze waarden. De cmdlet combineert de waarden met behulp van een binaire OF-bewerking. Het doorgeven van waarden als een matrix is de eenvoudigste optie en u kunt ook tabvoltooiing gebruiken voor de waarden.
Als u de eigenschap Opties van alle variabelen in de sessie wilt zien, typt u Get-Variable | Format-Table -Property Name, Options -AutoSize.
Parametereigenschappen
| Type: | ScopedItemOptions |
| Default value: | None |
| Geaccepteerde waarden: | None, ReadOnly, Constant, Private, AllScope, Unspecified |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-PassThru
Retourneert een object dat het item aangeeft waarmee u werkt. Deze cmdlet genereert standaard geen uitvoer.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Scope
Hiermee geeft u het bereik van de nieuwe variabele. De acceptabele waarden voor deze parameter zijn:
-
Global: variabelen die in het globale bereik zijn gemaakt, zijn overal toegankelijk in een PowerShell-proces. -
Local: het lokale bereik verwijst naar het huidige bereik. Dit kan elk bereik zijn, afhankelijk van de context.Localis het standaardbereik wanneer de bereikparameter niet is opgegeven. -
Script: variabelen die in het scriptbereik zijn gemaakt, zijn alleen toegankelijk binnen het scriptbestand of de module waarin ze zijn gemaakt. - Een getal ten opzichte van het huidige bereik (0 tot het aantal bereiken, waarbij 0 het huidige bereik is, 1 het bovenliggende bereik, 2 het bovenliggende bereik, enzovoort). Negatieve getallen kunnen niet worden gebruikt.
Opmerking
De parameter accepteert ook de waarde van Private.
Private is geen bereik, maar een optionele instelling voor een variabele. Het gebruik van de Private-waarde met deze cmdlet wijzigt echter niet de zichtbaarheid van de variabele. Zie about_Scopesvoor meer informatie.
Parametereigenschappen
| Type: | String |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-Value
Hiermee geeft u de initiële waarde van de variabele.
Parametereigenschappen
| Type: | Object |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | 1 |
| Verplicht: | False |
| Waarde uit pijplijn: | True |
| Waarde uit pijplijn op eigenschapsnaam: | True |
| Waarde van resterende argumenten: | False |
-Visibility
Bepaalt of de variabele zichtbaar is buiten de sessie waarin deze is gemaakt. Deze parameter is ontworpen voor gebruik in scripts en opdrachten die aan andere gebruikers worden geleverd. De acceptabele waarden voor deze parameter zijn:
-
Public: de variabele is zichtbaar.Publicis de standaardwaarde. -
Private: de variabele is niet zichtbaar.
Wanneer een variabele privé is, wordt deze niet weergegeven in lijsten met variabelen, zoals variabelen die worden geretourneerd door Get-Variableof in weergaven van het Variable: station. Opdrachten voor het lezen of wijzigen van de waarde van een privévariabele retourneren een fout. De gebruiker kan echter opdrachten uitvoeren die gebruikmaken van een privévariabele als de opdrachten zijn geschreven in de sessie waarin de variabele is gedefinieerd.
Parametereigenschappen
| Type: | SessionStateEntryVisibility |
| Default value: | None |
| Geaccepteerde waarden: | Public, Private |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-WhatIf
Toont wat er zou gebeuren wanneer de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | False |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
| Aliassen: | Wi |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
CommonParameters
Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.
Invoerwaarden
Object
U kunt elk object doorslangen naar New-Variable.
Uitvoerwaarden
None
Deze cmdlet retourneert standaard geen uitvoer.
PSVariable
Wanneer u de parameter PassThru gebruikt, retourneert deze cmdlet een PSVariable-object dat de nieuwe variabele vertegenwoordigt.
Notities
PowerShell bevat de volgende aliassen voor New-Variable:
- Alle platforms:
nv