about_Parameters_Default_Values

Artikel
05/09/2024

Kurze Beschreibung

Beschreibt, wie benutzerdefinierte Standardwerte für Cmdletparameter und erweiterte Funktionen festgelegt werden.

Lange Beschreibung

Mit $PSDefaultParameterValues der Einstellungsvariable können Sie benutzerdefinierte Standardwerte für jedes Cmdlet oder eine erweiterte Funktion angeben. Cmdlets und erweiterte Funktionen verwenden den benutzerdefinierten Standardwert, es sei denn, Sie geben im Befehl einen anderen Wert an.

Die Autoren von Cmdlets und erweiterten Funktionen legen Standardwerte für ihre Parameter fest. In der Regel sind die Standardwerte nützlich, aber möglicherweise nicht für alle Umgebungen geeignet.

Dieses Feature ist besonders nützlich, wenn Sie fast bei jeder Verwendung des Befehls den gleichen alternativen Parameterwert angeben müssen oder wenn ein bestimmter Parameterwert schwer zu merken ist, z. B. ein E-Mail-Servername oder eine Projekt-GUID.

Wenn der gewünschte Standardwert vorhersagbar variiert, können Sie einen Skriptblock angeben, der unter unterschiedlichen Bedingungen unterschiedliche Standardwerte für einen Parameter bereitstellt.

$PSDefaultParameterValues wurde in PowerShell 3.0 eingeführt.

Syntax

Die $PSDefaultParameterValues Variable ist eine Hashtabelle, die das Format von Schlüsseln als Objekttyp von System.Management.Automation.DefaultParameterDictionary überprüft. Die Hashtabelle enthält Schlüssel-Wert-Paare . Ein Schlüssel hat das Format CmdletName:ParameterName. Ein Wert ist der Dem Schlüssel zugewiesene DefaultValue oder ScriptBlock .

Die Syntax der Einstellungsvariable $PSDefaultParameterValues lautet wie folgt:

$PSDefaultParameterValues=@{"CmdletName:ParameterName"="DefaultValue"}

$PSDefaultParameterValues=@{ "CmdletName:ParameterName"={{ScriptBlock}} }

$PSDefaultParameterValues["Disabled"]=$True | $False

In den Werten CmdletName und ParameterName sind Wildcardzeichen zulässig.

Verwenden Sie die Methoden zum Bearbeiten einer Standardhashtabelle, um ein bestimmtes Schlüssel-Wert-Paar festzulegen, zu ändern, hinzuzufügen oder daraus $PSDefaultParameterValueszu entfernen. Beispielsweise die Methoden Add und Remove . Diese Methoden überschreiben keine anderen Werte in der Hashtabelle.

Es gibt eine andere Syntax, die eine vorhandene $PSDefaultParameterValues Hashtabelle nicht überschreibt. Verwenden Sie die folgende Syntax, um ein bestimmtes Schlüssel-Wert-Paar hinzuzufügen oder zu ändern:

$PSDefaultParameterValues["CmdletName:ParameterName"]="DefaultValue"

CmdletName muss der Name eines Cmdlets oder der Name einer erweiterten Funktion sein, die das CmdletBinding-Attribut verwendet. Sie können nicht verwenden $PSDefaultParameterValues , um Standardwerte für Skripts oder einfache Funktionen anzugeben.

DefaultValue kann ein Objekt oder ein Skriptblock sein. Wenn der Wert ein Skriptblock ist, wertet PowerShell den Skriptblock aus und verwendet das Ergebnis als Parameterwert. Wenn der angegebene Parameter einen Skriptblockwert akzeptiert, schließen Sie den Skriptblockwert in eine zweite Gruppe von geschweiften Klammern ein, z. B.:

$PSDefaultParameterValues=@{ "Invoke-Command:ScriptBlock"={{Get-Process}} }

Weitere Informationen finden Sie in den folgenden Dokumenten:

Beispiele

Festlegen von $PSDefaultParameterValues

$PSDefaultParameterValues ist eine Einstellungsvariable, sodass sie nur in der Sitzung vorhanden ist, in der sie festgelegt ist. Er besitzt keinen Standardwert.

Geben Sie zum Festlegen $PSDefaultParameterValuesden Variablennamen und mindestens ein Schlüssel-Wert-Paar ein. Wenn Sie einen anderen $PSDefaultParameterValues Befehl ausführen, wird die vorhandene Hashtabelle überschrieben.

Beispiele zum Ändern von Schlüssel-Wert-Paaren ohne Überschreiben vorhandener Hashtabellenwerte finden Sie unter Hinzufügen von Werten zu $PSDefaultParameterValues oder Ändern von Werten in $PSDefaultParameterValues.

Um für zukünftige Sitzungen zu speichern $PSDefaultParameterValues , fügen Sie Ihrem PowerShell-Profil einen $PSDefaultParameterValues Befehl hinzu. Weitere Informationen finden Sie unter about_Profiles.

Festlegen eines benutzerdefinierten Standardwerts

