about_Scopes

Korte beschrijving

In dit rapport wordt het concept van bereik in PowerShell uitgelegd en wordt uitgelegd hoe u het bereik van elementen in kunt stellen en wijzigen.

Lange beschrijving

PowerShell beschermt de toegang tot variabelen, aliassen, functies en PowerShell-stations (PSDrives) door te beperken waar ze kunnen worden gelezen en gewijzigd. PowerShell maakt gebruik van bereikregels om ervoor te zorgen dat u niet per ongeluk een item wijzigt dat niet mag worden gewijzigd.

Hier volgen de basisregels van het bereik:

  • Scopes kunnen worden genest. Een buitenste bereik wordt een bovenliggend bereik genoemd. Geneste scopes zijn onderliggende scopes van dat bovenliggende bereik.

  • Een item is zichtbaar in het bereik waarin het is gemaakt en in onderliggende scopes, tenzij u het expliciet privé maakt.

  • U kunt variabelen, aliassen, functies en PowerShell-stations declareeren binnen een bereik dat buiten het huidige bereik valt.

  • Een item dat u binnen een bereik hebt gemaakt, kan alleen worden gewijzigd in het bereik waarin het is gemaakt, tenzij u expliciet een ander bereik opgeeft.

Als u een item in een bereik maakt en het item de naam deelt met een item in een ander bereik, is het oorspronkelijke item mogelijk verborgen onder het nieuwe item, maar wordt het niet overschrijven of gewijzigd.

PowerShell-scopes

PowerShell ondersteunt de volgende scopes:

  • Globaal: het bereik dat van kracht is wanneer PowerShell wordt gestart of wanneer u een nieuwe sessie of runspace maakt. Variabelen en functies die aanwezig zijn wanneer PowerShell wordt gestart, zijn gemaakt in het globale bereik, zoals automatische variabelen en voorkeursvariabelen. De variabelen, aliassen en functies in uw PowerShell-profielen worden ook gemaakt in het globale bereik. Het globale bereik is het bovenliggende hoofdbereik in een sessie.

  • Lokaal: Het huidige bereik. Het lokale bereik kan het globale bereik of een ander bereik zijn.

  • Script: het bereik dat wordt gemaakt terwijl een scriptbestand wordt uitgevoerd. Alleen de opdrachten in het script worden uitgevoerd in het scriptbereik. Voor de opdrachten in een script is het scriptbereik het lokale bereik.

Notitie

Privé is geen bereik. Het is een optie die de zichtbaarheid van een item wijzigt buiten het bereik waarin het item is gedefinieerd.

Bovenliggende en onderliggende scopes

U kunt een nieuw onderliggend bereik maken door een script of functie aan te roepen. Het aanroepende bereik is het bovenliggende bereik. Het aangeroepen script of de functie is het onderliggende bereik. De functies of scripts die u aanroept, kunnen andere functies aanroepen, waardoor een hiërarchie van onderliggende scopes wordt aanroepen waarvan het hoofdbereik het globale bereik is.

Tenzij u de items expliciet privé maakt, zijn de items in het bovenliggende bereik beschikbaar voor het onderliggende bereik. Items die u maakt en wijzigt in het onderliggende bereik hebben echter geen invloed op het bovenliggende bereik, tenzij u het bereik expliciet opgeeft wanneer u de items maakt.

Notitie

Functies uit een module worden niet uitgevoerd in een onderliggend bereik van het aanroepende bereik. Modules hebben hun eigen sessietoestand die is gekoppeld aan het globale bereik. Alle modulecode wordt uitgevoerd in een modulespecifieke hiërarchie van scopes met een eigen hoofdbereik.

Overname

Een onderliggend bereik neemt de variabelen, aliassen en functies van het bovenliggende bereik niet over. Tenzij een item privé is, kan het onderliggende bereik de items in het bovenliggende bereik weergeven. En het kan de items wijzigen door expliciet het bovenliggende bereik op te geven, maar de items maken geen deel uit van het onderliggende bereik.

Er wordt echter een onderliggend bereik gemaakt met een set items. Normaal gesproken bevat het alle aliassen die de optie AllScope hebben. Deze optie wordt verder op dit artikel besproken. Het bevat alle variabelen die de optie AllScope hebben, plus enkele automatische variabelen.

