Sdílet prostřednictvím

o_obecných_Parametrech

Krátký popis

Popisuje parametry, které lze použít s libovolnou rutinou.

Dlouhý popis

Běžné parametry jsou sada parametrů rutiny, které můžete použít s libovolnou rutinou. Implementují se v PowerShellu, ne vývojáři rutin a jsou automaticky dostupné pro libovolnou rutinu.

Běžné parametry můžete použít s libovolnou rutinou, ale nemusí mít vliv na všechny rutiny. Pokud například rutina negeneruje žádný podrobný výstup, použití Verbose společného parametru nemá žádný vliv.

Společné parametry jsou k dispozici také u pokročilých funkcí, které používají atribut CmdletBinding nebo atribut Parameter .

Několik běžných parametrů přepisuje výchozí hodnoty systému nebo předvolby, které jste nastavili pomocí proměnných předvoleb PowerShellu. Na rozdíl od proměnných předvoleb mají společné parametry vliv jenom na příkazy, ve kterých se používají.

Další informace najdete v části about_Preference_Variables.

Následující seznam zobrazuje společné parametry. Jejich aliasy jsou uvedeny v závorkách.

  • Debug db)
  • ErrorAction (ea)
  • Chybová_proměnná (ev)
  • InformationAction (infa)
  • Informační_proměnná (iv)
  • OutVariable (ov)
  • Výstupní vyrovnávací paměť (ob)
  • Proměnná potrubí (pv)
  • Verbose vb)
  • WarningAction (wa)
  • WarningVariable (wv)

Parametry akce jsou hodnoty typu ActionPreference . ActionPreference je výčet s následujícími hodnotami:

Název Hodnota
Break 6
Suspend 5
Ignore 4
Inquire 3
Continue 2
Stop 1
SilentlyContinue 0

Název nebo hodnotu můžete použít s parametrem.

Kroměběžnýchch Rutiny, které zahrnují riziko pro systém nebo uživatelská data, obvykle nabízejí tyto parametry.

Parametry zmírnění rizik jsou:

  • WhatIf (wi)
  • Confirm (cf)

Běžné popisy parametrů

-Debug

Zobrazí podrobnosti na úrovni programátora o operaci provedené příkazem. Tento parametr funguje pouze v případě, že příkaz vygeneruje zprávu ladění. Tento parametr například funguje, když příkaz obsahuje rutinu Write-Debug .

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

Ve výchozím nastavení nejsou zprávy ladění zobrazeny, protože hodnota $DebugPreference proměnné je SilentlyContinue.

Parametr Debug přepíše hodnotu $DebugPreference proměnné pro aktuální příkaz a nastaví hodnotu $DebugPreference continue.

-Debug:$true má stejný účinek jako -Debug. Slouží -Debug:$false k potlačení zobrazení zpráv ladění, pokud $DebugPreference není Bezobslužná Funkce, což je výchozí nastavení.

-ErrorAction (Chybová akce)

Určuje, jak rutina reaguje na neukončující chybu z příkazu. Tento parametr funguje jenom v případě, že příkaz vygeneruje neukončující chybu, například chybu z rutiny Write-Error .

Type: ActionPreference
Aliases: ea
Accepted values: Break, Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue
Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

Parametr ErrorAction přepíše hodnotu $ErrorActionPreference proměnné pro aktuální příkaz. Vzhledem k tomu, že výchozí hodnota $ErrorActionPreference proměnné je Continue, zobrazí se chybové zprávy a provádění pokračuje, pokud nepoužíváte parametr ErrorAction .

Parametr ErrorAction nemá žádný vliv na ukončení chyb (například chybějící data, parametry, které nejsou platné nebo nedostatečná oprávnění), které brání úspěšnému dokončení příkazu.

  • Break Zadá ladicí program, když dojde k chybě nebo dojde k výjimce.
  • Continue zobrazí chybovou zprávu a pokračuje v provádění příkazu. Continue je výchozí.
  • Ignore potlačuje chybovou zprávu a pokračuje v provádění příkazu. Na rozdíl od silentlyContinue, Ignore nepřidá chybovou $Error zprávu do automatické proměnné. Hodnota Ignore je zavedena v PowerShellu 3.0.
  • Inquire zobrazí chybovou zprávu a před pokračováním v provádění vás vyzve k potvrzení. Tato hodnota se používá zřídka.
  • SilentlyContinue potlačuje chybovou zprávu a pokračuje v provádění příkazu.
  • Stop zobrazí chybovou zprávu a zastaví spuštění příkazu.
  • Suspend je k dispozici pouze pro pracovní postupy, které nejsou podporované v PowerShellu 6 a novějších verzích.

