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

Description

此 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

Managed 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 的資源標識碼。

類型:	String
Position:	Named
預設值:	None
必要:	True
接受管線輸入:	True
接受萬用字元:	False

-SubscriptionId

訂用帳戶的識別碼。根據預設，Cmdlet 會在目前內容中設定的訂用帳戶中執行。如果使用者指定另一個訂用帳戶，則會在使用者指定的訂用帳戶中執行目前的 Cmdlet。覆寫訂閱只會在目前 Cmdlet 的生命週期內生效。它不會變更內容中的訂用帳戶，而且不會影響後續的 Cmdlet。

類型:	String
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-Tag

代表資源標記的哈希表。

類型:	Hashtable
別名:	Tags
Position:	Named
預設值:	None
必要:	False
接受管線輸入:	True
接受萬用字元:	False

-UserAssignedIdentity

與受控 HSM 相關聯的使用者指派身分識別集合。其值為 ARM 資源標識符，格式為：'/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

語法

Description

範例

範例 1：直接更新受控 Hsm

範例 2：使用管線更新受控 Hsm

範例 3：啟用受控 Hsm 的清除保護

範例 4：更新受控 Hsm 的使用者指派身分識別

參數

-Confirm

-DefaultProfile

-EnablePurgeProtection

-InputObject

-Name

-PublicNetworkAccess

-ResourceGroupName

-ResourceId

-SubscriptionId

-Tag

-UserAssignedIdentity

-WhatIf

輸入

輸出

其他資源

共用方式為

Update-AzKeyVaultManagedHsm

語法

Description

範例

範例 1：直接更新受控 Hsm

範例 2：使用管線更新受控 Hsm

範例 3：啟用受控 Hsm 的清除保護

範例 4：更新受控 Hsm 的使用者指派身分識別

參數

-Confirm

-DefaultProfile

-EnablePurgeProtection

-InputObject

-Name

-PublicNetworkAccess

-ResourceGroupName

-ResourceId

-SubscriptionId

-Tag

-UserAssignedIdentity

-WhatIf

輸入

輸出

相關連結

其他資源