Als u de items in een bepaald bereik wilt zoeken, gebruikt u de parameter Bereik van of Get-Variable Get-Alias.

Als u bijvoorbeeld alle variabelen in het lokale bereik wilt op halen, typt u:

Get-Variable -Scope local

Als u wilt alle variabelen in het globale bereik, typt u:

Get-Variable -Scope global

Bereikmodifiers

Een variabele, alias of functienaam kan een van de volgende optionele bereikmodifiers bevatten:

  • global: -Geeft aan dat de naam bestaat in het bereik Globaal .

  • local: -Geeft aan dat de naam bestaat in het lokale bereik. Het huidige bereik is altijd het lokale bereik.

  • private: - Hiermee geeft u op dat de naam Privé is en alleen zichtbaar is voor het huidige bereik.

  • script: -Geeft aan dat de naam bestaat in het bereik Script . Scriptbereik is het bereik van het dichtstbijzijnde overerfde scriptbestand of Globaal als er geen dichtstbijzijnde instuurscriptbestand is.

  • using: - Wordt gebruikt voor toegang tot variabelen die zijn gedefinieerd in een ander bereik tijdens het uitvoeren van scripts via cmdlets zoals Start-Job en Invoke-Command.

  • workflow: -Geeft aan dat de naam binnen een werkstroom bestaat. Opmerking: werkstromen worden niet ondersteund in PowerShell v6 en hoger.

  • <variable-namespace> - Een modifier die is gemaakt door een PowerShell PSDrive-provider. Bijvoorbeeld:

    Naamruimte Description
    Alias: Aliassen die zijn gedefinieerd in het huidige bereik
    Env: Omgevingsvariabelen die zijn gedefinieerd in het huidige bereik
    Function: Functies die zijn gedefinieerd in het huidige bereik
    Variable: Variabelen die zijn gedefinieerd in het huidige bereik

Het standaardbereik voor scripts is het scriptbereik. Het standaardbereik voor functies en aliassen is het lokale bereik, zelfs als deze zijn gedefinieerd in een script.

Bereikmodifiers gebruiken

Gebruik een bereikmodifier om het bereik van een nieuwe variabele, alias of functie op te geven.

De syntaxis voor een bereikmodifier in een variabele is:

$[<scope-modifier>:]<name> = <value>

De syntaxis voor een bereikmodifier in een functie is:

function [<scope-modifier>:]<name> {<function-body>}

Met de volgende opdracht, die geen bereikmodifier gebruikt, maakt u een variabele in het huidige of lokale bereik:

$a = "one"

Als u dezelfde variabele in het globale bereik wilt maken, gebruikt u de scope-modifier global: :

$global:a = "one"

Als u dezelfde variabele in het scriptbereik wilt maken, gebruikt u de script: scope-modifier:

$script:a = "one"

U kunt ook een bereikmodifier gebruiken met functies. Met de volgende functiedefinitie maakt u een functie in het globale bereik:

function global:Hello {
  Write-Host "Hello, World"
}

U kunt ook bereikmodifiers gebruiken om te verwijzen naar een variabele in een ander bereik. De volgende opdracht verwijst naar de $test variabele, eerst in het lokale bereik en vervolgens in het globale bereik:

$test
$global:test

De Using: scope-modifier

Het gebruik van is een speciale bereikmodifier die een lokale variabele in een externe opdracht identificeert. Zonder een modifier verwacht PowerShell dat variabelen in externe opdrachten moeten worden gedefinieerd in de externe sessie.

De Using scope-modifier is geïntroduceerd in PowerShell 3.0.

Voor elk script of elke opdracht die buiten de sessie wordt uitgevoerd, Using hebt u de scope-modifier nodig om variabele waarden uit het aanroepen van het sessiebereik in te kunnensluiten, zodat buiten sessiecode toegang heeft tot deze waarden. De Using scope-modifier wordt ondersteund in de volgende contexten:

  • Extern uitgevoerde opdrachten, gestart met de Invoke-Command parameters ComputerName, HostName, SSHConnection of Session (externe sessie)
  • Achtergrondtaken, gestart met Start-Job (out-of-process sessie)
  • Threadtaken, gestart via Start-ThreadJob of ForEach-Object -Parallel (afzonderlijke threadsessie)

