Register-SecretVault
Registra un módulo del almacén de extensiones SecretManagement para el usuario actual.
Sintaxis
Default (valor predeterminado)
Register-SecretVault
[-ModuleName] <String>
[[-Name] <String>]
[-VaultParameters <Hashtable>]
[-DefaultVault]
[-AllowClobber]
[-PassThru]
[-Description <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Importante
El equipo de PowerShell ha decidido que los módulos Secret son completos en funciones y que ya no se desarrollarán activamente. Los módulos seguirán siendo compatibles con la seguridad y la corrección de errores críticos. El repositorio de código ha sido archivado.
Las últimas versiones publicadas son:
La naturaleza de los secretos ha cambiado fundamentalmente desde que se diseñó este proyecto. Los métodos de autenticación sin contraseña como las llaves de acceso, el inicio de sesión único y los sistemas federados de credenciales como Microsoft Entra ID, biometría y claves de seguridad hardware son el futuro.
Este cmdlet agrega un almacén de extensiones de 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 para el usuario actual y no afectan a los registros de otros almacenes de usuario.
El primer almacén registrado con este cmdlet se define automáticamente como el almacén predeterminado, incluso si no se especifica 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 de Microsoft.PowerShell.SecretStore para el usuario actual.
Usa el parámetro DefaultVault para que el almacén registrado sea 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 estableció 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 de Az.KeyVault para el usuario actual. El módulo Az.KeyVault debe instalarse antes. Para VaultParameters:
-
AZKVaultNameespecifica el nombre de Key Vault en Azure -
SubscriptionIdespecifica el identificador de la suscripción en la que se crea key Vault.
Parámetros
-AllowClobber
Si se especifica, permite que el cmdlet sobrescriba un almacén de extensiones registrado existente con el mismo nombre.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Confirm
Le pide confirmación antes de ejecutar el cmdlet.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | cf |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-DefaultVault
Si se especifica, establece el nuevo almacén de extensiones como almacén predeterminado para el usuario actual.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Description
Describe el almacén. Este valor se incluye en la información del Registro del almacén.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | 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.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | 1 |
| Obligatorio: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | 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.
Propiedades de parámetro
| Tipo: | String |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | 0 |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | 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.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | 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.
Propiedades de parámetro
| Tipo: | Hashtable |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-WhatIf
Muestra lo que sucedería si el cmdlet se ejecuta. El cmdlet no se ejecuta.
Propiedades de parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | Wi |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Obligatorio: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
CommonParameters
Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.