通过


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

Update-AzKeyVaultSetting

更新与托管 HSM 关联的特定设置。

语法

UpdateSettingViaFlattenValues (默认值)

Update-AzKeyVaultSetting
    [-HsmName] <String>
    [-Name] <String>
    [-Value] <String>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

UpdateSettingViaInputObject

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

UpdateSettingViaHsmObject

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

UpdateSettingViaHsmId

Update-AzKeyVaultSetting
    [-Name] <String>
    [-Value] <String>
    [-HsmId] <String>
    [-PassThru]
    [-DefaultProfile <IAzureContextContainer>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

说明

Update-AzKeyVaultSetting cmdlet 更新密钥保管库帐户设置。 此 cmdlet 更新特定的密钥保管库帐户设置。

示例

示例 1:更新特定的密钥保管库帐户设置

Update-AzKeyVaultSetting -HsmName testmhsm -Name AllowKeyManagementOperationsThroughARM -Value true -PassThru
Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM true  boolean testmhsm

更新在命名AllowKeyManagementOperationsThroughARM的托管 Hsm 中命名testmhsm的特定密钥保管库帐户设置。

示例 2:更新与另一个帐户设置相同的特定密钥保管库帐户设置

$setting = Get-AzKeyVaultSetting -HsmName testmhsm1 -Name AllowKeyManagementOperationsThroughARM
$setting | Update-AzKeyVaultSetting -HsmName testmhsm2 -PassThru
Name                                   Value Type    HSM Name
----                                   ----- ----    --------
AllowKeyManagementOperationsThroughARM true  boolean testmhsm2

更新名为AllowKeyManagementOperationsThroughARMtestmhsm2一托管 Hsm 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 命名的托管 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 之前,提示你进行确认。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:Cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultProfile

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

参数属性

类型:IAzureContextContainer
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-HsmId

Hsm 资源 ID。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

UpdateSettingViaHsmId
Position:0
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-HsmName

HSM 的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

UpdateSettingViaFlattenValues
Position:0
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-HsmObject

Hsm 对象。

参数属性

类型:PSManagedHsm
默认值:None
支持通配符:False
不显示:False

参数集

UpdateSettingViaHsmObject
Position:0
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-InputObject

已删除保管库的位置。

参数属性

类型:PSKeyVaultSetting
默认值:None
支持通配符:False
不显示:False

参数集

UpdateSettingViaInputObject
Position:1
必需:True
来自管道的值:True
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Name

设置的名称。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

UpdateSettingViaFlattenValues
Position:1
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
UpdateSettingViaHsmObject
Position:1
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
UpdateSettingViaHsmId
Position:1
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-PassThru

默认情况下,Cmdlet 不返回对象。 如果指定了此开关,则返回 Secret 对象。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Value

设置的值。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

UpdateSettingViaFlattenValues
Position:2
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
UpdateSettingViaHsmObject
Position:2
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
UpdateSettingViaHsmId
Position:2
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-WhatIf

显示 cmdlet 运行时会发生什么情况。 命令脚本未运行。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False
别名:无线

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输入

PSKeyVaultSetting

PSManagedHsm

输出

PSKeyVaultSetting