Update-AzKeyVaultSetting

  • リファレンス
モジュール:
Az.KeyVault

マネージド HSM に関連付けられている特定の設定を更新します。

構文

Update-AzKeyVaultSetting
      [-HsmName] <String>
      [-Name] <String>
      [-Value] <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzKeyVaultSetting
      [[-HsmName] <String>]
      [[-Value] <String>]
      [-InputObject] <PSKeyVaultSetting>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzKeyVaultSetting
      [-Name] <String>
      [-Value] <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-HsmObject] <PSManagedHsm>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Update-AzKeyVaultSetting
      [-Name] <String>
      [-Value] <String>
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-HsmId] <String>
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

説明

Update-AzKeyVaultSetting コマンドレットは、キー コンテナー アカウントの設定を更新します。 このコマンドレットは、特定のキー コンテナー アカウント設定を更新します。

例

例 1: 特定のキー コンテナー アカウント設定を更新する

Update-AzKeyVaultSetting -HsmName testmhsm -Name AllowKeyManagementOperationsThroughARM -Value true -PassThru

Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM true  boolean testmhsm

Managed Hsm testmhsmで指定された特定AllowKeyManagementOperationsThroughARMのキー コンテナー アカウント設定を更新します。

例 2: 別のアカウント設定と同じ特定のキー コンテナー アカウント設定を更新する

$setting = Get-AzKeyVaultSetting -HsmName testmhsm1 -Name AllowKeyManagementOperationsThroughARM
$setting | Update-AzKeyVaultSetting -HsmName testmhsm2 -PassThru

Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM true  boolean testmhsm2

同じ名前の Managed Hsm testmhsm2 で指定されたAllowKeyManagementOperationsThroughARM特定のキー コンテナー アカウント設定をtestmhsm1更新します。

例 3: HsmObject を使用して特定のキー コンテナー アカウント設定を更新する

$hsmObject = Get-AzKeyVaultManagedHsm -Name testmhsm
Update-AzKeyVaultSetting -HsmObject $hsmObject -Name AllowKeyManagementOperationsThroughARM -Value true -PassThru

Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM true  boolean testmhsm

HsmObject で指定された Managed Hsm で指定testmhsmされたAllowKeyManagementOperationsThroughARM特定のキー コンテナー アカウント設定を更新します。

例 4: HsmId を使用して特定のキー コンテナー アカウント設定を更新する

$hsmObject = Get-AzKeyVaultManagedHsm -Name testmhsm
Update-AzKeyVaultSetting -HsmId /subscriptions/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/resourceGroups/test-rg/providers/Microsoft.KeyVault/managedHSMs/testmhsm-Name AllowKeyManagementOperationsThroughARM -Value true -PassThru

Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM true  boolean testmhsm

HsmObject で指定された Managed Hsm で指定testmhsmされたAllowKeyManagementOperationsThroughARM特定のキー コンテナー アカウント設定を更新します。

パラメーター

-Confirm

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

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultProfile

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

Type:IAzureContextContainer
Aliases:AzContext, AzureRmContext, AzureCredential
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-HsmId

Hsm リソース ID。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-HsmName

HSM の名前。

Type:String
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-HsmObject

Hsm オブジェクト。

Type:PSManagedHsm
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-InputObject

削除されたコンテナーの場所。

Type:PSKeyVaultSetting
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

設定の名前。

Type:String
Position:1
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

コマンドレットは、既定ではオブジェクトを返しません。 このスイッチが指定されている場合は、Secret オブジェクトを返します。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Value

設定の値。

Type:String
Position:2
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

入力

PSKeyVaultSetting

PSManagedHsm

出力

PSKeyVaultSetting