Register-SecretVault
Registriert ein SecretManagement-Erweiterungstresormodul für den aktuellen Benutzer.
Syntax
Default (Standard)
Register-SecretVault
[-ModuleName] <String>
[[-Name] <String>]
[-VaultParameters <Hashtable>]
[-DefaultVault]
[-AllowClobber]
[-PassThru]
[-Description <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Beschreibung
Important
Das PowerShell-Team hat entschieden, dass Secret-Module funktionsfertig sind und nicht mehr aktiv entwickelt werden. Die Module werden weiterhin für Sicherheits- und kritische Fehlerbehebungen unterstützt. Das Code-Repository wird archiviert.
Die zuletzt veröffentlichten Versionen sind:
Die Natur der Geheimnisse hat sich seit der Planung dieses Projekts grundlegend verändert. Passwortlose Authentifizierungsmethoden wie Passkeys, Single Sign-on und föderierte Zugangsdaten wie Microsoft Entra ID, Biometrie und Hardware-Sicherheitsschlüssel sind die Zukunft.
Mit diesem Cmdlet wird der Tresorregistrierung des aktuellen Benutzers ein SecretManagement Erweiterungstresor hinzugefügt. Ein Erweiterungstresor ist ein PowerShell-Modul, das dem erforderlichen Erweiterungstresorformat entspricht. Dieses Cmdlet überprüft, ob das angegebene Modul die Konformitätsanforderungen erfüllt, bevor es der Erweiterungstresorregistrierung hinzugefügt wird. Erweiterungstresore werden für den aktuellen Benutzer registriert und wirken sich nicht auf andere Benutzertresorregistrierungen aus.
Der erste Tresor, der mit diesem Cmdlet registriert wird, wird automatisch als Standardtresor definiert, auch wenn der Parameter DefaultVault nicht angegeben ist.
Beispiele
Beispiel 1
Register-SecretVault -Name LocalStore -ModuleName Microsoft.PowerShell.SecretStore -DefaultVault
Get-SecretVault
VaultName ModuleName IsDefaultVault
--------- ---------- --------------
CredMan Microsoft.PowerShell.CredManStore False
LocalStore Microsoft.PowerShell.SecretStore True
In diesem Beispiel wird ein Microsoft.PowerShell.SecretStore Erweiterungstresor für den aktuellen Benutzer registriert.
Er verwendet den parameter DefaultVault, um den registrierten Tresor zum Standardtresor für den Benutzer zu machen.
Get-SecretVault listet alle registrierten Tresore für den Benutzer auf, um zu überprüfen, ob der Tresor registriert und als Standardtresor festgelegt wurde.
Beispiel 2
$parameters = @{
Name = 'Azure'
ModuleName = 'Az.KeyVault'
VaultParameters = @{
AZKVaultName = 'AzureKeyVault'
SubscriptionId = (Get-AzContext).Subscription.Id
}
DefaultVault = $true
}
Register-SecretVault @parameters
Get-SecretVault
Name ModuleName IsDefaultVault
---- ---------- --------------
Azure Az.KeyVault True
In diesem Beispiel wird ein Az.KeyVault Erweiterungstresor für den aktuellen Benutzer registriert. Das Az.KeyVault Modul muss zuvor installiert werden. Für die VaultParameters:
-
AZKVaultNamegibt den Namen des Key Vault in Azure an. -
SubscriptionIdgibt die ID des Abonnements an, in dem der Key Vault erstellt wird.
Parameter
-AllowClobber
Wenn angegeben, kann das Cmdlet einen vorhandenen registrierten Erweiterungstresor mit demselben Namen überschreiben.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | False |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-Confirm
Fordert Sie zur Bestätigung auf, bevor Sie das Cmdlet ausführen.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | False |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
| Aliase: | vgl |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-DefaultVault
Wenn angegeben, legt den neuen Erweiterungstresor als Standardtresor für den aktuellen Benutzer fest.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | False |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-Description
Beschreibt den Tresor. Dieser Wert ist in den Registrierungsinformationen des Tresors enthalten.
Parametereigenschaften
| Typ: | String |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-ModuleName
Gibt den Namen des PowerShell-Moduls an, das den Erweiterungstresor implementiert. Geben Sie den Namen eines Moduls oder den Pfad zum Modul ein. Wenn Sie einen Namen angeben, sucht PowerShell in den bekannten Modulpfaden danach. Wenn Sie einen Pfad angeben, durchsucht PowerShell diesen Pfad nach dem Modul.
Parametereigenschaften
| Typ: | String |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | 1 |
| Obligatorisch: | True |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-Name
Gibt den Namen des Erweiterungstresors an. Wenn kein Name angegeben ist, wird der Modulname als Tresorname verwendet.
Parametereigenschaften
| Typ: | String |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | 0 |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-PassThru
Gibt an, dass das Cmdlet das SecretVaultInfo -Objekt für den erfolgreich registrierten Erweiterungstresor zurückgeben soll. Standardmäßig gibt dieses Cmdlet keine Ausgabe zurück.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | False |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-VaultParameters
Gibt ein Hashtable- -Objekt an, das optionale Schlüsselwertpaare enthält, die als Parameter vom Erweiterungstresor verwendet werden. Diese Parameter sind optional. Lesen Sie die Dokumentation des Vault-Erweiterungsmoduls, um zu sehen, welche Werte erforderlich sind.
Parametereigenschaften
| Typ: | Hashtable |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-WhatIf
Zeigt, was passiert, wenn das Cmdlet ausgeführt wird. Das Cmdlet wird nicht ausgeführt.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | False |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
| Aliase: | Wi |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
CommonParameters
Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.