Das Schlüssel-Wert-Paar legt den Send-MailMessage:SmtpServer Schlüssel auf einen benutzerdefinierten Standardwert von Server123 fest.

$PSDefaultParameterValues = @{
  "Send-MailMessage:SmtpServer"="Server123"
}

Festlegen von Standardwerten für mehrere Parameter

Um Standardwerte für mehrere Parameter festzulegen, trennen Sie jedes Schlüssel-Wert-Paar durch ein Semikolon (;). Die Send-MailMessage:SmtpServer Schlüssel und Get-WinEvent:LogName sind auf benutzerdefinierte Standardwerte festgelegt.

$PSDefaultParameterValues = @{
  "Send-MailMessage:SmtpServer"="Server123";
  "Get-WinEvent:LogName"="Microsoft-Windows-PrintService/Operational"
}

Verwenden von Wildcards und Switchparametern

Die Cmdlet- und Parameternamen können Wildcardzeichen enthalten. Verwenden Sie $True und $False , um Werte für Switchparameter festzulegen, z. B . Ausführlich. Der Verbose-Parameter des common-Parameters ist für alle Befehle auf $True festgelegt.

$PSDefaultParameterValues = @{"*:Verbose"=$True}

Verwenden eines Arrays für den Standardwert

Wenn ein Parameter mehrere Werte (ein Array) akzeptieren kann, können Sie mehrere Werte als Standardwerte festlegen. Der Standardwert des Invoke-Command:ComputerName Schlüssels wird auf den Arraywert Server01 und Server02 festgelegt.

$PSDefaultParameterValues = @{
  "Invoke-Command:ComputerName"="Server01","Server02"
}

Verwenden eines Skriptblocks

Sie können einen Skriptblock verwenden, um unter unterschiedlichen Bedingungen unterschiedliche Standardwerte für einen Parameter anzugeben. PowerShell wertet den Skriptblock aus und verwendet das Ergebnis als Standardwert.

Der Format-Table:AutoSize Schlüssel legt fest, dass der Parameter auf den Standardwert True umgestellt wird. Die If -Anweisung enthält die Bedingung, dass die $host.Name die PowerShell-Konsole ConsoleHost sein muss.

$PSDefaultParameterValues=@{
  "Format-Table:AutoSize"={if ($host.Name -eq "ConsoleHost"){$True}}
}

Wenn ein Parameter einen Skriptblockwert akzeptiert, schließen Sie den Skriptblock in einen zusätzlichen Satz von geschweiften Klammern ein. Wenn PowerShell den äußeren Skriptblock auswertet, ist das Ergebnis der innere Skriptblock, der als Standardparameterwert festgelegt wird.

Der Invoke-Command:ScriptBlock Schlüssel wird auf einen Standardwert des Systemereignisprotokolls festgelegt, da der Skriptblock in einen zweiten Satz geschweifter Klammern eingeschlossen ist. Das Ergebnis des Skriptblocks wird an das Invoke-Command Cmdlet übergeben.

$PSDefaultParameterValues=@{
  "Invoke-Command:ScriptBlock"={{Get-EventLog -Log System}}
}

So erhalten Sie $PSDefaultParameterValues

Die Hashtabellenwerte werden angezeigt, indem Sie an der PowerShell-Eingabeaufforderung eingeben $PSDefaultParameterValues .

Eine $PSDefaultParameterValues Hashtabelle wird mit drei Schlüssel-Wert-Paaren festgelegt. Diese Hashtabelle wird in den folgenden Beispielen verwendet, in denen beschrieben wird, wie Werte aus hinzugefügt, geändert und entfernt werden $PSDefaultParameterValues.

PS> $PSDefaultParameterValues = @{
  "Send-MailMessage:SmtpServer"="Server123"
  "Get-WinEvent:LogName"="Microsoft-Windows-PrintService/Operational"
  "Get-*:Verbose"=$True
}

PS> $PSDefaultParameterValues

Name                           Value
----                           -----
Get-WinEvent:LogName           Microsoft-Windows-PrintService/Operational
Get-*:Verbose                  True
Send-MailMessage:SmtpServer    Server123

Verwenden Sie die folgende Syntax, um den Wert eines bestimmten CmdletName:ParameterName Schlüssels abzurufen:

$PSDefaultParameterValues["CmdletName:ParameterName"]

Beispielsweise, um den Wert für den Send-MailMessage:SmtpServer Schlüssel abzurufen.

PS> $PSDefaultParameterValues["Send-MailMessage:SmtpServer"]
Server123

Hinzufügen von Werten zu $PSDefaultParameterValues

Um einen Wert zu hinzuzufügen $PSDefaultParameterValues, verwenden Sie die Add-Methode . Das Hinzufügen eines Werts wirkt sich nicht auf die vorhandenen Werte der Hashtabelle aus.

Verwenden Sie ein Komma (,), um den Schlüssel vom Wert zu trennen. Die folgende Syntax zeigt, wie die Add-Methode für verwendet wird $PSDefaultParameterValues.