Poznámka:

Parametr ErrorAction přepíše, ale nenahrazuje hodnotu $ErrorActionPreference proměnné při použití parametru v příkazu ke spuštění skriptu nebo funkce.

-ChybováProměnná

Chybové záznamy se automaticky ukládají do $Error automatické proměnné. Viz about_Automatic_Variablespro více informací.

Pokud v příkazu použijete parametr ErrorVariable , PowerShell uloží také záznamy chyb generované příkazem v proměnné určené parametrem.

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

Ve výchozím nastavení nové chybové zprávy přepíší chybové zprávy, které jsou již uloženy v proměnné. Pokud chcete k obsahu proměnné připojit chybovou zprávu, před název proměnné vložte znaménko plus (+).

Například následující příkaz vytvoří proměnnou $a a uloží do ní všechny chyby:

Get-Process -Id 6 -ErrorVariable a

Následující příkaz přidá do $a proměnné všechny chybové zprávy:

Get-Process -Id 2 -ErrorVariable +a

Následující příkaz zobrazí obsah $a:

$a

Tento parametr můžete použít k vytvoření proměnné, která obsahuje pouze chybové zprávy z konkrétních příkazů a nemá vliv na chování $Error automatické proměnné. Automatická $Error proměnná obsahuje chybové zprávy ze všech příkazů v relaci. Maticový zápis můžete použít, například $a[0] odkazovat $error[1,2] na konkrétní chyby uložené v proměnných.

Poznámka:

Vlastní proměnná chyby obsahuje všechny chyby vygenerované příkazem, včetně chyb z volání vnořených funkcí nebo skriptů.

-Informační akce

Představeno v PowerShellu 5.0. V rámci příkazu nebo skriptu, ve kterém se používá, přepíše běžný parametr InformationAction hodnotu $InformationPreference proměnné předvolby, která je ve výchozím nastavení nastavena na SilentlyContinue. Při použití Write-Information ve skriptu s InformationAction se Write-Information hodnoty zobrazí v závislosti na hodnotě parametru InformationAction . Další informace o $InformationPreferencenaleznete v tématu about_Preference_Variables.

Type: ActionPreference
Aliases: infa
Accepted values: Break, Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue
Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False
  • Break Zadá ladicí program při výskytu Write-Information příkazu.
  • Stop zastaví příkaz nebo skript v výskytu Write-Information příkazu.
  • Ignore potlačuje informační zprávu a pokračuje ve spuštění příkazu. Na rozdíl od SilentlyContinue, Ignorovat zcela zapomene informační zprávu; nepřidá informační zprávu do informačního streamu.
  • Inquire zobrazí informační zprávu, kterou zadáte v Write-Information příkazu, a pak se zeptá, jestli chcete pokračovat.
  • Continue zobrazí informační zprávu a pokračuje ve spuštění.
  • Suspend PowerShell 6 a vyšší nepodporuje, protože je k dispozici jenom pro pracovní postupy.
  • SilentlyContinue Nezobrazují se žádné efekty, protože informační zpráva není zobrazená (výchozí) a skript pokračuje bez přerušení.

Poznámka:

Parametr InformationAction přepíše, ale nenahrazuje hodnotu $InformationAction proměnné předvolby, pokud se parametr používá v příkazu ke spuštění skriptu nebo funkce.

-InformačníProměnná

Představeno v PowerShellu 5.0. Při použití společného parametru InformationVariable se informační záznamy ukládají do proměnné určené parametrem. Rutina PowerShellu může zapisovat záznamy informací do datového proudu Informací . Rutinu můžete použít také k zápisu Write-Information informačních záznamů.

Informační záznamy se ve výchozím nastavení zobrazují jako zprávy v konzole. Zobrazení záznamu informací můžete řídit pomocí běžného parametru InformationAction . Chování můžete také změnit pomocí $InformationPreference proměnné předvoleb. Další informace o $InformationPreferencenaleznete v tématu about_Preference_Variables.

Poznámka:

Informační proměnná obsahuje všechny informační zprávy generované příkazem, včetně informačních zpráv z volání vnořených funkcí nebo skriptů.

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

Ve výchozím nastavení nový záznam informací přepíše hodnoty, které jsou již uloženy v proměnné. Pokud chcete k obsahu proměnné připojit chybovou zprávu, před název proměnné vložte znaménko plus (+).

-OutBuffer (Odchozí) vyrovnávací paměť

