Delen via


Register-SecretVault

Registreert een secretmanagement-extensiekluismodule voor de huidige gebruiker.

Syntaxis

Default (Standaard)

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

Description

Met deze cmdlet wordt een SecretManagement-extensiekluis toegevoegd aan het kluisregister van de huidige gebruiker. Een extensiekluis is een PowerShell-module die voldoet aan de vereiste indeling van de extensiekluis. Met deze cmdlet wordt gecontroleerd of de opgegeven module voldoet aan de nalevingsvereisten voordat deze wordt toegevoegd aan het register van de extensiekluis. Extensiekluizen worden geregistreerd voor de huidige gebruiker en hebben geen invloed op andere registraties van gebruikerskluizen.

De eerste kluis die met deze cmdlet is geregistreerd, wordt automatisch gedefinieerd als de standaardkluis, zelfs als de parameter DefaultVault niet is opgegeven.

Voorbeelden

Voorbeeld 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 dit voorbeeld wordt een Microsoft.PowerShell.SecretStore extensiekluis voor de huidige gebruiker geregistreerd. Hierbij wordt de parameter DefaultVault gebruikt om de geregistreerde kluis de standaardkluis voor de gebruiker te maken. Get-SecretVault geeft een lijst weer van alle geregistreerde kluizen voor de gebruiker, waarbij wordt gecontroleerd of de kluis is geregistreerd en ingesteld als de standaardkluis.

Voorbeeld 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 dit voorbeeld wordt een Az.KeyVault-extensiekluis voor de huidige gebruiker geregistreerd. De module Az.KeyVault moet eerder worden geïnstalleerd. Voor de VaultParameters:

  • AZKVaultName geeft de naam van de Sleutelkluis in Azure op
  • SubscriptionId geeft de id op van het abonnement waarin de Key Vault wordt gemaakt

Parameters

-AllowClobber

Indien opgegeven, kan de cmdlet een bestaande geregistreerde extensiekluis met dezelfde naam overschrijven.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Confirm

Voordat u de cmdlet uitvoert, vraagt het systeem om bevestiging.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Cf

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-DefaultVault

Indien opgegeven, stelt u de nieuwe extensiekluis in als de standaardkluis voor de huidige gebruiker.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Description

Beschrijft de kluis. Deze waarde is opgenomen in de registergegevens van de kluis.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-ModuleName

Hiermee geeft u de naam op van de PowerShell-module waarmee de extensiekluis wordt geïmplementeerd. Voer de naam van een module of het pad naar de module in. Als u een naam opgeeft, zoekt PowerShell ernaar in de bekende modulepaden. Als u een pad opgeeft, zoekt PowerShell dat pad naar de module.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:1
Verplicht:True
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-Name

Hiermee geeft u de naam van de extensiekluis. Als er geen naam is opgegeven, wordt de modulenaam gebruikt als kluisnaam.

Parametereigenschappen

Type:String
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:0
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-PassThru

Geeft aan dat de cmdlet de SecretVaultInfo--object moet retourneren voor de geregistreerde extensiekluis. Standaard retourneert deze cmdlet geen uitvoer.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-VaultParameters

Hiermee geeft u een Hashtable-object met optionele sleutel-waardeparen die worden gebruikt als parameters door de extensiekluis. Deze parameters zijn optioneel. Raadpleeg de documentatie van de kluisextensiemodule om te zien welke waarden vereist zijn.

Parametereigenschappen

Type:Hashtable
Default value:None
Ondersteunt jokertekens:False
DontShow:False

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

-WhatIf

Toont wat er zou gebeuren wanneer de cmdlet wordt uitgevoerd. De cmdlet wordt niet uitgevoerd.

Parametereigenschappen

Type:SwitchParameter
Default value:False
Ondersteunt jokertekens:False
DontShow:False
Aliassen:Wi

Parametersets

(All)
Position:Named
Verplicht:False
Waarde uit pijplijn:False
Waarde uit pijplijn op eigenschapsnaam:False
Waarde van resterende argumenten:False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Invoerwaarden

None

Uitvoerwaarden

None