Update-AzKeyVaultSetting

  • 參考
模組:
Az.KeyVault

更新與受控 HSM 相關聯的特定設定。

Syntax

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

Description

Update-AzKeyVaultSetting Cmdlet 會更新密鑰保存庫帳戶設定。 此 Cmdlet 會更新特定的金鑰保存庫帳戶設定。

範例

範例 1：更新特定的金鑰保存庫帳戶設定

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

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

更新受控 Hsm 中名為 AllowKeyManagementOperationsThroughARMtestmhsm的特定金鑰保存庫帳戶設定。

範例 2：更新與另一個帳戶設定相同的特定密鑰保存庫帳戶設定

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

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

使用更新受控 Hsm 中名為 AllowKeyManagementOperationsThroughARMtestmhsm2testmhsm1的特定金鑰保存庫帳戶設定。

範例 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 更新受控 Hsm 中名為 AllowKeyManagementOperationsThroughARMtestmhsm 的特定密鑰保存庫帳戶設定。

範例 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 更新受控 Hsm 中名為 AllowKeyManagementOperationsThroughARMtestmhsm 的特定密鑰保存庫帳戶設定。

參數

-Confirm

執行 Cmdlet 之前先提示您確認。

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

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

Cmdlet 預設不會傳回 物件。 如果指定此參數，則傳回 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

顯示執行 Cmdlet 後會發生的情況。 未執行 Cmdlet。

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

輸入

PSKeyVaultSetting

PSManagedHsm

輸出

PSKeyVaultSetting