Partager via

Remove-AzKeyVaultManagedHsm

  • Référence
Module:
Az.KeyVault

Supprime/purge un HSM managé.

Syntaxe

Remove-AzKeyVaultManagedHsm
      [-Name] <String>
      [[-ResourceGroupName] <String>]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultManagedHsm
      [-Name] <String>
      [-Location] <String>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultManagedHsm
      [-InputObject] <PSManagedHsm>
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultManagedHsm
      [-InputObject] <PSManagedHsm>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultManagedHsm
      [-ResourceId] <String>
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]
Remove-AzKeyVaultManagedHsm
      [-ResourceId] <String>
      [-Location] <String>
      [-InRemovedState]
      [-Force]
      [-AsJob]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]

Description

La cmdlet Remove-AzKeyVaultManagedHsm supprime le HSM managé spécifié. Elle supprime également toutes les clés contenues 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 HSM managé

Remove-AzKeyVaultManagedHsm -HsmName 'myhsm' -Force

True

Cette commande supprime le HSM managé nommé myhsm de votre abonnement actuel.

Exemple 2 : Supprimer un hsm managé d’un groupe de ressources spécifié

Remove-AzKeyVaultManagedHsm -HsmName 'myhsm' -ResourceGroupName "myrg1" -PassThru

True

Cette commande supprime le HSM managé nommé myhsm du groupe de ressources nommé myrg1. Si vous ne spécifiez pas le nom du groupe de ressources, l’applet de commande recherche le HSM managé nommé à supprimer dans votre abonnement actuel.

Exemple 3 : vider un hsm managé supprimé

Remove-AzKeyVaultManagedHsm -Name 'myhsm' -Location "eastus" -Force -PassThru

True

Cette commande vide le HSM managé nommé myhsm situé à eastus.

Paramètres

-AsJob

Exécuter l’applet de commande en arrière-plan

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

Type:SwitchParameter
Alias:cf
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-DefaultProfile

Informations d’identification, compte, locataire et abonnement utilisés pour la communication avec Azure.

Type:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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 HSM managé.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-InputObject

Objet HSM managé à supprimer.

Type:PSManagedHsm
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-InRemovedState

Supprimez définitivement le pool HSM managé précédemment supprimé.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Location

Emplacement du pool HSM managé supprimé.

Type:String
Position:1
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-Name

Spécifie le nom du HSM managé à supprimer.

Type:String
Alias:HsmName
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:False
Accepter les caractères génériques: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.

Type:SwitchParameter
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ResourceGroupName

Spécifie le nom du groupe de ressources pour le HSM managé Azure à supprimer.

Type:String
Position:1
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

-ResourceId

ID de ressource ManagedHsm.

Type:String
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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.

Type:String
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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.

Type:SwitchParameter
Alias:wi
Position:Named
Valeur par défaut:None
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

PSManagedHsm

String

Sorties

Boolean