Afhankelijk van de context zijn ingesloten variabelewaarden onafhankelijke kopieën van de gegevens in het bereik van de aanroeper of verwijzingen naar de gegevens. In externe en niet-verwerkte sessies zijn het altijd onafhankelijke kopieën.

Zie voor meer informatie about_Remote_Variables.

In threadsessies worden ze doorgegeven met verwijzing. Dit betekent dat het mogelijk is om aanroepbereikvariabelen in een andere thread te wijzigen. Voor het veilig wijzigen van variabelen is threadsynchronisatie vereist.

Zie voor meer informatie:

Serialisatie van variabele waarden

Extern uitgevoerde opdrachten en achtergrondtaken zijn niet meer verwerkt. Out-of-process-sessies maken gebruik van serialisatie en deserialisatie op basis van XML om de waarden van variabelen beschikbaar te maken buiten de procesgrenzen. Het serialisatieproces converteert objecten naar een PSObject dat de eigenschappen van de oorspronkelijke objecten bevat, maar niet de methoden.

Voor een beperkte set typen worden objecten door deserialisatie gerehydrateerd naar het oorspronkelijke type. Het gerehydrateerd object is een kopie van het oorspronkelijke objectexemplaar. Deze heeft de typeeigenschappen en -methoden. Voor eenvoudige typen, zoals System.Version, is de kopie exact. Voor complexe typen is de kopie niet perfect. Gerehydrateerd certificaatobjecten bevatten bijvoorbeeld niet de persoonlijke sleutel.

Exemplaren van alle andere typen zijn PSObject-exemplaren . De eigenschap PSTypeNames bevat de oorspronkelijke typenaam met het voorvoegsel Deserialized, bijvoorbeeld Deserialized.System.Data.DataTable

De optie AllScope

Variabelen en aliassen hebben een eigenschap Option die een waarde van AllScope kan hebben. Items met de eigenschap AllScope worden onderdeel van onderliggende scopes die u maakt, hoewel ze niet met terugwerkende kracht worden overgenomen door bovenliggende scopes.

Een item met de eigenschap AllScope is zichtbaar in het onderliggende bereik en maakt deel uit van dat bereik. Wijzigingen in het item in een bereik zijn van invloed op alle scopes waarin de variabele is gedefinieerd.

Bereik beheren

Verschillende cmdlets hebben een bereikparameter waarmee u items in een bepaald bereik kunt krijgen of instellen (maken en wijzigen). Gebruik de volgende opdracht om alle cmdlets in uw sessie te vinden die een bereikparameter hebben:

Get-Help * -Parameter scope

Gebruik de parameter van om de variabelen te vinden die zichtbaar zijn in een Scope bepaald bereik Get-Variable. De zichtbare variabelen omvatten globale variabelen, variabelen in het bovenliggende bereik en variabelen in het huidige bereik.

Met de volgende opdracht haalt u bijvoorbeeld de variabelen op die zichtbaar zijn in het lokale bereik:

Get-Variable -Scope local

Als u een variabele in een bepaald bereik wilt maken, gebruikt u een scope-modifier of de parameter Scope van Set-Variable. Met de volgende opdracht maakt u een variabele in het globale bereik:

New-Variable -Scope global -Name a -Value "One"

U kunt ook de parameter Bereik van de cmdlets , Get-Alias Set-Aliasof New-Aliasgebruiken om het bereik op te geven. Met de volgende opdracht maakt u een alias in het globale bereik:

New-Alias -Scope global -Name np -Value Notepad.exe

Als u de functies in een bepaald bereik wilt op halen, gebruikt u de Get-Item cmdlet wanneer u zich in het bereik. De Get-Item cmdlet heeft geen bereikparameter .

Notitie

Voor de cmdlets die gebruikmaken van de parameter Scope , kunt u ook verwijzen naar bereiken op nummer. Het getal beschrijft de relatieve positie van het ene bereik ten opzichte van het andere. Bereik 0 vertegenwoordigt het huidige of lokale bereik. Bereik 1 geeft het directe bovenliggende bereik aan. Bereik 2 geeft het bovenliggende bovenliggende bereik aan, en meer. Genummerde scopes zijn handig als u veel recursieve scopes hebt gemaakt.

