Register-SecretVault
Inscrit un module de coffre d’extensions SecretManagement pour l’utilisateur actuel.
Syntaxe
Default (Par défaut)
Register-SecretVault
[-ModuleName] <String>
[[-Name] <String>]
[-VaultParameters <Hashtable>]
[-DefaultVault]
[-AllowClobber]
[-PassThru]
[-Description <String>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
Important
L’équipe PowerShell a décidé que les modules Secret sont complets en fonctionnalités et ne seront plus activement développés. Les modules continueront d’être pris en charge pour la sécurité et les corrections de bugs critiques. Le dépôt de code a été archivé.
Les dernières versions publiées sont :
La nature des secrets a fondamentalement changé depuis la conception de ce projet. Les méthodes d’authentification sans mot de passe telles que les clés d’accès, la connexion unique, et les systèmes d’accréditation fédérés tels que Microsoft Entra ID, la biométrie et les clés de sécurité matérielles représentent l’avenir.
Cette applet de commande ajoute un SecretManagement coffre d’extension au registre du coffre de l’utilisateur actuel. Un coffre d’extensions est un module PowerShell conforme au format de coffre d’extension requis. Cette applet de commande vérifie que le module spécifié répond aux exigences de conformité avant de l’ajouter au registre du coffre d’extensions. Les coffres-forts d’extensions sont enregistrés pour l’utilisateur actuel et n’affectent pas les autres enregistrements de coffres-forts utilisateur.
Le premier coffre enregistré avec cette applet de commande est automatiquement défini comme coffre-fort par défaut, même si le paramètre DefaultVault n’est pas spécifié.
Exemples
Exemple 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
Cet exemple enregistre un coffre d’extensions Microsoft.PowerShell.SecretStore pour l’utilisateur actuel.
Il utilise le paramètre DefaultVault pour rendre le coffre inscrit le coffre par défaut pour l’utilisateur.
Get-SecretVault répertorie tous les coffres inscrits pour l’utilisateur, en vérifiant que le coffre a été inscrit et défini comme coffre par défaut.
Exemple 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
Cet exemple enregistre un coffre d’extension Az.KeyVault pour l’utilisateur actuel. Le module Az.KeyVault doit être installé avant. Pour les VaultParameters :
-
AZKVaultNamespécifie le nom du coffre de clés sur Azure -
SubscriptionIdspécifie l’ID de l’abonnement dans lequel le coffre de clés est créé
Paramètres
-AllowClobber
Si elle est spécifiée, permet à l’applet de commande de remplacer un coffre d’extensions inscrit existant portant le même nom.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Confirm
Vous invite à confirmer avant d’exécuter l’applet de commande.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | cf |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-DefaultVault
Si elle est spécifiée, définit le nouveau coffre d’extension comme coffre par défaut pour l’utilisateur actuel.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Description
Décrit le coffre. Cette valeur est incluse dans les informations du Registre du coffre.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-ModuleName
Spécifie le nom du module PowerShell qui implémente le coffre d’extensions. Entrez le nom d’un module ou le chemin d’accès au module. Si vous spécifiez un nom, PowerShell le recherche dans les chemins de module connus. Si vous spécifiez un chemin d’accès, PowerShell recherche ce chemin d’accès pour le module.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | 1 |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Name
Spécifie le nom du coffre d’extensions. Si aucun nom n’est spécifié, le nom du module est utilisé comme nom du coffre.
Propriétés du paramètre
| Type: | String |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | 0 |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-PassThru
Indique que l’applet de commande doit renvoyer l’objet SecretVaultInfo pour le coffre d’extensions enregistré avec succès. Par défaut, cette applet de commande ne retourne aucune sortie.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-VaultParameters
Spécifie un objet hashtable contenant des paires clé-valeur facultatives utilisées comme paramètres par le coffre d’extensions. Ces paramètres sont facultatifs. Consultez la documentation du module d’extension du coffre pour voir quelles valeurs sont requises.
Propriétés du paramètre
| Type: | Hashtable |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-WhatIf
Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | Wi |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.