Remove-AzKeyVault
Supprime un coffre de clés.
Syntaxe
ByAvailableVault (Par défaut)
Remove-AzKeyVault
[-VaultName] <String>
[[-ResourceGroupName] <String>]
[[-Location] <String>]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
ByDeletedVault
Remove-AzKeyVault
[-VaultName] <String>
[-Location] <String>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Remove-AzKeyVault
[-InputObject] <PSKeyVault>
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Remove-AzKeyVault
[-InputObject] <PSKeyVault>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
ResourceIdByAvailableVault
Remove-AzKeyVault
[-ResourceId] <String>
[[-Location] <String>]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
ResourceIdByDeletedVault
Remove-AzKeyVault
[-ResourceId] <String>
[-Location] <String>
[-InRemovedState]
[-Force]
[-AsJob]
[-PassThru]
[-DefaultProfile <IAzureContextContainer>]
[-WhatIf]
[-Confirm]
[-SubscriptionId <String>]
[<CommonParameters>]
Description
L’applet de commande Remove-AzKeyVault supprime le coffre de clés spécifié.
Il supprime également toutes les clés et secrets contenus dans cette instance.
Notez que bien que la spécification du groupe de ressources soit facultative pour cette applet de commande, vous devez donc améliorer les performances.
Exemples
Exemple 1 : Supprimer un coffre de clés
Remove-AzKeyVault -VaultName "Contoso03Vault" -PassThru
True
Cette commande supprime le coffre de clés nommé Contoso03Vault de votre abonnement actuel.
Exemple 2 : Supprimer un coffre de clés d’un groupe de ressources spécifié
Remove-AzKeyVault -Name "Contoso03Vault" -ResourceGroupName "Group14" -PassThru
True
Cette commande supprime le coffre de clés nommé Contoso03Vault du groupe de ressources nommé.
Si vous ne spécifiez pas le nom du groupe de ressources, l’applet de commande recherche le coffre de clés nommé à supprimer dans votre abonnement actuel.
Paramètres
-AsJob
Exécuter l’applet de commande en arrière-plan
Propriétés du paramètre
Type: SwitchParameter
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
-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
-DefaultProfile
Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure
Propriétés du paramètre
Type: IAzureContextContainer
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False Alias: AzContext, AzureRmContext, AzureCredential
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
-Force
Indique que l’applet de commande ne vous invite pas à confirmer.
Par défaut, cette applet de commande vous invite à confirmer que vous souhaitez supprimer le coffre de clés.
Propriétés du paramètre
Type: SwitchParameter
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
Objet Key Vault à supprimer.
Type: PSKeyVault
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
InputObjectByAvailableVault
Position: 0 Obligatoire: True Valeur du pipeline: True Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
InputObjectByDeletedVault
Position: 0 Obligatoire: True Valeur du pipeline: True Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-InRemovedState
Supprimez définitivement le coffre précédemment supprimé.
Propriétés du paramètre
Type: SwitchParameter
Valeur par défaut: None Prend en charge les caractères génériques: False DontShow: False
Jeux de paramètres
ByDeletedVault
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
InputObjectByDeletedVault
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
ResourceIdByDeletedVault
Position: Named Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-Location
Emplacement du coffre supprimé.
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
ByAvailableVault
Position: 2 Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
ResourceIdByAvailableVault
Position: 2 Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-PassThru
Cette applet de commande ne retourne pas d’objet par défaut. Si ce commutateur est spécifié, il retourne true en cas de réussite.
Propriétés du paramètre
Type: SwitchParameter
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
-ResourceGroupName
Spécifie le nom d’un groupe de ressources.
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
ByAvailableVault
Position: 1 Obligatoire: False Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
-ResourceId
ID de ressource KeyVault.
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
ResourceIdByAvailableVault
Position: 0 Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
ResourceIdByDeletedVault
Position: 0 Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: True Valeur des arguments restants: False
-SubscriptionId
ID de l’abonnement.
Par défaut, les applets de commande sont exécutées dans l’abonnement défini dans le contexte actuel. Si l’utilisateur spécifie un autre abonnement, l’applet de commande actuelle est exécutée dans l’abonnement spécifié par l’utilisateur.
La substitution d’abonnements prend effet uniquement pendant le cycle de vie de l’applet de commande actuelle. Il ne modifie pas l’abonnement dans le contexte et n’affecte pas les applets de commande suivantes.
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é: True Valeur des arguments restants: False
-VaultName
Spécifie le nom du coffre de clés à supprimer.
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 Alias: Nom
Jeux de paramètres
ByAvailableVault
Position: 0 Obligatoire: True Valeur du pipeline: False Valeur du pipeline par nom de propriété: False Valeur des arguments restants: False
ByDeletedVault
Position: 0 Obligatoire: True 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. Affiche ce qui se passerait si l’applet de commande s’exécute.
L’applet de commande ne s’exécute pas.
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 .
Sorties
