Remove-AzKeyVaultKey
Supprime une clé dans un coffre de clés.
Syntax
Remove-AzKeyVaultKey
[-VaultName] <String>
[-Name] <String>
[-Force]
[-PassThru]
[-InRemovedState]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzKeyVaultKey
-HsmName <String>
[-Name] <String>
[-Force]
[-PassThru]
[-InRemovedState]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Remove-AzKeyVaultKey
[-InputObject] <PSKeyVaultKeyIdentityItem>
[-Force]
[-PassThru]
[-InRemovedState]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
L’applet de commande Remove-AzKeyVaultKey supprime une clé dans un coffre de clés. Si la clé a été supprimée accidentellement, la clé peut être récupérée à l’aide d’Undo-AzKeyVaultKeyRemoval 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 une clé d’un coffre de clés
Remove-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -PassThru
Vault Name : contoso
Name : key2
Id : https://contoso.vault.azure.net:443/keys/itsoftware/fdad15793ba0437e960497908ef9eb32
Deleted Date : 5/24/2018 11:28:25 PM
Scheduled Purge Date : 8/22/2018 11:28:25 PM
Enabled : False
Expires : 10/11/2018 11:32:49 PM
Not Before : 4/11/2018 11:22:49 PM
Created : 4/12/2018 10:16:38 PM
Updated : 4/12/2018 10:16:38 PM
Purge Disabled : False
Tags :
Cette commande supprime la clé nommée ITSoftware du coffre de clés nommé Contoso.
Exemple 2 : Supprimer une clé sans confirmation de l’utilisateur
Remove-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -Force
Cette commande supprime la clé nommée ITSoftware du coffre de clés nommé Contoso. La commande spécifie le paramètre Force et, par conséquent, l’applet de commande ne vous invite pas à confirmer.
Exemple 3 : vider une clé supprimée du coffre de clés définitivement
Remove-AzKeyVaultKey -VaultName 'Contoso' -Name 'ITSoftware' -InRemovedState
Cette commande supprime la clé nommée ITSoftware 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.
Exemple 4 : Supprimer des clés à l’aide de l’opérateur de pipeline
Get-AzKeyVaultKey -VaultName 'Contoso' | Where-Object {$_.Attributes.Enabled -eq $False} | Remove-AzKeyVaultKey
Cette commande obtient toutes les clés du coffre de clés nommé Contoso et les transmet à l’applet de commande Where-Object à l’aide de l’opérateur de pipeline. Cette applet de commande transmet les clés dont la valeur est $False pour l’attribut Enabled à l’applet de commande actuelle. Cette applet de commande supprime ces clés.
Paramètres
-Confirm
Vous demande une confirmation avant d’exécuter l’applet de commande.
Type: | SwitchParameter |
Aliases: | cf |
Position: | Named |
valeur par défaut: | False |
Obligatoire: | 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 |
valeur par défaut: | None |
Obligatoire: | 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 |
valeur par défaut: | None |
Obligatoire: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-HsmName
Nom du module HSM. L’applet de commande construit le nom de domaine complet d’un HSM managé en fonction du nom et de l’environnement actuellement sélectionné.
Type: | String |
Position: | Named |
valeur par défaut: | None |
Obligatoire: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
KeyBundle, objet
Type: | PSKeyVaultKeyIdentityItem |
Position: | 0 |
valeur par défaut: | None |
Obligatoire: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-InRemovedState
Supprimez définitivement la clé précédemment supprimée.
Type: | SwitchParameter |
Position: | Named |
valeur par défaut: | None |
Obligatoire: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Name
Spécifie le nom de la clé à supprimer. Cette applet de commande construit le nom de domaine complet (FQDN) d’une clé 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: | KeyName |
Position: | 1 |
valeur par défaut: | None |
Obligatoire: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-PassThru
Indique que cette applet de commande renvoie un objet Microsoft.Azure.Commands.KeyVault.Models.PSKeyVaultKey . Par défaut, cette applet de commande ne génère aucun résultat.
Type: | SwitchParameter |
Position: | Named |
valeur par défaut: | None |
Obligatoire: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-VaultName
Spécifie le nom du coffre de clés à partir duquel supprimer la clé. 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 |
valeur par défaut: | None |
Obligatoire: | 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 |
valeur par défaut: | False |
Obligatoire: | 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