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

説明

このコマンドレットは、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 のユーザー割り当て ID を更新する

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 のユーザー割り当て ID を追加します。

パラメーター

-Confirm

コマンドレットの実行前に確認を求めるメッセージが表示されます。

型:	SwitchParameter
Aliases:	cf
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-DefaultProfile

Azure との通信のために使用される資格情報、アカウント、テナント、サブスクリプションです。

型:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-EnablePurgeProtection

このマネージド HSM プールに対して消去に対する保護を有効にするかどうかを指定します。この設定は、論理的な削除も有効になっている場合にのみ有効です。この機能を有効にすることは元に戻すことはできません。

型:	SwitchParameter
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-InputObject

Managed HSM オブジェクト。

型:	PSManagedHsm
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Name

マネージド HSM の名前。

型:	String
Aliases:	HsmName
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-PublicNetworkAccess

プライベートエンドポイントが有効になっている間にパブリックネットワークから送信されるデータプレーントラフィックのアクセス許可を制御します。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceGroupName

リソースグループの名前。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-ResourceId

マネージド HSM のリソース ID。

型:	String
配置:	Named
規定値:	None
必須:	True
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-SubscriptionId

サブスクリプションの ID です。既定では、コマンドレットは現在のコンテキストで設定されているサブスクリプションで実行されます。ユーザーが別のサブスクリプションを指定した場合、現在のコマンドレットはユーザーが指定したサブスクリプションで実行されます。サブスクリプションのオーバーライドは、現在のコマンドレットのライフサイクル中にのみ有効になります。コンテキスト内のサブスクリプションは変更されず、後続のコマンドレットには影響しません。

型:	String
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-Tag

リソースタグを表すハッシュテーブル。

型:	Hashtable
Aliases:	Tags
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	True
ワイルドカード文字を受け取る:	False

-UserAssignedIdentity

マネージド HSM に関連付けられているユーザー割り当て ID のセット。その値は、'/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}' という形式の ARM リソース ID になります。

型:	String[]
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

-WhatIf

コマンドレットの実行時に発生する内容を示します。このコマンドレットは実行されません。

型:	SwitchParameter
Aliases:	wi
配置:	Named
規定値:	None
必須:	False
パイプライン入力を受け取る:	False
ワイルドカード文字を受け取る:	False

入力

PSManagedHsm

String

Hashtable

出力

PSManagedHsm

次の方法で共有

Update-AzKeyVaultManagedHsm

構文

説明

例

例 1: マネージド HSM を直接更新する

例 2: パイプを使用してマネージド HSM を更新する

例 3: マネージド Hsm の消去保護を有効にする

例 4: マネージド Hsm のユーザー割り当て ID を更新する

パラメーター

-Confirm

-DefaultProfile

-EnablePurgeProtection

-InputObject

-Name

-PublicNetworkAccess

-ResourceGroupName

-ResourceId

-SubscriptionId

-Tag

-UserAssignedIdentity

-WhatIf

入力

出力

その他のリソース

次の方法で共有

Update-AzKeyVaultManagedHsm

構文

説明

例

例 1: マネージド HSM を直接更新する

例 2: パイプを使用してマネージド HSM を更新する

例 3: マネージド Hsm の消去保護を有効にする

例 4: マネージド Hsm のユーザー割り当て ID を更新する

パラメーター

-Confirm

-DefaultProfile

-EnablePurgeProtection

-InputObject

-Name

-PublicNetworkAccess

-ResourceGroupName

-ResourceId

-SubscriptionId

-Tag

-UserAssignedIdentity

-WhatIf

入力

出力

関連リンク

その他のリソース