Remove-AzKeyVaultManagedHsm

模块:

Az.KeyVault Module

删除/清除托管 HSM。

语法

RemoveManagedHsmByName (默认值)

Remove-AzKeyVaultManagedHsm
    [-Name] <String>
    [[-ResourceGroupName] <String>]
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

RemoveDeletedManagedHsmByName

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

RemoveManagedHsmByInputObject

Remove-AzKeyVaultManagedHsm
    [-InputObject] <PSManagedHsm>
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

RemoveDeletedManagedHsmByInputObject

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

RemoveManagedHsmByResourceId

Remove-AzKeyVaultManagedHsm
    [-ResourceId] <String>
    [-Force]
    [-AsJob]
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [-SubscriptionId <String>]
    [<CommonParameters>]

RemoveDeletedManagedHsmByResourceId

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
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Confirm

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

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False
别名:	Cf

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-DefaultProfile

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

参数属性

类型:	IAzureContextContainer
默认值:	None
支持通配符:	False
不显示:	False
别名:	AzContext, AzureRmContext, AzureCredential

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Force

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

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-InputObject

要删除的托管 HSM 对象。

参数属性

类型:	PSManagedHsm
默认值:	None
支持通配符:	False
不显示:	False

参数集

RemoveManagedHsmByInputObject

Position:	0
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

RemoveDeletedManagedHsmByInputObject

Position:	0
必需:	True
来自管道的值:	True
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-InRemovedState

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

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

RemoveDeletedManagedHsmByName

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

RemoveDeletedManagedHsmByInputObject

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

RemoveDeletedManagedHsmByResourceId

Position:	Named
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Location

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

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

RemoveDeletedManagedHsmByName

Position:	1
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

RemoveDeletedManagedHsmByResourceId

Position:	1
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-Name

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

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False
别名:	HsmName

参数集

RemoveManagedHsmByName

Position:	0
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

RemoveDeletedManagedHsmByName

Position:	0
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-PassThru

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

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-ResourceGroupName

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

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

RemoveManagedHsmByName

Position:	1
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

-ResourceId

ManagedHsm 资源 ID。

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

RemoveManagedHsmByResourceId

Position:	0
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

RemoveDeletedManagedHsmByResourceId

Position:	0
必需:	True
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-SubscriptionId

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

参数属性

类型:	String
默认值:	None
支持通配符:	False
不显示:	False

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	True
来自剩余参数的值:	False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:	SwitchParameter
默认值:	None
支持通配符:	False
不显示:	False
别名:	无线

参数集

(All)

Position:	Named
必需:	False
来自管道的值:	False
来自管道的值（按属性名称）:	False
来自剩余参数的值:	False

CommonParameters

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

输入

PSManagedHsm

String

输出

Boolean

相关链接

• Get-AzKeyVaultManagedHsm
• New-AzKeyVaultManagedHsm
• Update-AzKeyVaultManagedHsm
• Undo-AzKeyVaultManagedHsmRemoval