Určuje počet objektů, které se mají nahromadět ve vyrovnávací paměti před odesláním jakýchkoli objektů prostřednictvím kanálu. Pokud tento parametr vynecháte, objekty se posílají při jejich vygenerování.

Type: Int32
Aliases: ob
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

Tento parametr správy prostředků je určený pro pokročilé uživatele. Když použijete tento parametr, PowerShell odešle data do další rutiny v dávkách OutBuffer + 1.

Následující příklad alternativy se zobrazí mezi ForEach-Object procesem bloků, které používají rutinu Write-Host . Alternativy zobrazení v dávkách 2 nebo OutBuffer + 1.

1..4 | ForEach-Object {
        Write-Host "$($_): First"; $_
      } -OutBuffer 1 | ForEach-Object {
                        Write-Host "$($_): Second" }

1: First
2: First
1: Second
2: Second
3: First
4: First
3: Second
4: Second

-OutVariable

Ukládá výstupní objekty z příkazu do zadané proměnné kromě odesílání výstupu v kanálu.

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

Pokud chcete přidat výstup do proměnné, místo nahrazení jakéhokoli výstupu, který by tam mohl být již uložen, zadejte před název proměnné znaménko plus (+).

Například následující příkaz vytvoří proměnnou $out a uloží objekt procesu do něj:

Get-Process PowerShell -OutVariable out

Následující příkaz přidá objekt procesu do $out proměnné:

Get-Process iexplore -OutVariable +out

Následující příkaz zobrazí obsah $out proměnné:

$out

Poznámka:

Proměnná vytvořená parametrem OutVariable je .[System.Collections.ArrayList]

-Proměnná potrubí

PipelineVariable umožňuje přístup k nejnovější hodnotě předané do dalšího segmentu kanálu příkazem, který používá tento parametr. Jakýkoli příkaz v kanálu má přístup k hodnotě pomocí pojmenované PipelineVariable. Hodnota se přiřadí proměnné, když se předá do dalšího segmentu kanálu. To usnadňuje použití pipelineVariable než konkrétní dočasná proměnná, která může být potřeba přiřadit ve více umístěních.

Na rozdíl od $_ příkazu $PSItem nebo umožňuje použití příkazu PipelineVariable přístup k hodnotám kanálu předaným (a uloženým) jinými příkazy než bezprostředně předchozím příkazem. Příkazy kanálu mají přístup k poslední hodnotě předané při zpracování další položky procházející kanálem. To umožňuje příkazu nasílnout zpět svůj výstup do předchozího příkazu (nebo samotného).

Poznámka:

Pokročilé funkce mohou mít až tři bloky skriptu: begin, processa end. Při použití parametru PipelineVariable s pokročilými funkcemi se proměnné při spuštění funkce přiřadí pouze hodnoty z prvního definovaného bloku skriptu. Další informace naleznete v tématu Pokročilé funkce. PowerShell 7.2 toto chování opraví.

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

Platné hodnoty jsou řetězce, stejné jako u názvů proměnných.

Upozornění

Parametr PipelineVariable je vymezený na kanál, ve kterém je vyvolán. Proměnné mimo kanál, které používají stejný název, se před spuštěním kanálu vymažou. Při ukončení kanálu dojde k výpadku rozsahu PipelineVariable . Pokud několik příkazů v kanálu určuje stejnou hodnotu PipelineVariable , existuje pouze jedna sdílená proměnná. Tato proměnná se aktualizuje nejnovějším výstupem kanálu z příkazu, který tuto proměnnou určuje.

Některé blokující příkazy shromažďují všechny položky kanálu před vytvořením jakéhokoli výstupu, například Sort-ObjectSelect-Object -Last. Všechny kanályVariable přiřazené v příkazu před takovým blokovacím příkazem vždy obsahují konečnou předanou položku z předchozího příkazu, pokud se použije v příkazu za příkazem blokování.

Následuje příklad fungování PipelineVariable . V tomto příkladu , který uloží výsledky příkazu do proměnných. Rozsah čísel 1 až 5 se předá do prvního Foreach-Object příkazu, jehož výsledky jsou uloženy v proměnné s názvem $temp.

Výsledky prvního Foreach-Object příkazu se předávají do druhého Foreach-Object příkazu, který zobrazuje aktuální hodnoty $temp a $_.

