通过

你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Remove-AzKeyVaultManagedHsm

  • 参考
模块:
Az.KeyVault

删除/清除托管 HSM。

语法

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>]

说明

Remove-AzKeyVaultManagedHsm cmdlet 删除指定的托管 HSM。 它还删除该实例中包含的所有密钥。 请注意，尽管为此 cmdlet 指定资源组是可选的，但为了提高性能，应这样做。

示例

示例 1：删除托管 HSM

Remove-AzKeyVaultManagedHsm -HsmName 'myhsm' -Force

True

此命令从当前订阅中删除名为 myhsm 的托管 HSM。

示例 2：从指定的资源组中删除托管 hsm

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

True

此命令从名为myg1 的资源组中删除名为 myhsm 的托管 HSM。 如果未指定资源组名称，则 cmdlet 将在当前订阅中搜索要删除的命名托管 HSM。

示例 3：清除已删除的托管 hsm

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

True

此命令清除位于 eastus 的名为 myhsm 的托管 HSM。

参数

-AsJob

在后台运行 cmdlet

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Confirm

提示你在运行 cmdlet 之前进行确认。

类型:SwitchParameter
别名:cf
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

类型:IAzureContextContainer
别名:AzContext, AzureRmContext, AzureCredential
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-Force

指示该 cmdlet 不会提示你进行确认。 默认情况下，此 cmdlet 会提示你确认要删除托管 HSM。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-InputObject

要删除的托管 HSM 对象。

类型:PSManagedHsm
Position:0
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-InRemovedState

永久删除以前删除的托管 HSM 池。

类型:SwitchParameter
Position:Named
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-Location

已删除的托管 HSM 池的位置。

类型:String
Position:1
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-Name

指定要删除的托管 HSM 的名称。

类型:String
别名:HsmName
Position:0
默认值:None
必需:True
接受管道输入:False
接受通配符:False

-PassThru

默认情况下，此 Cmdlet 不返回对象。 如果指定了此开关，则如果成功，则返回 true。

类型:SwitchParameter
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ResourceGroupName

指定要删除的 Azure 托管 HSM 的资源组的名称。

类型:String
Position:1
默认值:None
必需:False
接受管道输入:False
接受通配符:False

-ResourceId

ManagedHsm 资源 ID。

类型:String
Position:0
默认值:None
必需:True
接受管道输入:True
接受通配符:False

-SubscriptionId

订阅 ID。 默认情况下，cmdlet 在当前上下文中设置的订阅中执行。 如果用户指定另一个订阅，则当前 cmdlet 在用户指定的订阅中执行。 重写订阅仅在当前 cmdlet 的生命周期内生效。 它不会更改上下文中的订阅，并且不会影响后续 cmdlet。

类型:String
Position:Named
默认值:None
必需:False
接受管道输入:True
接受通配符:False

-WhatIf

显示运行该 cmdlet 时会发生什么情况。 cmdlet 未运行。

类型:SwitchParameter
别名:wi
Position:Named
默认值:None
必需:False
接受管道输入:False
接受通配符:False

输入

PSManagedHsm

String

输出

Boolean