Register-SecretVault
Registrerar en SecretManagement-tilläggsvalvmodul för den aktuella användaren.
Syntax
Default (Standard)
Register-SecretVault
[-ModuleName] <String>
[[-Name] <String>]
[-VaultParameters <Hashtable>]
[-DefaultVault]
[-AllowClobber]
[-PassThru]
[-Description <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Important
PowerShell-teamet har beslutat att Secret-moduler är funktionskompletta och inte längre kommer att utvecklas aktivt. Modulerna kommer fortsatt att stödjas för säkerhet och kritiska buggfixar. Kodarkivet har arkiverats.
De senaste publicerade versionerna är:
Hemligheternas natur har förändrats fundamentalt sedan detta projekt designades. Lösenordslösa autentiseringsmetoder som lösennycklar, single sign-on och federerade autentiseringssystem som Microsoft Entra ID, biometrik och hårdvarusäkerhetsnycklar är framtiden.
Den här cmdleten lägger till ett SecretManagement-tilläggsvalv i den aktuella användarens valvregister. Ett tilläggsvalv är en PowerShell-modul som överensstämmer med det tilläggsvalvformat som krävs. Den här cmdleten verifierar att den angivna modulen uppfyller efterlevnadskraven innan den läggs till i tilläggets valvregister. Tilläggsvalv registreras på den aktuella användaren och påverkar inte andra registreringar av användarvalv.
Det första valvet som registreras med den här cmdleten definieras automatiskt som standardvalv även om parametern DefaultVault inte har angetts.
Exempel
Exempel 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
I det här exemplet registreras ett Microsoft.PowerShell.SecretStore tilläggsvalv för den aktuella användaren.
Den använder parametern DefaultVault för att göra det registrerade valvet till användarens standardvalv.
Get-SecretVault visar en lista över alla registrerade valv för användaren och kontrollerar att valvet har registrerats och angetts som standardvalv.
Exempel 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
I det här exemplet registreras ett Az.KeyVault- tilläggsvalv för den aktuella användaren. Modulen Az.KeyVault måste installeras på tidigare. För VaultParameters:
-
AZKVaultNameanger namnet på Key Vault i Azure -
SubscriptionIdanger ID för prenumerationen där Key Vault skapas i
Parametrar
-AllowClobber
Om det anges kan cmdleten skriva över ett befintligt registrerat tilläggsvalv med samma namn.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | False |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Confirm
Uppmanar dig att bekräfta innan du kör cmdleten.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | False |
| Stöder jokertecken: | False |
| DontShow: | False |
| Alias: | jfr |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-DefaultVault
Om det anges anger du det nya tilläggets valv som standardvalv för den aktuella användaren.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | False |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Description
Beskriver valvet. Det här värdet ingår i registerinformationen för valvet.
Parameteregenskaper
| Typ: | String |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-ModuleName
Anger namnet på PowerShell-modulen som implementerar tilläggets valv. Ange namnet på en modul eller sökvägen till modulen. Om du anger ett namn söker PowerShell efter det i de kända modulsökvägarna. Om du anger en sökväg söker PowerShell igenom den sökvägen för modulen.
Parameteregenskaper
| Typ: | String |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | 1 |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-Name
Anger namnet på tilläggets valv. Om inget namn anges används modulnamnet som valvnamn.
Parameteregenskaper
| Typ: | String |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | 0 |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-PassThru
Anger att cmdleten ska returnera objektet SecretVaultInfo för det filnamnsvalv som har registrerats. Som standard returnerar den här cmdleten inga utdata.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | False |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-VaultParameters
Anger ett Hashtable- objekt som innehåller valfria nyckel/värde-par som används som parametrar av tilläggets valv. Dessa parametrar är valfria. Läs dokumentationen för modulen för valvtillägget för att se vilka värden som krävs.
Parameteregenskaper
| Typ: | Hashtable |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
-WhatIf
Visar vad som skulle hända om kommandot körs. Cmdleten körs inte.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | False |
| Stöder jokertecken: | False |
| DontShow: | False |
| Alias: | Wi |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
CommonParameters
Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.