Register-SecretVault

Referentie

Module:: Microsoft.PowerShell.SecretManagement

Registreert een secretmanagement-extensiekluismodule voor de huidige gebruiker.

Syntax

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

Description

Deze cmdlet voegt een SecretManagement-extensiekluis toe aan het kluisregister van de huidige gebruiker. Een extensiekluis is een PowerShell-module die voldoet aan de vereiste extensiekluisindeling. Deze cmdlet controleert of de opgegeven module voldoet aan de nalevingsvereisten voordat deze wordt toegevoegd aan het register van de extensiekluis. Extensiekluizen worden geregistreerd bij de huidige gebruiker en hebben geen invloed op de registraties van andere 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 geregistreerd voor de huidige gebruiker. De parameter DefaultVault wordt gebruikt om van de geregistreerde kluis de standaardkluis voor de gebruiker te maken. Get-SecretVault een lijst met alle geregistreerde kluizen voor de gebruiker, waarbij wordt gecontroleerd of de kluis is geregistreerd en is 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 geregistreerd voor de huidige gebruiker. De Az.KeyVault-module moet vooraf worden geïnstalleerd. Voor de VaultParameters:

AZKVaultNamehiermee geeft u de naam van de Key Vault op Azure
SubscriptionIdhiermee geeft u de id op van het abonnement waarin de Key Vault wordt gemaakt in

Parameters

-AllowClobber

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

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

-Confirm

Hiermee wordt u gevraagd om bevestiging voordat u de cmdlet uitvoert.

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

-DefaultVault

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

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

-Description

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

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

-ModuleName

Hiermee geeft u de naam van de PowerShell-module op die de extensiekluis implementeert. 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.

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

-Name

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

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

-PassThru

Geeft aan dat de cmdlet het Object SecretVaultInfo moet retourneren voor de extensiekluis die is geregistreerd. Standaard retourneert deze cmdlet geen uitvoer.

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	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 module voor de kluisextensie om te zien welke waarden vereist zijn.

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

-WhatIf

Hiermee wordt weergegeven wat er zou gebeuren als u de cmdlet uitvoert. De cmdlet wordt niet uitgevoerd.

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

Invoerwaarden

None

Uitvoerwaarden