Register-SecretVault
Rejestruje moduł magazynu rozszerzenia SecretManagement dla bieżącego użytkownika.
Składnia
Default (domyślnie)
Register-SecretVault
[-ModuleName] <String>
[[-Name] <String>]
[-VaultParameters <Hashtable>]
[-DefaultVault]
[-AllowClobber]
[-PassThru]
[-Description <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Opis
Ważna
Zespół PowerShell zdecydował, że moduły Secret są funkcjonalnie kompletne i nie będą już aktywnie rozwijane. Moduły będą nadal wspierane w zakresie bezpieczeństwa i krytycznych poprawek błędów. Repozytorium kodu zostało zarchiwizowane.
Najnowsze opublikowane wersje to:
Charakter sekretów zasadniczo się zmienił od czasu powstania tego projektu. Metody uwierzytelniania bez hasła, takie jak klucze dostępowe, single log-on oraz federacyjne systemy uwierzytelniania, takie jak Microsoft Entra ID, biometria i sprzętowe klucze bezpieczeństwa, to przyszłość.
To polecenie cmdlet dodaje magazyn SecretManagement rozszerzenia do rejestru magazynu bieżącego użytkownika. Magazyn rozszerzeń to moduł programu PowerShell zgodny z wymaganym formatem magazynu rozszerzeń. To polecenie cmdlet sprawdza, czy określony moduł spełnia wymagania zgodności przed dodaniem go do rejestru magazynu rozszerzeń. Magazyny rozszerzeń są rejestrowane na bieżącego użytkownika i nie mają wpływu na rejestracje innych magazynów użytkowników.
Pierwszy magazyn zarejestrowany za pomocą tego polecenia cmdlet jest automatycznie definiowany jako magazyn domyślny, nawet jeśli parametr DefaultVault nie jest określony.
Przykłady
Przykład 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
W tym przykładzie zarejestrowano magazyn rozszerzeń Microsoft.PowerShell.SecretStore dla bieżącego użytkownika.
Używa on parametru DefaultVault, aby zarejestrowany magazyn był domyślnym magazynem dla użytkownika.
Get-SecretVault wyświetla listę wszystkich zarejestrowanych magazynów dla użytkownika, sprawdzanie, czy magazyn został zarejestrowany i ustawiony jako magazyn domyślny.
Przykład 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
W tym przykładzie zarejestrowano magazyn rozszerzenia Az.KeyVault dla bieżącego użytkownika. Moduł Az.KeyVault należy zainstalować wcześniej. Dla VaultParameters:
-
AZKVaultNameokreśla nazwę usługi Key Vault na platformie Azure -
SubscriptionIdokreśla identyfikator subskrypcji, w której utworzono usługę Key Vault
Parametry
-AllowClobber
Jeśli zostanie określony, umożliwia poleceniem cmdlet zastąpienie istniejącego zarejestrowanego magazynu rozszerzeń o tej samej nazwie.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | False |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Confirm
Prosi o potwierdzenie przed uruchomieniem cmdletu.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | False |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
| Aliasy: | por |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-DefaultVault
Jeśli zostanie określony, ustawia nowy magazyn rozszerzeń jako magazyn domyślny dla bieżącego użytkownika.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | False |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Description
Opisuje magazyn. Ta wartość jest uwzględniana w informacjach rejestru magazynu.
Właściwości parametru
| Typ: | String |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-ModuleName
Określa nazwę modułu programu PowerShell, który implementuje magazyn rozszerzeń. Wprowadź nazwę modułu lub ścieżkę do modułu. Jeśli określisz nazwę, program PowerShell wyszukuje ją w znanych ścieżkach modułu. Jeśli określisz ścieżkę, program PowerShell wyszukuje ścieżkę dla modułu.
Właściwości parametru
| Typ: | String |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | 1 |
| Obowiązkowe: | True |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Name
Określa nazwę magazynu rozszerzeń. Jeśli nie określono nazwy, nazwa modułu jest używana jako nazwa magazynu.
Właściwości parametru
| Typ: | String |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | 0 |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-PassThru
Wskazuje, że polecenie cmdlet powinno zwrócić obiekt SecretVaultInfo dla pomyślnie zarejestrowanego magazynu rozszerzeń. Domyślnie to polecenie cmdlet nie zwraca żadnych danych wyjściowych.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | False |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-VaultParameters
Określa obiekt hashtable zawierający opcjonalne pary klucz-wartość używane jako parametry magazynu rozszerzeń. Te parametry są opcjonalne. Zapoznaj się z dokumentacją modułu rozszerzenia magazynu, aby sprawdzić, jakie wartości są wymagane.
Właściwości parametru
| Typ: | Hashtable |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-WhatIf
Pokazuje, co się stanie, jeśli polecenie cmdlet zostanie uruchomione. Cmdlet nie został uruchomiony.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | False |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
| Aliasy: | Wi |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowe: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
CommonParameters
To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.