# Create a variable named $temp
$temp=8
Get-Variable temp
# Note that the variable just created isn't available on the
# pipeline when -PipelineVariable creates the same variable name
1..5 | ForEach-Object -PipelineVariable temp -Begin {
    Write-Host "Step1[BEGIN]:`$temp=$temp"
} -Process {
  Write-Host "Step1[PROCESS]:`$temp=$temp - `$_=$_"
  Write-Output $_
} | ForEach-Object {
  Write-Host "`tStep2[PROCESS]:`$temp=$temp - `$_=$_"
}
# The $temp variable is deleted when the pipeline finishes
Get-Variable temp

Name                           Value
----                           -----
temp                           8

Step1[BEGIN]:$temp=
Step1[PROCESS]:$temp= - $_=1
        Step2[PROCESS]:$temp=1 - $_=1
Step1[PROCESS]:$temp=1 - $_=2
        Step2[PROCESS]:$temp=2 - $_=2
Step1[PROCESS]:$temp=2 - $_=3
        Step2[PROCESS]:$temp=3 - $_=3
Step1[PROCESS]:$temp=3 - $_=4
        Step2[PROCESS]:$temp=4 - $_=4
Step1[PROCESS]:$temp=4 - $_=5
        Step2[PROCESS]:$temp=5 - $_=5

Name                           Value
----                           -----
temp

-Verbose

Zobrazí podrobné informace o operaci provedené příkazem. Tyto informace se podobají informacím v trasování nebo v transakčním protokolu. Tento parametr funguje pouze v případě, že příkaz vygeneruje podrobnou zprávu. Tento parametr například funguje, když příkaz obsahuje rutinu Write-Verbose .

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

Parametr Verbose přepíše hodnotu $VerbosePreference proměnné pro aktuální příkaz. Vzhledem k tomu, že výchozí hodnota $VerbosePreference proměnné je SilentlyContinue, podrobné zprávy se ve výchozím nastavení nezobrazují.

  • -Verbose:$true má stejný účinek jako -Verbose
  • -Verbose:$false potlačí zobrazení podrobných zpráv. Tento parametr použijte, pokud hodnota $VerbosePreference není SilentlyContinue (výchozí).

-Výstražná akce

Určuje, jak rutina reaguje na upozornění z příkazu. Pokračovat je výchozí hodnota. Tento parametr funguje pouze v případě, že příkaz vygeneruje zprávu s upozorněním. Tento parametr například funguje, když příkaz obsahuje rutinu Write-Warning .

Type: ActionPreference
Aliases: wa
Accepted values: Break, Suspend, Ignore, Inquire, Continue, Stop, SilentlyContinue
Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

Parametr WarningAction přepíše hodnotu $WarningPreference proměnné pro aktuální příkaz. Vzhledem k tomu, že výchozí hodnota $WarningPreference proměnné je Continue, zobrazí se upozornění a provádění pokračuje, pokud nepoužíváte parametr WarningAction .

  • Break zadá ladicí program, když dojde k upozornění.
  • Continue zobrazí zprávy s upozorněním a pokračuje v provádění příkazu. Continue je výchozí.
  • Inquire zobrazí zprávu s upozorněním a před pokračováním v provádění vás vyzve k potvrzení. Tato hodnota se používá zřídka.
  • SilentlyContinue potlačuje zprávu upozornění a pokračuje v provádění příkazu.
  • Stop zobrazí zprávu s upozorněním a ukončí provádění příkazu.

Poznámka:

Parametr WarningAction přepíše, ale nenahrazuje hodnotu $WarningAction proměnné předvolby, pokud se parametr použije v příkazu ke spuštění skriptu nebo funkce.

-VýstražnáProměnná

Ukládá záznamy upozornění o příkazu v zadané proměnné.

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

Všechna vygenerovaná upozornění se ukládají do proměnné, i když se upozornění uživateli nezobrazí.

Pokud chcete upozornění připojit k obsahu proměnné, místo nahrazení všech upozornění, která by tam již mohla být uložena, zadejte před název proměnné znaménko plus (+).

Například následující příkaz vytvoří proměnnou $a a uloží do ní všechna upozornění:

Get-Process -Id 6 -WarningVariable a

Následující příkaz přidá do proměnné všechna upozornění $a :

Get-Process -Id 2 -WarningVariable +a

Následující příkaz zobrazí obsah $a:

$a

Tento parametr můžete použít k vytvoření proměnné, která obsahuje pouze upozornění z konkrétních příkazů. Zápis pole, například $a[0] nebo $warning[1,2] odkaz na konkrétní upozornění uložená v proměnné, můžete použít.

Poznámka:

Proměnná upozornění obsahuje všechna upozornění vygenerovaná příkazem, včetně upozornění z volání vnořených funkcí nebo skriptů.

Popisy parametrů řízení rizik

-Co když