PS> $PSDefaultParameterValues.Add("CmdletName:ParameterName", "DefaultValue")

Die im vorherigen Beispiel erstellte Hashtabelle wird mit einem neuen Schlüssel-Wert-Paar aktualisiert. Die Add-Methode legt den Get-Process:Name Schlüssel auf den Wert PowerShell fest.

$PSDefaultParameterValues.Add("Get-Process:Name", "PowerShell")

Mit der folgenden Syntax wird das gleiche Ergebnis erreicht.

$PSDefaultParameterValues["Get-Process:Name"]="PowerShell"

Die $PSDefaultParameterValues Variable zeigt die aktualisierte Hashtabelle an. Der Get-Process:Name Schlüssel wurde hinzugefügt.

PS> $PSDefaultParameterValues

Name                           Value
----                           -----
Get-Process:Name               PowerShell
Get-WinEvent:LogName           Microsoft-Windows-PrintService/Operational
Get-*:Verbose                  True
Send-MailMessage:SmtpServer    Server123

Entfernen von Werten aus $PSDefaultParameterValues

Um einen Wert aus $PSDefaultParameterValueszu entfernen, verwenden Sie die Remove-Methode von Hashtabellen. Das Entfernen eines Werts wirkt sich nicht auf die vorhandenen Werte der Hashtabelle aus.

Die folgende Syntax zeigt, wie die Remove-Methode für verwendet wird $PSDefaultParameterValues.

PS> $PSDefaultParameterValues.Remove("CmdletName:ParameterName")

In diesem Beispiel wird die im vorherigen Beispiel erstellte Hashtabelle aktualisiert, um ein Schlüssel-Wert-Paar zu entfernen. Die Remove-Methode entfernt den Get-Process:Name Schlüssel.

$PSDefaultParameterValues.Remove("Get-Process:Name")

Die $PSDefaultParameterValues Variable zeigt die aktualisierte Hashtabelle an. Der Get-Process:Name Schlüssel wurde entfernt.

PS> $PSDefaultParameterValues

Name                           Value
----                           -----
Get-WinEvent:LogName           Microsoft-Windows-PrintService/Operational
Get-*:Verbose                  True
Send-MailMessage:SmtpServer    Server123

Ändern von Werten in $PSDefaultParameterValues

Änderungen an einem bestimmten Wert wirken sich nicht auf vorhandene Hashtabellenwerte aus. Verwenden Sie die folgende Syntax, um ein bestimmtes Schlüssel-Wert-Paar in $PSDefaultParameterValueszu ändern:

PS> $PSDefaultParameterValues["CmdletName:ParameterName"]="DefaultValue"

In diesem Beispiel wird die im vorherigen Beispiel erstellte Hashtabelle aktualisiert, um ein Schlüssel-Wert-Paar zu ändern. Der folgende Befehl ändert den Send-MailMessage:SmtpServer Schlüssel in einen neuen Wert von ServerXYZ.

$PSDefaultParameterValues["Send-MailMessage:SmtpServer"]="ServerXYZ"

Die $PSDefaultParameterValues Variable zeigt die aktualisierte Hashtabelle an. Der Send-MailMessage:SmtpServer Schlüssel wurde in einen neuen Wert geändert.

PS> $PSDefaultParameterValues

Name                           Value
----                           -----
Get-WinEvent:LogName           Microsoft-Windows-PrintService/Operational
Get-*:Verbose                  True
Send-MailMessage:SmtpServer    ServerXYZ

Deaktivieren und erneutes Aktivieren von $PSDefaultParameterValues

Sie können vorübergehend deaktivieren und dann erneut aktivieren $PSDefaultParameterValues. Das Deaktivieren $PSDefaultParameterValues ist nützlich, wenn Sie Skripts ausführen, die unterschiedliche Standardparameterwerte benötigen.

Um zu deaktivieren $PSDefaultParameterValues, fügen Sie einen Schlüssel von Disabled mit dem Wert True hinzu. Die Werte in $PSDefaultParameterValues werden beibehalten, sind aber nicht effektiv.

PS> $PSDefaultParameterValues.Add("Disabled", $True)

Die folgende Syntax erreicht das gleiche Ergebnis.

PS> $PSDefaultParameterValues["Disabled"]=$True

Die $PSDefaultParameterValues Variable zeigt die aktualisierte Hashtabelle mit dem Wert für den Disabled Schlüssel an.

PS> $PSDefaultParameterValues

Name                           Value
----                           -----
Disabled                       True
Get-WinEvent:LogName           Microsoft-Windows-PrintService/Operational
Get-*:Verbose                  True
Send-MailMessage:SmtpServer    ServerXYZ

Um erneut zu aktivieren $PSDefaultParameterValues, entfernen Sie den deaktivierten Schlüssel, oder ändern Sie den Wert des deaktivierten Schlüssels in $False. Der vorherige Wert von $PSDefaultParameterValues ist wieder wirksam.

PS> $PSDefaultParameterValues.Remove("Disabled")