Dot Source Notation gebruiken met bereik

Scripts en functies volgen alle bereikregels. U maakt ze in een bepaald bereik en ze zijn alleen van invloed op dat bereik, tenzij u een cmdlet-parameter of een bereikwijzigingsparameter gebruikt om dat bereik te wijzigen.

U kunt echter een script of functie toevoegen aan het huidige bereik met behulp van een puntbron-notatie. Wanneer een script vervolgens wordt uitgevoerd in het huidige bereik, zijn alle functies, aliassen en variabelen die door het script worden gemaakt, beschikbaar in het huidige bereik.

Als u een functie wilt toevoegen aan het huidige bereik, typt u een punt (.) en een spatie vóór het pad en de naam van de functie in de functie-aanroep.

Als u bijvoorbeeld het script Sample.ps1 uitvoeren vanuit de map C:\Scripts in het scriptbereik (de standaardinstelling voor scripts), gebruikt u de volgende opdracht:

c:\scripts\sample.ps1

Gebruik de volgende opdracht om Sample.ps1 script uit te voeren in het lokale bereik:

. c:\scripts.sample.ps1

Wanneer u de aanroepoperator (&) gebruikt om een functie of script uit te voeren, wordt deze niet toegevoegd aan het huidige bereik. In het volgende voorbeeld wordt de aanroepoperator gebruikt:

& c:\scripts.sample.ps1

Meer informatie over de aanroepoperator vindt u in about_operators.

Aliassen, functies of variabelen die door het Sample.ps1 script worden gemaakt, zijn niet beschikbaar in het huidige bereik.

Beperken zonder bereik

Enkele PowerShell-concepten zijn vergelijkbaar met bereik of interactie met bereik. Deze concepten kunnen worden verward met bereik of het gedrag van het bereik.

Sessies, modules en geneste prompts zijn zelfstandige omgevingen, maar ze zijn geen onderliggende scopes van het globale bereik in de sessie.

Sessies

Een sessie is een omgeving waarin PowerShell wordt uitgevoerd. Wanneer u een sessie op een externe computer maakt, maakt PowerShell een permanente verbinding met de externe computer. Met de permanente verbinding kunt u de sessie gebruiken voor meerdere gerelateerde opdrachten.

Omdat een sessie een ingesloten omgeving is, heeft deze een eigen bereik, maar een sessie is geen onderliggend bereik van de sessie waarin deze is gemaakt. De sessie begint met een eigen globaal bereik. Dit bereik is onafhankelijk van het globale bereik van de sessie. U kunt onderliggende scopes maken in de sessie. U kunt bijvoorbeeld een script uitvoeren om een onderliggend bereik in een sessie te maken.

Modules

U kunt een PowerShell-module gebruiken om PowerShell-hulpprogramma's te delen en te leveren. Een module is een eenheid die cmdlets, scripts, functies, variabelen, aliassen en andere nuttige items kan bevatten. Tenzij expliciet gedefinieerd, zijn de items in een module niet toegankelijk buiten de module. Daarom kunt u de module toevoegen aan uw sessie en de openbare items gebruiken zonder dat u zich zorgen hoeft te maken dat de andere items de cmdlets, scripts, functies en andere items in uw sessie kunnen overschrijven.

Modules worden standaard geladen in het hoogste niveau van de huidige sessietoestand , niet in het huidige bereik. De huidige sessietoestand kan een modulesessietoestand of de globale sessietoestand zijn. Als u een module aan een sessie toevoegt, verandert het bereik niet. Als u zich in het globale bereik, worden modules geladen in de status van de globale sessie. Alle exports worden in de globale tabellen geplaatst. Als u module2 vanuit module1 laadt, wordt module2 in de sessietoestand van module1 geladen, niet de globale sessietoestand. Exporten van module2 worden bovenaan de sessietoestand module1 geplaatst. Als u gebruikt Import-Module -Scope local, worden de exports in het huidige bereikobject geplaatst in plaats van op het hoogste niveau. Als u een module Import-Module -Scope global gebruikt en ( Import-Module -Globalof ) gebruikt om een andere module te laden, worden die module en de exports ervan geladen in de globale sessietoestand in plaats van de lokale sessietoestand van de module. Deze functie is ontworpen voor het schrijven van modules die modules bewerken. De module WindowsCompatibility doet dit om proxymodules te importeren in de algemene sessietoestand.

