Register-SecretVault

Referencia

Módulo:: Microsoft.PowerShell.SecretManagement

Registra un módulo del almacén de extensiones SecretManagement para el usuario actual.

Syntax

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

Description

Este cmdlet agrega un almacén de extensiones SecretManagement al registro del almacén del usuario actual. Un almacén de extensiones es un módulo de PowerShell que se ajusta al formato de almacén de extensiones necesario. Este cmdlet comprueba que el módulo especificado cumple los requisitos de conformidad antes de agregarlo al registro del almacén de extensiones. Los almacenes de extensiones se registran en el usuario actual y no afectan a otros registros del almacén de usuarios.

El primer almacén registrado con este cmdlet se define automáticamente como almacén predeterminado aunque no se especifique el parámetro DefaultVault .

Ejemplos

Ejemplo 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

En este ejemplo se registra un almacén de extensiones Microsoft.PowerShell.SecretStore para el usuario actual. Usa el parámetro DefaultVault para convertir el almacén registrado en el almacén predeterminado para el usuario. Get-SecretVault enumera todos los almacenes registrados para el usuario, comprobando que el almacén se registró y establecido como almacén predeterminado.

Ejemplo 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

En este ejemplo se registra un almacén de extensiones Az.KeyVault para el usuario actual. El módulo Az.KeyVault debe instalarse antes. Para VaultParameters:

AZKVaultNameespecifica el nombre del Key Vault en Azure.
SubscriptionIdespecifica el identificador de la suscripción en la que se crea el Key Vault

Parámetros

-AllowClobber

Si se especifica, permite que el cmdlet sobrescriba un almacén de extensiones registrado existente con el mismo nombre.

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

-Confirm

Le solicita su confirmación antes de ejecutar el cmdlet.

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

-DefaultVault

Si se especifica, establece el nuevo almacén de extensiones como almacén predeterminado para el usuario actual.

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

-Description

Describe el almacén. Este valor se incluye en la información del Registro del almacén.

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

-ModuleName

Especifica el nombre del módulo de PowerShell que implementa el almacén de extensiones. Escriba el nombre de un módulo o la ruta de acceso al módulo. Si especifica un nombre, PowerShell lo busca en las rutas de acceso de módulo conocidas. Si especifica una ruta de acceso, PowerShell busca esa ruta de acceso para el módulo.

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

-Name

Especifica el nombre del almacén de extensiones. Si no se especifica ningún nombre, el nombre del módulo se usa como nombre del almacén.

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

-PassThru

Indica que el cmdlet debe devolver el objeto SecretVaultInfo para el almacén de extensiones registrado correctamente. De forma predeterminada, este cmdlet no devuelve ninguna salida.

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

-VaultParameters

Especifica un objeto Hashtable que contiene pares clave-valor opcionales usados como parámetros por el almacén de extensiones. Estos parámetros son opcionales. Consulte la documentación del módulo de extensión del almacén para ver qué valores son necesarios.

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

-WhatIf

Muestra lo que sucedería si se ejecutara el cmdlet. El cmdlet no se ejecuta.

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

Entradas

None

Salidas