Typowe nazwy parametrów

Artykuł
09/27/2021

Parametry opisane w tym temacie są określane jako typowe parametry. Są one dodawane do polecenia cmdlet przez Windows PowerShell uruchomieniowego i nie mogą być deklarowane przez polecenie cmdlet.

Uwaga

Te parametry są również dodawane do polecenia cmdlet dostawcy i do funkcji, które są dekorowane za pomocą CmdletBinding atrybutu .

Ogólne typowe parametry

Następujące parametry są dodawane do wszystkich polecenia cmdlet i są dostępne przy każdym uruchomieniu polecenia cmdlet. Te parametry są definiowane przez klasę System.Management.Automation.Internal.Commonparameters.

Potwierdź (alias: cf)

Typ danych: SwitchParameter

Ten parametr określa, czy polecenie cmdlet wyświetla monit z pytaniem, czy użytkownik ma pewność, że chce kontynuować.

Debugowanie (alias: db)

Typ danych: SwitchParameter

Ten parametr określa, czy komunikaty debugowania na poziomie programisty mogą być wyświetlane w wierszu polecenia. Te komunikaty są przeznaczone do rozwiązywania problemów z działaniem polecenia cmdlet i są generowane przez wywołania metody System.Management.Automation.Cmdlet.WriteDebug. Komunikaty debugowania nie muszą być zlokalizowane.

ErrorAction (alias: ea)

Typ danych: Wyliczenie

Ten parametr określa, jaką akcję należy podjąć w przypadku wystąpienia błędu. Możliwe wartości tego parametru są definiowane przez wyliczenie System.Management.Automation.Actionpreference.

ErrorVariable (alias: ev)

Typ danych: Ciąg

Ten parametr określa zmienną, w której mają być umieszczane obiekty w przypadku wystąpienia błędu. Aby dołączyć do tej zmiennej, użyj funkcji +varname zamiast czyszczenia i ustawiania zmiennej.

OutBuffer (alias: ob)

Typ danych: Int32

Ten parametr definiuje liczbę obiektów do przechowywania w buforze danych wyjściowych, zanim jakiekolwiek obiekty zostaną przekazane do potoku. Domyślnie obiekty są przekazywane bezpośrednio w dół potoku.

OutVariable (alias: ov)

Typ danych: Ciąg

Ten parametr określa zmienną, w której mają być umieszczane wszystkie obiekty wyjściowe wygenerowane przez polecenie cmdlet . Aby dołączyć do tej zmiennej, użyj funkcji +varname zamiast czyszczenia i ustawiania zmiennej.

PipelineVariable (alias: pv)

Typ danych: Ciąg

Ten parametr przechowuje wartość bieżącego elementu potoku jako zmienną dla dowolnego nazwanego polecenia podczas przepływu przez potok.

Pełne (alias: vb)

Typ danych: SwitchParameter

Ten parametr określa, czy polecenie cmdlet zapisuje komunikaty objaśniające, które mogą być wyświetlane w wierszu polecenia. Te komunikaty mają na celu zapewnienie dodatkowej pomocy użytkownikowi i są generowane przez wywołania metody System.Management.Automation.Cmdlet.WriteVerbose.

WarningAction (alias: wa)

Typ danych: Wyliczenie

Ten parametr określa, jaką akcję należy podjąć, gdy polecenie cmdlet zapisze komunikat ostrzegawczy. Możliwe wartości tego parametru są definiowane przez wyliczenie System.Management.Automation.Actionpreference.

WarningVariable (alias: wv)

Typ danych: Ciąg

Ten parametr określa zmienną, w której można zapisywać komunikaty ostrzegawcze. Aby dołączyć do tej zmiennej, użyj funkcji +varname zamiast czyszczenia i ustawiania zmiennej.

Risk-Mitigation parametrów

Następujące parametry są dodawane do polecenia cmdlet, które żąda potwierdzenia przed wykonaniem akcji. Aby uzyskać więcej informacji na temat żądań potwierdzenia, zobacz Żądanie potwierdzenia. Te parametry są definiowane przez klasę System.Management.Automation.Internal.Shouldprocessparameters.

WhatIf (alias: wi)

Typ danych: SwitchParameter

Ten parametr określa, czy polecenie cmdlet zapisuje komunikat opisujący skutki uruchomienia polecenia cmdlet bez wykonywania jakiejkolwiek akcji.

Parametry transakcji

Dodano następujący parametr do polecenia cmdlet, które obsługują transakcje. Te parametry są definiowane przez klasę System.Management.Automation.Internal.Transactionparameters. Obsługa transakcji została wprowadzona w programie PowerShell 3.0 i wycofana w programie PowerShell 6.0.