Remove-AzKeyVaultSecret
Supprime un secret dans un coffre de clés.
Syntax
Remove-AzKeyVaultSecret
[-VaultName] <String>
[-Name] <String>
[-Force]
[-PassThru]
[-InRemovedState]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzKeyVaultSecret
[-InputObject] <PSKeyVaultSecretIdentityItem>
[-Force]
[-PassThru]
[-InRemovedState]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
L’applet de commande Remove-AzKeyVaultSecret supprime un secret dans un coffre de clés. Si le secret a été supprimé accidentellement, le secret peut être récupéré à l’aide d’Undo-AzKeyVaultSecretRemoval par un utilisateur disposant d’autorisations spéciales « récupérer ». Cette applet de commande a une valeur élevée pour la propriété ConfirmImpact .
Exemples
Exemple 1 : Supprimer un secret d’un coffre de clés
Remove-AzKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -PassThru
Vault Name : Contoso
Name : FinanceSecret
Version : f622abc7b1394092812f1eb0f85dc91c
Id : https://contoso.vault.azure.net:443/secrets/financesecret/f622abc7b1394092812f1eb0f85dc91c
Deleted Date : 5/25/2018 4:45:34 PM
Scheduled Purge Date : 8/23/2018 4:45:34 PM
Enabled : True
Expires :
Not Before :
Created : 4/19/2018 5:56:02 PM
Updated : 4/26/2018 7:48:40 PM
Content Type :
Tags :
Cette commande supprime le secret nommé FinanceSecret du coffre de clés nommé Contoso.
Exemple 2 : Supprimer un secret d’un coffre de clés sans confirmation de l’utilisateur
Remove-AzKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -PassThru -Force
Vault Name : Contoso
Name : FinanceSecret
Version : f622abc7b1394092812f1eb0f85dc91c
Id : https://contoso.vault.azure.net:443/secrets/financesecret/f622abc7b1394092812f1eb0f85dc91c
Deleted Date : 5/25/2018 4:45:34 PM
Scheduled Purge Date : 8/23/2018 4:45:34 PM
Enabled : True
Expires :
Not Before :
Created : 4/19/2018 5:56:02 PM
Updated : 4/26/2018 7:48:40 PM
Content Type :
Tags :
Cette commande supprime le secret nommé FinanceSecret du coffre de clés nommé Contoso. La commande spécifie les paramètres Force et Confirm . Par conséquent, l’applet de commande ne vous invite pas à confirmer.
Exemple 3 : Supprimer un secret dans Azure Key Vault par commande Remove-Secret dans le module Microsoft.PowerShell.SecretManagement
# Install module Microsoft.PowerShell.SecretManagement
Install-Module Microsoft.PowerShell.SecretManagement -Repository PSGallery -AllowPrerelease
# Register vault for Secret Management
Register-SecretVault -Name AzKeyVault -ModuleName Az.KeyVault -VaultParameters @{ AZKVaultName = 'test-kv'; SubscriptionId = 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx' }
# Set secret for vault AzKeyVault
$secure = ConvertTo-SecureString -String "Password" -AsPlainText -Force
Set-Secret -Vault AzKeyVault -Name secureSecret -SecureStringSecret $secure
Remove-Secret -Vault AzKeyVault -Name secureSecret
None
Cet exemple supprime un secret nommé secureSecret
dans Azure Key Vault test-kv
par commande Remove-Secret
dans le module Microsoft.PowerShell.SecretManagement
.
Exemple 4 : Purger définitivement le secret supprimé du coffre de clés
Remove-AzKeyVaultSecret -VaultName 'Contoso' -Name 'FinanceSecret' -InRemovedState
Cette commande supprime le secret nommé FinanceSecret du coffre de clés nommé Contoso définitivement. L’exécution de cette applet de commande nécessite l’autorisation « purge », qui doit avoir été accordée précédemment et explicitement à l’utilisateur pour ce coffre de clés.
Paramètres
-Confirm
Vous demande une confirmation avant d’exécuter l’applet de commande.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure
Type: | IAzureContextContainer |
Aliases: | AzContext, AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Force
Force l’exécution de la commande sans demander la confirmation de l’utilisateur.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Key Vault Secret, objet
Type: | PSKeyVaultSecretIdentityItem |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InRemovedState
S’il est présent, supprime définitivement le secret précédemment supprimé.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Spécifie le nom d’un secret. Cette applet de commande construit le nom de domaine complet (FQDN) d’un secret en fonction du nom spécifié par ce paramètre, du nom du coffre de clés et de votre environnement actuel.
Type: | String |
Aliases: | SecretName |
Position: | 1 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Indique que cette applet de commande renvoie un objet Microsoft.Azure.Commands.KeyVault.Models.Secret . Par défaut, cette applet de commande ne génère aucun résultat.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VaultName
Spécifie le nom du coffre de clés auquel appartient le secret. Cette applet de commande construit le nom de domaine complet d’un coffre de clés en fonction du nom spécifié par ce paramètre et de votre environnement actuel.
Type: | String |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-WhatIf
Montre ce qui se passe en cas d’exécution de l’applet de commande. L’applet de commande n’est pas exécutée. Affiche ce qui se passerait si l’applet de commande s’exécute. L’applet de commande n’est pas exécutée.
Type: | SwitchParameter |
Aliases: | wi |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Entrées
Sorties
Liens associés
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour