Set-AIPFileLabel
Define ou remove um rótulo de Proteção de Informações do Azure para um arquivo e define ou remove a proteção de acordo com a configuração de rótulo ou permissões personalizadas.
Sintaxe
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>] Description
Para o cliente de rotulagem unificada da AIP, o cmdlet Set-AIPFileLabel define ou remove um rótulo de confidencialidade para um ou mais arquivos. Essa ação pode aplicar proteção automaticamente quando os rótulos são configurados para aplicar criptografia.
Além disso, você pode usar esse cmdlet para aplicar permissões personalizadas quando elas forem criadas como um objeto de política de proteção ad hoc com o cmdlet New-AIPCustomPermissions .
Quando o comando é executado com êxito, qualquer rótulo ou proteção existente pode ser substituído.
Você pode executar esse cmdlet de forma não interativa. Para obter mais informações, consulte o Guia de administração do cliente de rotulagem unificada.
Observação
Ao executar o cmdlet Set-AIPFileLabel em um loop, adicione estas duas linhas após o cmdlet: [GC]::Collect()
[GC]::WaitForPendingFinalizers()
Exemplos
Exemplo 1: aplicar o rótulo "Geral" a todos os arquivos que atualmente não têm um rótulo
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 SuccessEsse comando primeiro identifica todos os arquivos que não são rotulados usando o cmdlet Get-AIPFileStatus . Em seguida, esses arquivos são rotulados especificando o rótulo "Geral" por sua ID.
Exemplo 2: aplicar o rótulo "Geral" a arquivos .docx que não são rotulados
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 SuccessPrimeiro, esse comando identifica todos os arquivos .docx na pasta C:\Projects (e suas subpastas) usando Get-Child-Item e localiza nesses arquivos os que não são rotulados usando o cmdlet Get-AIPFileStatus . Os arquivos resultantes são rotulados especificando o rótulo "Geral" por sua ID.
Observação
Esse comando usa o alias Path de FullName, para que Get-Child-Item possa ser usado com Get-AIPFileStatus.
Exemplo 3: (somente cliente de rotulagem unificada) Aplique o rótulo "Geral" a todos os arquivos em uma pasta e a qualquer uma de suas subpastas
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 SuccessEsse comando define um rótulo chamado "Geral" em todos os arquivos na pasta Projetos e em qualquer uma de suas subpastas .
Se o rótulo Geral estiver configurado para aplicar criptografia, os arquivos que foram rotulados com êxito com esse comando também serão criptografados. Nesse caso, o proprietário de Rights Management (que tem a permissão Controle Total do Rights Management) desses arquivos será o usuário que executou o comando do PowerShell.
Neste exemplo, um arquivo não foi rotulado (ignorado) porque exigia justificativa. Esse pode ser o resultado pretendido para garantir que um arquivo com um rótulo ou proteção de classificação mais alta não seja substituído acidentalmente por um rótulo de classificação inferior ou tenha a proteção removida.
Para habilitar essa proteção, a política de rótulo de classificação Office 365 deve ser configurada para exigir justificativa para remover um rótulo ou reduzir a classificação. Quando você executa esse comando sem o parâmetro JustificationMessage e o rótulo dispara a justificativa, o arquivo é ignorado com o comentário "Nenhum rótulo a ser aplicado".
Exemplo 4: (somente cliente de rotulagem unificada) Aplique o rótulo "Geral" a um único arquivo, o que requer justificativa
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 SuccessEsse comando define o rótulo "Geral" para um arquivo que já está rotulado com um rótulo de classificação mais alto. A política de rótulo de classificação Office 365 é configurada para exigir justificativa para remover um rótulo ou reduzir a classificação. Como o comando inclui uma mensagem de justificativa, o novo rótulo é aplicado com êxito.
Exemplo 5: (somente cliente de rotulagem unificada) Remover um rótulo de um arquivo
PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -RemoveLabel -JustificationMessage 'The previous label no longer applies'
FileName Status Comment
-------- ------ ------------
C:\Projects\Analysis.docx SuccessEsse comando remove o rótulo existente do arquivo chamado C:\Projects\Analysis.docxe especifica uma mensagem de justificativa obrigatória.
Esse método de justificativa é necessário porque a configuração de política de rótulo de classificação de Office 365 relevante está habilitada para exigir justificativa para remover um rótulo ou reduzir a classificação.
Observação
Se o rótulo que você está removendo estava protegendo seu arquivo usando um modelo, esse comando removerá o rótulo e a proteção.
Se o rótulo que você está removendo estava protegendo seu arquivo usando permissões personalizadas, esse comando removerá apenas o rótulo.
Exemplo 6: (somente cliente de rotulagem unificada) Proteja um arquivo com permissões personalizadas
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 SuccessO primeiro comando cria um objeto de política de proteção ad hoc que concede aos usuários de diferentes organizações direitos de uso das permissões do Revisor e também aplica uma data de validade.
O segundo comando protege um único arquivo chamado Analysis.docx usando as permissões personalizadas no objeto de política de proteção ad hoc armazenado.
Exemplo 7: (somente cliente de rotulagem unificada) Aplique um rótulo e permissões personalizadas ao arquivo
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 SuccessO primeiro comando cria um objeto de política de proteção ad hoc que concede aos usuários de diferentes organizações direitos de uso das permissões do Revisor e também aplica uma data de validade.
O segundo comando aplica um rótulo a um único arquivo chamado Analysis.docx e também protege o arquivo usando as permissões personalizadas no objeto de política de proteção ad hoc armazenado. Se o rótulo estiver configurado para configurações de proteção, eles serão substituídos pelas permissões personalizadas.
Exemplo 8: (somente cliente de rotulagem unificada) Remover a proteção de um arquivo
PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -RemoveProtection
FileName Status Comment
-------- ------ ------------
C:\Projects\Analysis.docx SuccessEsse comando remove a proteção de um único arquivo chamado Analysis.docx.
Exemplo 9: (somente cliente de rotulagem unificada) Remova a proteção e um rótulo de um arquivo
PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -RemoveProtection -RemoveLabel -JustificationMessage 'The previous label no longer applies'
FileName Status Comment
-------- ------ ------------
C:\Projects\Analysis.docx SuccessEsse comando remove o rótulo e a proteção personalizada de um único arquivo chamado Analysis.docx. Como a política está configurada para exigir justificativa para remover um rótulo, o motivo da justificativa também é fornecido para que o comando possa ser concluído sem avisar o usuário pelo motivo.
Parâmetros
-CustomPermissions
Especifica o nome da variável que armazena uma política de proteção ad hoc, que foi criada usando o cmdlet New-AIPCustomPermissions . A política de proteção ad hoc é usada para proteger o arquivo ou arquivos com permissões personalizadas.
| Tipo: | AIPCustomPermissions |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-EnableTracking
Especifique esse parâmetro para registrar um documento protegido no portal de acompanhamento de documentos.
O usuário que executa esse cmdlet e administradores globais pode acompanhar o documento protegido e, se necessário, revogá-lo. Para obter mais informações sobre o site de acompanhamento de documentos, consulte Configurando e usando o acompanhamento de documentos para o Azure Proteção de Informações no guia de administração.
Se o rótulo não aplicar proteção, esse parâmetro será ignorado.
| Tipo: | SwitchParameter |
| Cargo: | named |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-JustificationMessage
O motivo de justificativa para reduzir o rótulo de classificação, remover um rótulo ou remover a proteção, se a política de Proteção de Informações do Azure requerer que os usuários forneçam essas informações. Se a configuração de um rótulo disparar a justificativa e esse motivo não for fornecido, o rótulo não será aplicado. Neste caso, o status retornado é "Ignorado" com o comentário "Justificativa necessária".
| Tipo: | String |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-LabelId
Especifica a identidade (ID) do rótulo a ser aplicado. Quando um rótulo tem sub-rótulos, sempre especifique a ID apenas de um sub-rótulo e não do rótulo pai.
Para localizar a ID do rótulo:
O valor da ID do rótulo não é exibido no Centro de Conformidade do Microsoft 365. No entanto, você pode usar o seguinte comando do PowerShell do Centro de Conformidade do & de Segurança Office 365 para encontrar esse valor:Get-Label | Format-Table -Property DisplayName, Name, Guid
Para arquivos que têm rótulos aplicados, você também pode executar o cmdlet Get-AIPFileStatus para identificar a ID do rótulo (MainLabelId ou SubLabelId).
| Tipo: | Guid |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-Path
Especifica um caminho local, um caminho de rede ou uma URL do SharePoint Server para os arquivos para os quais você deseja obter as informações de rótulo e proteção.
Não há suporte para curingas e locais de WebDav.
Para caminhos do SharePoint, há suporte para o seguinte:
- SharePoint Server 2019
- SharePoint Server 2016
- SharePoint Server 2013
Por exemplo:
- C:\Folder\
- C:\Folder\Filename
- \\Server\Folder
- http://sharepoint.contoso.com/Shared%20Documents/Folder
Os caminhos podem incluir espaços quando você coloca o valor do caminho entre aspas.
| Tipo: | String[] |
| Aliases: | FullName, FileName |
| Cargo: | 0 |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | True |
| Aceitar caracteres curinga: | False |
-PreserveFileDetails
Especifique esse parâmetro para deixar a data modificada (Windows e SharePoint) e os valores modificados por (SharePoint) inalterados para documentos que você rotular:
Para arquivos locais ou de rede, o valor modificado date permanece inalterado.
Para arquivos do SharePoint, a data modificada e a Modificação por valores permanecem inalteradas.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | False |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-RemoveLabel
Remove qualquer rótulo que tenha sido aplicado a um arquivo.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
-RemoveProtection
Relevante para: Somente cliente de rotulagem unificada
Remove a proteção de um arquivo. Se o arquivo for rotulado, o rótulo não será removido.
Você deve ter direitos de uso suficientes ou ser um superusuário para sua organização remover a proteção dos arquivos. Para obter mais informações, consulte Configurando superusuários para o Azure Rights Management e serviços de descoberta ou recuperação de dados.
Use o cmdlet Set-AIPFileLabel do PowerShell para habilitar a remoção da proteção de arquivos de contêiner (zip, .rar, .7z e .pst).
Observação
Essa funcionalidade de proteção de remoção está desabilitada por padrão e deve ser habilitada primeiro usando o cmdlet Set-LabelPolicy .
Para arquivos .pst, 5 GB é o tamanho máximo do arquivo com suporte com esse cmdlet.
| Tipo: | SwitchParameter |
| Cargo: | Named |
| Valor padrão: | None |
| Obrigatório: | True |
| Aceitar a entrada de pipeline: | False |
| Aceitar caracteres curinga: | False |
Entradas
System.String[]
Saídas
Microsoft.InformationProtection.Powershell.AIP.Results.SetAIPFileResult