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

Set-AipServiceKeyProperties

更新 Azure 信息保护的租户密钥对象的属性。

语法

Default (默认值)

Set-AipServiceKeyProperties
    [-Force]
    -KeyIdentifier <String>
    -Active <Boolean>
    [-WhatIf]
    [-Confirm]
    [-RefreshSlcName]
    [<CommonParameters>]

说明

Set-AipServiceKeyProperties cmdlet 将租户的指定密钥对象的存档状态更改为“活动”。 由于一次只能有一个活动租户密钥,因此以前处于活动状态的租户密钥会自动设置为存档。

Azure 信息保护的新用户立即使用标识的租户密钥来保护内容。 服务的现有用户逐渐从以前处于活动状态的租户密钥过渡到新活动租户密钥,这种错开的转换可能需要几周时间才能完成。 可以通过重新初始化用户环境(也称为引导)来强制更新客户端。 使用以前处于活动状态的租户密钥保护的文档和文件仍可供已授权用户使用现已存档的租户密钥访问。

将租户密钥对象状态设置为“活动”也会使用新活动租户密钥辞去所有保护模板。 由于此操作可能非常耗时,尤其是在有许多保护模板时,不建议经常运行此操作。

若要运行此 cmdlet,必须为要设置为 Active 的租户密钥对象指定 KeyIdentifier。 若要获取此值,请使用 Get-AipServiceKeys cmdlet。

除非你正在从 AD RMS 进行迁移,否则不要激活 1024 位 RSA 密钥,这被视为保护级别不足。 Microsoft不支持使用低密钥长度(如 1024 位 RSA 密钥)以及提供不充分保护级别的协议的相关使用,例如 SHA-1。 建议移动到更高的密钥长度。

注释

不能使用此 cmdlet 更改要存档的活动状态。 若要将租户密钥对象设置为“已存档”状态,必须将另一个租户密钥对象设置为“活动”。

有关租户密钥的详细信息,请参阅 规划和实现 Azure 信息保护租户密钥

示例

示例 1:将租户密钥对象的状态更改为活动状态

PS C:\> Set-AipServiceKeyProperties -Force -KeyIdentifier "c0f102b3-02cc-4816-b732-fcee73edd0e6" -Active $True

此命令将租户密钥对象的状态从 存档 更改为 活动。KeyIdentifier 参数标识要更改的租户密钥对象,可以通过运行 Get-AipServiceKeys找到此值。 以前状态为“Active”的租户密钥对象将自动设置为 存档

由于该命令指定 Force 参数,因此该命令不会提示你进行确认。

示例 2:刷新 SLC 以反映租户友好名称

PS C:\> Set-AipServiceKeyProperties -KeyIdentifier "c0f102b3-02cc-4816-b732-fcee73edd0e6" -RefreshSlcName

此命令从 Azure Active Directory 检索当前租户友好名称,并更新 SLC,使用户密钥反映相同的名称。

参数

-Active

设置租户密钥对象的状态。

此参数只能与 $True的值一起使用,该值将状态设置为 Active。 如果要将租户密钥对象的状态更改为 存档,则必须将另一个租户密钥对象设置为 Active

参数属性

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

参数集

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

-Confirm

在运行 cmdlet 之前,提示你进行确认。

参数属性

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

参数集

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

-Force

强制命令运行而不要求用户确认。

参数属性

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

参数集

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

-KeyIdentifier

指定租户密钥对象的密钥标识符。 可以通过 Get-AipServiceKeys来获取此值。

参数属性

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

参数集

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

-RefreshSlcName

刷新用户密钥(SLC),以反映租户友好名称。

参数属性

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

参数集

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

-WhatIf

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

参数属性

类型:SwitchParameter
默认值:False
支持通配符: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