Binnen de sessietoestand hebben modules hun eigen bereik. Kijk eens naar de volgende module C:\temp\mod1.psm1:

$a = "Hello"

function foo {
    "`$a = $a"
    "`$global:a = $global:a"
}

Nu maken we een globale variabele , $ageven we deze een waarde en roepen we de functie foo aan.

$a = "Goodbye"
foo

De module declareer de variabele $a in het modulebereik en vervolgens wordt met de functie foo de waarde van de variabele in beide scopes uitgevoerd.

$a = Hello
$global:a = Goodbye

Geneste prompts

Geneste prompts hebben geen eigen bereik. Wanneer u een geneste prompt op typt, is de geneste prompt een subset van de omgeving. Maar u blijft binnen het lokale bereik.

Scripts hebben hun eigen bereik. Als u een script debugt en u een onderbrekingspunt in het script bereikt, voert u het scriptbereik in.

Persoonlijke optie

Aliassen en variabelen hebben een eigenschap Option die de waarde Privé kan hebben. Items met de optie Privé kunnen worden bekeken en gewijzigd in het bereik waarin ze worden gemaakt, maar ze kunnen niet buiten dat bereik worden bekeken of gewijzigd.

Als u bijvoorbeeld een variabele maakt die een persoonlijke optie in het globale bereik heeft en vervolgens een script uit te voeren, Get-Variable wordt de persoonlijke variabele niet weergegeven met opdrachten in het script. Als u in dit geval de globale scope-modifier gebruikt, wordt de persoonlijke variabele niet weergegeven.

U kunt de parameter Option van de New-Variablecmdlets , Set-Variable, New-Aliasen Set-Alias gebruiken om de waarde van de eigenschap Option in te stellen op Privé.

Zichtbaarheid

De eigenschap Zichtbaarheid van een variabele of alias bepaalt of u het item buiten de container kunt zien waarin het is gemaakt. Een container kan een module, script of module zijn. Zichtbaarheid is ontworpen voor containers op dezelfde manier als de persoonlijke waarde van de eigenschap Optie is ontworpen voor scopes.

De eigenschap Zichtbaarheid heeft de waarden Openbaar en Privé . Items met persoonlijke zichtbaarheid kunnen alleen worden bekeken en gewijzigd in de container waarin ze zijn gemaakt. Als de container wordt toegevoegd of geïmporteerd, kunnen de items met persoonlijke zichtbaarheid niet worden bekeken of gewijzigd.

Omdat zichtbaarheid is ontworpen voor containers, werkt het anders binnen een bereik.

  • Als u een item maakt met persoonlijke zichtbaarheid in het globale bereik, kunt u het item in geen enkel bereik weergeven of wijzigen.
  • Als u probeert de waarde van een variabele met persoonlijke zichtbaarheid weer te geven of te wijzigen, retourneert PowerShell een foutbericht.

U kunt de New-Variable cmdlets en Set-Variable gebruiken om een variabele te maken die persoonlijke zichtbaarheid heeft.

Voorbeelden

Voorbeeld 1: Een variabele waarde alleen wijzigen in een script

Met de volgende opdracht wordt de waarde van de variabele $ConfirmPreference in een script gewijzigd. De wijziging heeft geen invloed op het globale bereik.

Gebruik eerst de volgende opdracht om de waarde van de $ConfirmPreference variabele in het lokale bereik weer te geven:

PS>  $ConfirmPreference
High

Maak een Scope.ps1 script dat de volgende opdrachten bevat:

$ConfirmPreference = "Low"
"The value of `$ConfirmPreference is $ConfirmPreference."

Voer het script uit. Het script wijzigt de waarde van de variabele $ConfirmPreference en rapporteert vervolgens de waarde ervan in het scriptbereik. De uitvoer moet lijken op de volgende uitvoer:

