你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Set-AipServiceTemplateProperty
更新 Azure 信息保护的保护模板的属性或属性。
语法
Set-AipServiceTemplateProperty
-TemplateId <Guid>
[-Names <Hashtable>]
[-Descriptions <Hashtable>]
[-RightsDefinitions <System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition]>]
[-ContentExpirationOption <ContentExpirationType>]
[-ContentExpirationDate <DateTime>]
[-ContentValidityDuration <Int32>]
[-LicenseValidityDuration <Int32>]
[-Status <TemplateStatus>]
[-ScopedIdentities <System.Collections.Generic.List`1[System.String]>]
[-EnableInLegacyApps <Boolean>]
[<CommonParameters>]
说明
Set-AipServiceTemplateProperty cmdlet 更新 Azure 信息保护模板的属性或属性。 可以在 Azure 门户中更新其中大多数属性。
使用此 cmdlet 时,模板由其 GUID 标识,该模板必须引用现有的保护模板。 不能使用此 cmdlet 更新默认模板。
可以使用 Get-AipServiceTemplate cmdlet 来获取模板 ID。
重要
更新保护模板的属性时,这些属性的现有设置将被覆盖(未补充),而不会发出警告,因此请务必指定更新的属性所需的所有设置。
最佳做法是,使用 Export-AipServiceTemplate cmdlet 在运行此 cmdlet 之前备份现有模板。 然后,如果需要还原到原始配置,可以使用 Import-AipServiceTemplate cmdlet 还原模板。
有关保护模板的详细信息,包括如何在 Azure 门户中配置模板,请参阅 配置和管理 Azure 信息保护的模板。
使用 Azure 信息保护统一标记客户端?
Azure 信息保护统一标记客户端间接使用保护模板。 如果你有统一标记客户端,建议使用基于标签的 cmdlet,而不是直接修改保护模板。
有关详细信息,请参阅 Microsoft 365 文档中 创建和发布敏感度标签。
示例
示例 1:更新模板的状态
PS C:\>Set-AipServiceTemplateProperty -TemplateID 28168524-29c3-44f1-9e11-ea6c60bb6428 -Status Published
此命令将模板状态设置为 已发布。
示例 2:指定保护模板的用户和权限
PS C:\> $r1 = New-AipServiceRightsDefinition -EmailAddress marketing@contoso.com -Rights "VIEW","EXPORT"
PS C:\> $r2 = New-AipServiceRightsDefinition -EmailAddress engineering@contoso.com -Rights "VIEW"
PS C:\>Set-AipServiceTemplateProperty -TemplateID 28168524-29c3-44f1-9e11-ea6c60bb6522 -RightsDefinitions ($r1, $r2)
此示例 新启动 - 新用户和权限 更新现有保护模板。 虽然现有模板授予了营销部门(不应更改)的“查看和导出”权限,但工程部门现在还必须具有“查看”权限。
由于指定 RightsDefinitions 参数会覆盖现有设置,因此第一个权限定义对象保留营销的现有设置,另一个权限定义对象将创建新的工程部门权限。
示例 3:向保护模板添加新用户和权限
PS C:\> $templateid = "7b1db17a-cb1a-41cf-bad7-b452f9d384c1"
PS C:\> [array]$r = New-AipServiceRightsDefinition -EmailAddress pattiful@contoso.com -Rights "DOCEDIT", "EXTRACT"
PS C:\> $r += New-AipServiceRightsDefinition -EmailAddress evannar@vanarsdelltd.com -Rights "VIEW"
PS C:\> $CurrentRightsDefinitions = [array]((get-AipServiceTemplate -TemplateId $templateid).RightsDefinitions)
PS C:\> $ResultingRightsDefinitions = $CurrentRightsDefinitions + $r
PS C:\> Set-AipServiceTemplateProperty -TemplateId $templateid -RightsDefinition $ResultingRightsDefinitions
此命令集将两个新用户及其不同的权限添加到现有模板,而无需覆盖模板中已定义的现有用户和权限。
新用户及其权限 pattiful.contoso.com(组织内的用户)授予 DOCEDIT 和 EXTRACT 权限;并 evannar@vanarsdelltd.com(另一个组织的用户)被授予 VIEW 权限。 这些用户及其权限使用数组添加到权限定义对象,然后添加到模板的现有权限定义中。
参数
-ContentExpirationDate
指定受模板保护的内容过期的日期。
仅当 ContentExpirationOption 设置为 OnDate时,才使用此参数。
类型: | DateTime |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ContentExpirationOption
指定使用模板保护的内容的内容的过期类型。
此参数的可接受值为:
- 从不。 指示内容无限期可用。
- onDate。 指示内容在特定固定日期过期。
- 日后。指示内容在受保护后的指示天数内可用。
类型: | ContentExpirationType |
接受的值: | Never, OnDate, AfterDays |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ContentValidityDuration
指定保护的第一天之后,受模板保护的内容过期的天数。
仅当 ContentExpirationOption 参数设置为 AfterDays时,才使用此参数。
类型: | Int32 |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Descriptions
指定模板的说明列表。
使用 Windows PowerShell 中的哈希表语法为多个区域设置 ID 创建名称和说明。 必须至少有一个名称/说明对。 名称和说明的区域设置 ID 必须相互匹配。
$descriptions = @{}
$descriptions[1033] = “此内容是机密的,不应在外部共享”
$descriptions[1034] = “Este contenido es confidencial y no debe ser compartido fuera de la organizacion”
类型: | Hashtable |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-EnableInLegacyApps
确定不支持部门模板的客户端应用程序中部门模板的行为。 对于此方案,决定所有用户是否可以从可用模板列表中查看部门模板,或者没有用户可以在列表中看到部门模板。
可以通过使用 ScopedIdentities 参数或在 Azure 信息保护的范围策略中创建保护设置来创建部门模板。 部门模板也可能是使用 Azure 经典门户(现已停用)创建的。
如果设置为 True 并且模板是部门模板,则所有用户都会看到该模板,因此无论用户是否是模板范围的成员,都可以选择它。
如果设置为 False,则不会看到任何用户,因此无法选择模板,即使用户是模板的目标范围的成员也是如此。
此设置对不是部门模板的模板没有影响,也不会影响本机支持部门模板的客户端应用程序。 此设置对使用 Exchange Online 而不是本地 Exchange 的 Outlook 网页版没有任何影响,并且对于此方案,部门模板永远不会向用户显示。
请注意,此设置不会影响用户是否可以访问受部门模板保护的内容;它只影响用户查看并因此选择模板本身的能力。
如果应用程序默认不支持部门模板,则可以使用 自定义 RMS 模板下载脚本 或其他工具将这些模板部署到本地 RMS 客户端文件夹。 然后,这些应用程序将正确显示部门模板。
从下载所有模板的客户端计算机中,可以复制模板文件,然后将模板文件粘贴到其他计算机。
类型: | Boolean |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-LicenseValidityDuration
指定使用此模板保护的内容的使用许可证的有效期。 该值指定为在获取使用许可证 (0-9999)后,内容脱机可用的天数。 在此期间,用户可以重新打开以前访问的内容,而无需 Internet 网络连接。
通过帮助确保已撤销或策略更改的内容在更改过长的时间后,无法访问此值来减少对文档所有者的更多控制。
增加此值使用户无需 Internet 网络连接即可访问内容更加自由。
若要指定无限制的访问,请使用 -1。
若要指定每次访问受保护内容时都必须获取使用许可证,并且该内容仅可用于 Internet 连接,请指定 0。
每个组织都有最大使用许可证有效期,默认情况下 30 天,可以使用 Set-AipServiceMaxUseLicenseValidityTime进行配置。 为 LicenseValidityDuration 参数指定的值必须低于该值。
当使用许可证有效期存在不同的值(例如,租户的一个值和模板的值)时,Azure 信息保护使用限制性最大的值。
类型: | Int32 |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Names
指定模板的名称列表。
不要在名称中包含以下任何字符,因为并非所有使用 Azure 信息保护的服务和应用程序都支持这些字符:< > % & / ? ; + \ : #
使用 Windows PowerShell 中的哈希表语法为多个区域设置 ID 创建名称和说明。 必须至少有一个名称/说明对。 名称和说明的区域设置 ID 必须相互匹配。
$names = @{}
$names[1033] = “机密内容”
$names[1034] = “Contenido confidencial”
类型: | Hashtable |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-RightsDefinitions
指定使用 New-AipServiceRightsDefinition cmdlet 指定的权限定义对象列表。
这些权限定义对象表示向通过应用模板保护的内容授予单个用户或组的权限。
类型: | System.Collections.Generic.List`1[Microsoft.RightsManagementServices.Online.Admin.TemplateRightsDefinition] |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-ScopedIdentities
按电子邮件地址(帐户或组)列出用户可以查看并因此从应用程序中选择部门模板。
要使指定的用户看到模板,应用程序必须支持部门模板,或者必须将 EnableInLegacyApps 参数设置为 True。
类型: | System.Collections.Generic.List`1[System.String] |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-Status
指定模板的状态。 有效值为:已发布 或 存档。
- 存档模板可用于使用以前受保护的内容,但对用户不可见。
- 已发布的模板将分发给用户,并可用于保护内容。
类型: | TemplateStatus |
接受的值: | Archived, Published |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-TemplateId
指定保护模板的 GUID。
类型: | Guid |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |