Share via


Register-SecretVault

Registrerar en SecretManagement-tilläggsvalvmodul för den aktuella användaren.

Syntax

Register-SecretVault
        [-ModuleName] <String>
        [[-Name] <String>]
        [-VaultParameters <Hashtable>]
        [-DefaultVault]
        [-AllowClobber]
        [-PassThru]
        [-Description <String>]
        [-WhatIf]
        [-Confirm]
        [<CommonParameters>]

Description

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 för den aktuella användaren och påverkar inte andra registreringar av användarvalv.

Det första valvet som registrerats med denna cmdlet 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 standardvalv för användaren. Get-SecretVault visar alla registrerade valv för användaren, kontrollerar att valvet har registrerats och anges 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. Az.KeyVault-modulen måste installeras på tidigare. För VaultParameters:

  • AZKVaultNameanger namnet på Key Vault i Azure
  • SubscriptionIdanger ID:t för prenumerationen där Key Vault skapas i

Parametrar

-AllowClobber

Om detta anges kan cmdleten skriva över ett befintligt registrerat tilläggsvalv med samma namn.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultVault

Om det anges anger du det nya tilläggsvalvet som standardvalv för den aktuella användaren.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Beskriver valvet. Det här värdet ingår i registerinformationen för valvet.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ModuleName

Anger namnet på Den PowerShell-modul som implementerar tilläggsvalvet. 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.

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Name

Anger namnet på tilläggsvalvet. Om inget namn anges används modulnamnet som valvnamn.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Anger att cmdleten ska returnera SecretVaultInfo-objektet för det registrerade tilläggsvalvet. Som standard returnerar denna cmdlet inga utdata.

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-VaultParameters

Anger ett Hashtable-objekt som innehåller valfria nyckel/värde-par som används som parametrar av tilläggets valv. De här parametrarna är valfria. Läs dokumentationen för modulen för valvtillägget för att se vilka värden som krävs.

Type:Hashtable
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

Visar vad som skulle hända om cmdleten kördes. Cmdleten körs inte.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Indata

None

Utdata

None