The value of $ConfirmPreference is Low.

Test vervolgens de huidige waarde van de variabele $ConfirmPreference in het huidige bereik.

PS>  $ConfirmPreference
High

In dit voorbeeld ziet u dat wijzigingen in de waarde van een variabele in het scriptbereik geen invloed hebben op de waarde van de variabele in het bovenliggende bereik.

Voorbeeld 2: Een variabele waarde in verschillende scopes weergeven

U kunt bereikmodifiers gebruiken om de waarde van een variabele in het lokale bereik en in een bovenliggend bereik weer te geven.

Definieer eerst een $test variabele in het globale bereik.

$test = "Global"

Maak vervolgens een Sample.ps1 script dat de variabele definieert $test . Gebruik in het script een bereikmodifier om te verwijzen naar de globale of lokale versies van de $test variabele.

In Sample.ps1:

$test = "Local"
"The local value of `$test is $test."
"The global value of `$test is $global:test."

Wanneer u een Sample.ps1, moet de uitvoer lijken op de volgende uitvoer:

The local value of $test is Local.
The global value of $test is Global.

Wanneer het script is voltooid, wordt alleen de globale waarde van $test gedefinieerd in de sessie.

PS>  $test
Global

Voorbeeld 3: de waarde van een variabele in een bovenliggend bereik wijzigen

Tenzij u een item bebeveiligen met behulp van de optie Privé of een andere methode, kunt u de waarde van een variabele in een bovenliggend bereik weergeven en wijzigen.

Definieer eerst een $test variabele in het globale bereik.

$test = "Global"

Maak vervolgens een Sample.ps1 script dat de variabele definieert $test . Gebruik in het script een bereikmodifier om te verwijzen naar de globale of lokale versies van de $test variabele.

In Sample.ps1:

$global:test = "Local"
"The global value of `$test is $global:test."

Wanneer het script is voltooid, wordt de globale waarde van $test gewijzigd.

PS>  $test
Local

Voorbeeld 4: Een persoonlijke variabele maken

Een persoonlijke variabele is een variabele met de eigenschap Option met de waarde Privé. Persoonlijke variabelen worden overgenomen door het onderliggende bereik, maar ze kunnen alleen worden bekeken of gewijzigd in het bereik waarin ze zijn gemaakt.

Met de volgende opdracht maakt u een persoonlijke variabele met de naam $ptest in het lokale bereik.

New-Variable -Name ptest -Value 1 -Option private

U kunt de waarde van weergeven en wijzigen $ptest in het lokale bereik.

PS>  $ptest
1

PS>  $ptest = 2
PS>  $ptest
2

Maak vervolgens een Sample.ps1 script dat de volgende opdrachten bevat. Met de opdracht wordt geprobeerd om de waarde van weer te geven en te wijzigen $ptest.

In Sample.ps1:

"The value of `$Ptest is $Ptest."
"The value of `$Ptest is $global:Ptest."

De $ptest variabele is niet zichtbaar in het scriptbereik. De uitvoer is leeg.

"The value of $Ptest is ."
"The value of $Ptest is ."

Voorbeeld 5: Een lokale variabele gebruiken in een externe opdracht

Gebruik de scope-modifier voor variabelen in een externe opdracht die in de lokale Using sessie is gemaakt. PowerShell gaat ervan uit dat de variabelen in externe opdrachten zijn gemaakt in de externe sessie.

De syntaxis is:

$Using:<VariableName>

Met de volgende opdrachten maakt u bijvoorbeeld een variabele $Cred in de lokale sessie en gebruikt u de variabele $Cred in een externe opdracht:

$Cred = Get-Credential
Invoke-Command $s {Remove-Item .\Test*.ps1 -Credential $Using:Cred}

Het bereik Using is geïntroduceerd in PowerShell 3.0. Gebruik in PowerShell 2.0 de volgende opdrachtindeling om aan te geven dat er een variabele is gemaakt in de lokale sessie.

$Cred = Get-Credential
Invoke-Command $s {
  param($c)
  Remove-Item .\Test*.ps1 -Credential $c
} -ArgumentList $Cred

Zie ook