你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
Set-AIPFileLabel
设置或删除文件的 Azure 信息保护标签,并根据标签配置或自定义权限设置或删除保护。
语法
Set-AIPFileLabel
-LabelId <Guid>
[-JustificationMessage <String>]
[-Owner <String>]
[-PreserveFileDetails]
[-EnableTracking]
[-Path] <String[]>
[<CommonParameters>]
Set-AIPFileLabel
-LabelId <Guid>
[-JustificationMessage <String>]
-CustomPermissions <AIPCustomPermissions>
[-Owner <String>]
[-PreserveFileDetails]
[-Path] <String[]>
[<CommonParameters>]
Set-AIPFileLabel
[-JustificationMessage <String>]
[-RemoveLabel]
[-PreserveFileDetails]
[-Path] <String[]>
[<CommonParameters>]
Set-AIPFileLabel
[-JustificationMessage <String>]
[-RemoveLabel]
[-RemoveProtection]
[-PreserveFileDetails]
[-Path] <String[]>
[<CommonParameters>]
Set-AIPFileLabel
[-JustificationMessage <String>]
[-RemoveProtection]
[-PreserveFileDetails]
[-Path] <String[]>
[<CommonParameters>]
Set-AIPFileLabel
-CustomPermissions <AIPCustomPermissions>
[-Owner <String>]
[-PreserveFileDetails]
[-Path] <String[]>
[<CommonParameters>]
说明
对于 AIP 统一标记客户端, Set-AIPFileLabel cmdlet 设置或删除一个或多个文件的敏感度标签。 当标签配置为应用加密时,此操作可以自动应用保护。
此外,可以使用 New-AIPCustomPermissions cmdlet 将自定义权限创建为即席保护策略对象时,使用此 cmdlet 来应用自定义权限。
命令成功运行时,可以替换任何现有的标签或保护。
可以以非交互方式运行此 cmdlet。 有关详细信息,请参阅统一标记客户端管理员指南。
注意
在循环中运行 Set-AIPFileLabel cmdlet 时,在 cmdlet 后面添加以下两行: [GC]::Collect ()
[GC]::WaitForPendingFinalizers ()
示例
示例 1:将“常规”标签应用于当前没有标签的所有文件
PS C:\> Get-AIPFileStatus -Path \\Finance\Projects\ | where {$_.IsLabeled -eq $False} | Set-AIPFileLabel -LabelId d9f23ae3-4321-4321-4321-f515f824c57b
FileName Status Comment
-------- ------ ------------
\\Finance\Projects\Image.jpg Success
\\Finance\Projects\Pricelist.pdf Success
\\Finance\Projects\Announcement.docx Success
\\Finance\Projects\Analysis.xlsx Success
此命令首先使用 Get-AIPFileStatus cmdlet 标识未标记的所有文件。 然后,通过按 ID 指定“常规”标签来标记这些文件。
示例 2:将“常规”标签应用于未标记 .docx 文件
PS C:\> Get-ChildItem C:\Projects\*.docx -File -Recurse | Get-AIPFileStatus | where {$_.IsLabeled -eq $False} | Set-AIPFileLabel -LabelId d9f23ae3-1234-1234-1234-f515f824c57b
FileName Status Comment
-------- ------ ------------
C:\Projects\Analysis.docx Success
C:\Projects\Projects.docx Success
此命令首先使用 Get-Child-Item 标识 C:\Projects 文件夹 (及其子文件夹中的所有).docx文件,然后使用 Get-AIPFileStatus cmdlet 从这些文件查找未标记的文件。 然后,通过按 ID 指定“常规”标签来标记生成的文件。
注意
此命令使用 FullName 的 Path 别名,以便 Get-Child-Item 可用于 Get-AIPFileStatus。
示例 3: (统一标记客户端仅) 将“常规”标签应用于文件夹及其任何子文件夹中的所有文件
PS C:\> Set-AIPFileLabel -Path C:\Projects\ -LabelId d9f23ae3-1324-1234-1234-f515f824c57b
FileName Status Comment
-------- ------ ------------
C:\Projects\Project1.docx Success
C:\Projects\Datasheet.pdf Success
C:\Projects\Image.jpg Success
C:\Projects\Analysis.xlsx Skipped No label to apply
C:\Projects\Dashboard.xlsx Success
此命令在 Projects 文件夹及其任何子文件夹中的所有文件上设置名为“常规”的标签。
如果将“常规”标签配置为应用加密,则使用此命令成功标记的文件也将加密。 在这种情况下,这些文件的 Rights Management 所有者(拥有 Rights Management 完全控制权限)是运行 PowerShell 命令的用户。
在此示例中,一个文件未标记为 (跳过) ,因为它需要理由。 这可能是为了确保具有较高分类标签或保护的文件不会意外被较低分类标签覆盖或已删除保护的预期结果。
若要启用此安全措施,必须将Office 365分类标签策略配置为要求为删除标签或降低分类提供理由。 然后,在没有 JustificationMessage 参数且标签触发理由的情况下运行此命令时,会跳过文件并添加注释“没有要应用的标签”。
示例 4: (统一标记客户端仅) 将“常规”标签应用于单个文件,这需要理由
PS C:\> Set-AIPFileLabel -Path \\Finance\Projects\Analysis.xlsx -LabelId d9f23ae3-1324-1234-1234-f515f824c57b -JustificationMessage 'The previous label no longer applies'
FileName Status Comment
-------- ------ ------------
\\finance\projects\analysis.xlsx Success
此命令为已使用更高分类标签标记的文件设置“常规”标签。 Office 365分类标签策略配置为要求有理由删除标签或降低分类。 由于 命令包含理由消息,因此已成功应用新标签。
示例 5:仅 (统一标记客户端) 从文件中删除标签
PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -RemoveLabel -JustificationMessage 'The previous label no longer applies'
FileName Status Comment
-------- ------ ------------
C:\Projects\Analysis.docx Success
此命令从名为 C:\Projects\Analysis.docx的文件中删除现有标签,并指定强制理由消息。
此理由方法是必需的,因为启用相关的Office 365分类标签策略设置需要删除标签或降低分类的理由。
注意
如果要删除的标签是使用模板保护文件,此命令将同时删除标签和保护。
如果要删除的标签使用自定义权限保护文件,则此命令仅删除标签。
示例 6:仅 (统一标记客户端) 使用自定义权限保护文件
PS C:\> $permissions = New-AIPCustomPermissions -Users user1@contoso.com, user2@vanarsdel.com -Permissions Reviewer -ExpirationDate (Get-Date -Month 1 -Day 1 -Year 2020)
PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -CustomPermissions $permissions
FileName Status Comment
-------- ------ ------------
C:\Projects\Analysis.docx Success
第一个命令创建一个临时保护策略对象,该对象通过审阅者权限向不同组织的用户授予使用权限,并应用到期日期。
第二个命令使用存储的临时保护策略对象中的自定义权限来保护名为 Analysis.docx 的单个文件。
示例 7: (统一标记客户端仅) 对文件应用标签和自定义权限
PS C:\> $permissions = New-AIPCustomPermissions -Users a@a.com, b@b.com -Permissions Reviewer
PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -LabelId d9f23ae3-1324-1234-1234-f515f824c57b -CustomPermissions $permissions
FileName Status Comment
-------- ------ ------------
C:\Projects\Analysis.docx Success
第一个命令创建一个临时保护策略对象,该对象通过审阅者权限向不同组织的用户授予使用权限,并应用到期日期。
第二个命令将标签应用于名为 Analysis.docx 的单个文件,并使用存储的临时保护策略对象中的自定义权限来保护该文件。 如果为保护设置配置了标签,则它们将替换为自定义权限。
示例 8:仅 (统一标记客户端) 从文件中删除保护
PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -RemoveProtection
FileName Status Comment
-------- ------ ------------
C:\Projects\Analysis.docx Success
此命令从名为 Analysis.docx的单个文件中删除保护。
示例 9:仅 (统一标记客户端) 从文件中删除保护和标签
PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -RemoveProtection -RemoveLabel -JustificationMessage 'The previous label no longer applies'
FileName Status Comment
-------- ------ ------------
C:\Projects\Analysis.docx Success
此命令从名为 Analysis.docx的单个文件中删除标签和自定义保护。 由于策略配置为需要理由来删除标签,因此还提供了理由原因,以便命令可以完成,而无需提示用户说明原因。
参数
-CustomPermissions
指定存储即席保护策略的变量名称,该策略是使用 New-AIPCustomPermissions cmdlet 创建的。 临时保护策略用于使用自定义权限保护一个或多个文件。
类型: | AIPCustomPermissions |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-EnableTracking
指定此参数将受保护的文档注册到文档跟踪门户。
然后,运行此 cmdlet 的用户和全局管理员可以跟踪受保护的文档,并在必要时撤消该文档。 有关文档跟踪站点的详细信息,请参阅管理员指南中的为 Azure 信息保护配置和使用文档跟踪。
如果标签未应用保护,则忽略此参数。
类型: | SwitchParameter |
Position: | named |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-JustificationMessage
降低分类标签、删除标签或删除保护的理由(如果 Azure 信息保护策略要求用户提供此信息)。 如果设置标签触发了理由,并且未提供此原因,则不应用该标签。 在这种情况下,返回的状态为“已跳过”,同时会返回备注“需要理由”。
类型: | String |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-LabelId
指定要应用的标签的标识 (ID) 。 当标签包含子标签时,请始终指定子标签(而非父标签)的 ID。
若要查找标签 ID,请执行以下操作:
标签 ID 值不会显示在 Microsoft 365 合规中心。 但是,可以使用以下 Office 365 Security & Compliance Center PowerShell 命令查找此值:Get-Label | Format-Table -Property DisplayName, Name, Guid
对于应用了标签的文件,还可以运行 Get-AIPFileStatus cmdlet 来标识 MainLabelId 或 SubLabelId) (标签 ID。
类型: | Guid |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-Path
指定要获取其标签和保护信息的文件的本地路径、网络路径或 SharePoint Server URL。
不支持通配符,也不支持 WebDav 位置。
对于 SharePoint 路径,支持以下各项:
- SharePoint Server 2019
- SharePoint Server 2016
- SharePoint Server 2013
例如:
- C:\Folder\
- C:\Folder\Filename
- \\Server\Folder
- http://sharepoint.contoso.com/Shared%20Documents/Folder
使用引号将路径值括起来时,路径可以包含空格。
类型: | String[] |
别名: | FullName, FileName |
Position: | 0 |
默认值: | None |
必需: | True |
接受管道输入: | True |
接受通配符: | False |
-PreserveFileDetails
指定此参数可将修改日期保留 (Windows 和 SharePoint) ,并由 (SharePoint 修改的日期) 标记文档的值保持不变:
对于本地或网络文件, “修改日期” 值保持不变。
对于 SharePoint 文件, “修改日期” 和“ 修改者” 值保持不变。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | False |
接受管道输入: | False |
接受通配符: | False |
-RemoveLabel
删除已应用于文件的任何标签。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
-RemoveProtection
相关内容: 仅限统一标记客户端
从文件中删除保护。 如果文件已标记,则不会删除标签。
你必须拥有足够的使用权限或成为你的组织的超级用户,才能从文件中删除保护。 有关详细信息,请参阅 为 Azure Rights Management 和发现服务或数据恢复配置超级用户。
使用 Set-AIPFileLabel PowerShell cmdlet 可从 容器文件中删除保护, (zip、 .rar、 .7z 和 .pst) 。
注意
默认情况下,此删除保护功能处于禁用状态,必须先使用 Set-LabelPolicy cmdlet 启用。
对于 .pst 文件,5 GB 是此 cmdlet 支持的最大文件大小。
类型: | SwitchParameter |
Position: | Named |
默认值: | None |
必需: | True |
接受管道输入: | False |
接受通配符: | False |
输入
System.String[]
输出
Microsoft.InformationProtection.Powershell.AIP.Results.SetAIPFileResult