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

Update-AzKeyVaultManagedHsm

参考

模块:: Az.KeyVault

更新 Azure 托管 HSM 的状态。

语法

Update-AzKeyVaultManagedHsm
      -Name <String>
      -ResourceGroupName <String>
      [-EnablePurgeProtection]
      [-PublicNetworkAccess <String>]
      [-UserAssignedIdentity <String[]>]
      [-Tag <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]

Update-AzKeyVaultManagedHsm
      -InputObject <PSManagedHsm>
      [-EnablePurgeProtection]
      [-PublicNetworkAccess <String>]
      [-UserAssignedIdentity <String[]>]
      [-Tag <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]

Update-AzKeyVaultManagedHsm
      -ResourceId <String>
      [-EnablePurgeProtection]
      [-PublicNetworkAccess <String>]
      [-UserAssignedIdentity <String[]>]
      [-Tag <Hashtable>]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [-SubscriptionId <String>]
      [<CommonParameters>]

说明

此 cmdlet 更新 Azure 托管 HSM 的状态。

示例

示例 1：直接更新托管 Hsm

Update-AzKeyVaultManagedHsm -Name $hsmName -ResourceGroupName $resourceGroupName -Tag @{testKey="testValue"} | Format-List

Managed HSM Name                    : testmhsm
Resource Group Name                 : testmhsm
Location                            : eastus2euap
Resource ID                         : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/testmhsm/provid
                                      ers/Microsoft.KeyVault/managedHSMs/testmhsm
HSM Pool URI                        :
Tenant ID                           : xxxxxx-xxxx-xxxx-xxxxxxxxxxxx
Initial Admin Object Ids            : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
SKU                                 : StandardB1
Soft Delete Enabled?                : True
Enabled Purge Protection?           : False
Soft Delete Retention Period (days) : 90
Provisioning State                  : Provisioning
Status Message                      : Resource creation in progress. Starting service...
Tags                                :
                                      Name        Value
                                      ====        =====
                                      testKey     testValued

更新资源组 $resourceGroupName中名为 $hsmName 的托管 Hsm 的标记。

示例 2：使用管道更新托管 Hsm

Get-AzKeyVaultManagedHsm -Name $hsmName -ResourceGroupName $resourceGroupName | Update-AzKeyVaultManagedHsm -Tag @{testKey="testValue"}

使用管道语法更新托管 Hsm 的标记。

示例 3：为托管 Hsm 启用清除保护

Update-AzKeyVaultManagedHsm -Name $hsmName -ResourceGroupName $resourceGroupName -EnablePurgeProtection | Format-List

Managed HSM Name                    : testmhsm
Resource Group Name                 : test-rg
Location                            : eastus
Resource ID                         : /subscriptions/xxxxxx71-1bf0-4dda-aec3-xxxxxxxxxxxx/resourceGroups/test-rg/provide
                                      rs/Microsoft.KeyVault/managedHSMs/testmhsm
HSM Pool URI                        :
Tenant ID                           : 54xxxxxx-38d6-4fb2-bad9-xxxxxxxxxxxx
Initial Admin Object Ids            : {xxxxxx9e-5be9-4f43-abd2-xxxxxxxxxxxx}
SKU                                 : StandardB1
Soft Delete Enabled?                : True
Enabled Purge Protection?           : True
Soft Delete Retention Period (days) : 70
Provisioning State                  : Succeeded
Status Message                      : The Managed HSM is provisioned and ready to use.
Tags                                :

为资源组 $resourceGroupName中名为 $hsmName 的托管 Hsm 启用清除保护。

示例 4：更新托管 Hsm 的用户分配标识

Update-AzKeyVaultManagedHsm -Name testmhsm -ResourceGroupName test-rg -UserAssignedIdentity /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/bez-rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/bez-id02 | Format-List

Managed HSM Name                        : testmshm
Resource Group Name                     : test-rg
Location                                : eastus2euap
Resource ID                             : /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/pro
                                          viders/Microsoft.KeyVault/managedHSMs/testmhsm
HSM Pool URI                            :
Tenant ID                               : xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
Initial Admin Object Ids                : {xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx}
SKU                                     : StandardB1
Soft Delete Enabled?                    : True
Enabled Purge Protection?               : False
Soft Delete Retention Period (days)     : 70
Public Network Access                   : Enabled
IdentityType                            : UserAssigned
UserAssignedIdentities                  : /subscriptions/xxxx/resourceGroups/xxxx/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identityName
Provisioning State                      : Succeeded
Status Message                          : The Managed HSM is provisioned and ready to use.
Security Domain ActivationStatus        : Active
Security Domain ActivationStatusMessage : Your HSM has been activated and can be used for cryptographic operations.
Regions                                 : 
Tags

此命令在资源组 test-rg中添加名为 testmshm 的托管 Hsm 的用户分配标识。

参数

-Confirm

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

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

-DefaultProfile

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

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

-EnablePurgeProtection

指定是否为此托管 HSM 池启用了针对清除的保护。仅当启用软删除时，此设置才有效。启用此功能不可逆。

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

-InputObject

托管 HSM 对象。

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

-Name

托管 HSM 的名称。

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

-PublicNetworkAccess

在启用专用终结点时控制来自公用网络的数据平面流量的权限。

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

-ResourceGroupName

资源组的名称。

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

-ResourceId

托管 HSM 的资源 ID。

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

-SubscriptionId

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

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

-Tag

表示资源标记的哈希表。

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

-UserAssignedIdentity

与托管 HSM 关联的用户分配标识集。其值为 ARM 资源 ID，格式为“/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}”。

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

-WhatIf

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

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

输入

PSManagedHsm

String

Hashtable

输出

PSManagedHsm

通过

Update-AzKeyVaultManagedHsm

语法

说明

示例

示例 1：直接更新托管 Hsm

示例 2：使用管道更新托管 Hsm

示例 3：为托管 Hsm 启用清除保护

示例 4：更新托管 Hsm 的用户分配标识

参数

-Confirm

-DefaultProfile

-EnablePurgeProtection

-InputObject

-Name

-PublicNetworkAccess

-ResourceGroupName

-ResourceId

-SubscriptionId

-Tag

-UserAssignedIdentity

-WhatIf

输入

输出

其他资源

通过

Update-AzKeyVaultManagedHsm

语法

说明

示例

示例 1：直接更新托管 Hsm

示例 2：使用管道更新托管 Hsm

示例 3：为托管 Hsm 启用清除保护

示例 4：更新托管 Hsm 的用户分配标识

参数

-Confirm

-DefaultProfile

-EnablePurgeProtection

-InputObject

-Name

-PublicNetworkAccess

-ResourceGroupName

-ResourceId

-SubscriptionId

-Tag

-UserAssignedIdentity

-WhatIf

输入

输出

相关链接

其他资源