Zobrazí zprávu, která popisuje účinek příkazu místo spuštění příkazu.

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

Parametr WhatIf přepíše hodnotu $WhatIfPreference proměnné pro aktuální příkaz. Vzhledem k tomu, že výchozí hodnota $WhatIfPreference proměnné je 0 (zakázáno), chování WhatIf se neprovede bez parametru WhatIf . Další informace najdete v části about_Preference_Variables.

  • $true má stejný účinek jako -WhatIf.
  • $false potlačuje automatické chování WhatIf, které má za následek, když je hodnota $WhatIfPreference proměnné 1.

Například následující příkaz používá -WhatIf parametr v Remove-Item příkazu:

Remove-Item Date.csv -WhatIf

Místo odebrání položky PowerShell zobrazí seznam operací, které by udělal, a položek, které by to ovlivnilo. Tento příkaz vytvoří následující výstup:

What if: Performing operation "Remove File" on
Target "C:\ps-test\date.csv".

-Confirm

Před provedením příkazu vás vyzve k potvrzení.

Type: SwitchParameter
Aliases: cf
Required: False
Position: Named
Default value: Depends on preference variable
Accept pipeline input: False
Accept wildcard characters: False

Parametr Confirm přepíše hodnotu $ConfirmPreference proměnné pro aktuální příkaz. Výchozí hodnota je true. Další informace najdete v části about_Preference_Variables.

  • $true má stejný účinek jako -Confirm.
  • $false potlačí automatické potvrzení, ke kterému dochází, když je hodnota $ConfirmPreference menší nebo rovna odhadovanému riziku rutiny.

Například následující příkaz používá Confirm parametr s příkazem Remove-Item . Před odebráním položky PowerShell zobrazí seznam operací, které by udělal, a položek, které by to ovlivnilo, a požádal o schválení.

PS C:\ps-test> Remove-Item tmp*.txt -Confirm

Confirm
Are you sure you want to perform this action?
Performing operation "Remove File" on Target " C:\ps-test\tmp1.txt
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend
[?] Help (default is "Y"):

Možnosti Confirm odpovědi jsou následující:

Odezva Výsledek
Yes (Y) Proveďte akci.
Yes to All (A) Provedení všech akcí a potlačení následných akcí Confirm
dotazy pro tento příkaz.
No (N): Tuto akci neprovádějte.
No to All (L): Neprovádějte žádné akce a potlačit následné akce.
Confirm dotazy pro tento příkaz.
Suspend (S): Pozastavte příkaz a vytvořte dočasnou relaci.
Help (?) Zobrazit nápovědu k těmto možnostem

Možnost Pozastavit umístí příkaz do blokování a vytvoří dočasnou vnořenou relaci, ve které můžete pracovat, dokud nebudete připraveni zvolit Confirm možnost. Příkazový řádek pro vnořenou relaci obsahuje dvě nadbytečné karety (>>), které indikují, že se jedná o podřízenou operaci původního nadřazeného příkazu. Vnořené relaci můžete spouštět příkazy a skripty. Pokud chcete ukončit vnořenou relaci a vrátit se k Confirm možnostem původního příkazu, zadejte "exit".

V následujícím příkladu se možnost Pozastavení (S) používá k dočasnému zastavení příkazu, zatímco uživatel zkontroluje nápovědu k parametru příkazu. Po získání potřebných informací uživatel zadá příkaz "exit" pro ukončení vnořené výzvy a pak vybere odpověď Ano (y) na Confirm dotaz.

PS C:\ps-test> New-Item -ItemType File -Name Test.txt -Confirm

Confirm
Are you sure you want to perform this action?

Performing operation "Create File" on Target "Destination:
C:\ps-test\test.txt".
[Y] Yes [A] Yes to All [N] No [L] No to All [S] Suspend [?] Help (default
is "Y"): s

PS C:\ps-test> Get-Help New-Item -Parameter ItemType

-ItemType <string>
Specifies the provider-specified type of the new item.

Required?                    false
Position?                    named
Default value
Accept pipeline input?       true (ByPropertyName)
Accept wildcard characters?  false

PS C:\ps-test> exit

Confirm
Are you sure you want to perform this action?
Performing operation "Create File" on Target "Destination: C:\ps-test\test
.txt".
[Y] Yes  [A] Yes to All  [N] No  [L] No to All  [S] Suspend  [?] Help (defau
lt is "Y"): y

Directory: C:\ps-test

Mode                LastWriteTime     Length Name
----                -------------     ------ ----
-a---         8/27/2010   2:41 PM          0 test.txt

Viz také

  • Last updated on