Set-AIPFileLabel

  • Referencia
Módulo:
AzureInformationProtection

Establece o quita una etiqueta de Azure Information Protection para un archivo y establece o quita la protección según la configuración de la etiqueta o los permisos personalizados.

Syntax

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 el cliente de etiquetado unificado de AIP, el cmdlet Set-AIPFileLabel establece o quita una etiqueta de confidencialidad para uno o varios archivos. Esta acción puede aplicar automáticamente la protección cuando las etiquetas están configuradas para aplicar el cifrado.

Además, puede usar este cmdlet para aplicar permisos personalizados cuando se crean como un objeto de directiva de protección ad hoc con el cmdlet New-AIPCustomPermissions .

Cuando el comando se ejecuta correctamente, se puede reemplazar cualquier etiqueta o protección existente.

Puede ejecutar este cmdlet de forma no interactiva. Para obtener más información, consulte la guía de administración del cliente de etiquetado unificado.

Nota

Al ejecutar el cmdlet Set-AIPFileLabel en un bucle, agregue estas dos líneas después del cmdlet: [GC]::Collect()
[GC]::WaitForPendingFinalizers()

Ejemplos

Ejemplo 1: Aplicar la etiqueta "General" a todos los archivos que no tienen actualmente una etiqueta

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

Este comando identifica primero todos los archivos que no están etiquetados mediante el cmdlet Get-AIPFileStatus . A continuación, estos archivos se etiquetan especificando la etiqueta "General" por su identificador.

Ejemplo 2: Aplicar la etiqueta "General" a .docx archivos que no están etiquetados

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

Este comando identifica primero todos los archivos .docx de la carpeta C:\Projects (y sus subcarpetas) mediante Get-Child-Item y, a continuación, busca en estos archivos los que no están etiquetados mediante el cmdlet Get-AIPFileStatus . A continuación, los archivos resultantes se etiquetan especificando la etiqueta "General" por su identificador.

Nota

Este comando usa el alias path de FullName para que Get-Child-Item se pueda usar con Get-AIPFileStatus.

Ejemplo 3: (solo cliente de etiquetado unificado) Aplique la etiqueta "General" a todos los archivos de una carpeta y a cualquiera de sus subcarpetas

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

Este comando establece una etiqueta denominada "General" en todos los archivos de la carpeta Projects y cualquiera de sus subcarpetas.

Si la etiqueta General está configurada para aplicar el cifrado, los archivos que se etiquetaron correctamente con este comando también se cifrarán. En este caso, el propietario de Rights Management (que tiene el permiso de control total de Rights Management) de estos archivos es el usuario que ejecutó el comando de PowerShell.

En este ejemplo, no se etiquetó un archivo (omitido) porque requería justificación. Este podría ser el resultado previsto para asegurarse de que un archivo con una etiqueta o protección de clasificación superior no se sobrescribe accidentalmente con una etiqueta de clasificación inferior o se ha quitado la protección.

Para habilitar esta protección, la directiva de etiqueta de clasificación Office 365 debe configurarse para requerir justificación para quitar una etiqueta o reducir la clasificación. Al ejecutar este comando sin el parámetro JustificationMessage y la etiqueta desencadena la justificación, el archivo se omite con el comentario "No label to apply".

Ejemplo 4: (solo cliente de etiquetado unificado) Aplique la etiqueta "General" a un único archivo, lo que requiere justificación

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

Este comando establece la etiqueta "General" para un archivo que ya está etiquetado con una etiqueta de clasificación superior. La directiva de etiqueta de clasificación de Office 365 está configurada para requerir justificación para quitar una etiqueta o reducir la clasificación. Dado que el comando incluye un mensaje de justificación, la nueva etiqueta se aplica correctamente.

Ejemplo 5: (solo cliente de etiquetado unificado) Quitar una etiqueta de un archivo

PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -RemoveLabel -JustificationMessage 'The previous label no longer applies'

FileName                   Status Comment
--------                   ------ ------------
C:\Projects\Analysis.docx  Success

Este comando quita la etiqueta existente del archivo denominado C:\Projects\Analysis.docxy especifica un mensaje de justificación obligatorio.

Este método de justificación es necesario porque la configuración de directiva de etiqueta de clasificación Office 365 pertinente está habilitada para requerir justificación para quitar una etiqueta o reducir la clasificación.

Nota

Si la etiqueta que va a quitar estaba protegiendo el archivo mediante una plantilla, este comando quita la etiqueta y la protección.

Si la etiqueta que va a quitar protegía el archivo con permisos personalizados, este comando solo quita la etiqueta.

Ejemplo 6: (solo cliente de etiquetado unificado) Proteger un archivo con permisos personalizados

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

El primer comando crea un objeto de directiva de protección ad hoc que concede a los usuarios de diferentes organizaciones derechos de uso de los permisos revisores y también aplica una fecha de expiración.

El segundo comando protege un único archivo denominado Analysis.docx mediante los permisos personalizados del objeto de directiva de protección ad hoc almacenado.

Ejemplo 7: (solo cliente de etiquetado unificado) Aplicar una etiqueta y permisos personalizados al archivo

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

El primer comando crea un objeto de directiva de protección ad hoc que concede a los usuarios de diferentes organizaciones derechos de uso de los permisos revisores y también aplica una fecha de expiración.

El segundo comando aplica una etiqueta a un único archivo denominado Analysis.docx y también protege el archivo mediante los permisos personalizados del objeto de directiva de protección ad hoc almacenado. Si la etiqueta está configurada para la configuración de protección, se reemplazan por los permisos personalizados.

Ejemplo 8: (solo cliente de etiquetado unificado) Eliminación de la protección de un archivo

PS C:\> Set-AIPFileLabel C:\Projects\Analysis.docx -RemoveProtection

FileName                   Status Comment
--------                   ------ ------------
C:\Projects\Analysis.docx  Success

Este comando quita la protección de un único archivo denominado Analysis.docx.

Ejemplo 9: (solo cliente de etiquetado unificado) Eliminación de la protección y una etiqueta de un archivo

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

Este comando quita la etiqueta y la protección personalizada de un único archivo denominado Analysis.docx. Dado que la directiva está configurada para requerir justificación para quitar una etiqueta, también se proporciona el motivo de justificación para que el comando pueda completarse sin preguntar al usuario por el motivo.

Parámetros

-CustomPermissions

Especifica el nombre de variable que almacena una directiva de protección ad hoc, que se creó mediante el cmdlet New-AIPCustomPermissions . La directiva de protección ad hoc se usa para proteger el archivo o los archivos con permisos personalizados.

Type:AIPCustomPermissions
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-EnableTracking

Especifique este parámetro para registrar un documento protegido en el portal de seguimiento de documentos.

El usuario que ejecuta este cmdlet y los administradores globales pueden realizar un seguimiento del documento protegido y, si es necesario, revocarlo. Para más información sobre el sitio de seguimiento de documentos, consulte Configuración y uso del seguimiento de documentos para Azure Information Protection desde la guía de administración.

Si la etiqueta no aplica protección, se omite este parámetro.

Type:SwitchParameter
Position:named
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-JustificationMessage

Motivo de justificación de la reducción de la etiqueta de clasificación, o la eliminación de una etiqueta o de la protección, si la directiva de Azure Information Protection requiere que los usuarios proporcionen esta información. Si al establecer una etiqueta se desencadena la justificación y no se proporciona este motivo, no se aplica la etiqueta. En este caso, el estado que se devuelve es "Omitido" con el comentario "Justificación necesaria".

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-LabelId

Especifica la identidad (ID) de la etiqueta que se va a aplicar. Si una etiqueta tiene subetiquetas, especifique únicamente el identificador de una subetiqueta, no el de la etiqueta principal.

Para buscar el identificador de etiqueta:

El valor del identificador de etiqueta no se muestra en el Centro de cumplimiento de Microsoft 365. Sin embargo, puede usar el siguiente comando de PowerShell Office 365 Security & Compliance Center para encontrar este valor:Get-Label | Format-Table -Property DisplayName, Name, Guid

Para los archivos que tienen etiquetas aplicadas, también puede ejecutar el cmdlet Get-AIPFileStatus para identificar el identificador de etiqueta (MainLabelId o SubLabelId).

Type:Guid
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Path

Especifica una ruta de acceso local, una ruta de acceso de red o una dirección URL de SharePoint Server a los archivos para los que desea obtener la información de etiqueta y protección.

No se admiten los caracteres comodín ni las ubicaciones de WebDAV.

En el caso de las rutas de acceso de SharePoint, se admite lo siguiente:

  • SharePoint Server 2019
  • SharePoint Server 2016
  • SharePoint Server 2013

Por ejemplo:

Las rutas de acceso pueden incluir espacios al incluir el valor de ruta de acceso entre comillas.

Type:String[]
Aliases:FullName, FileName
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-PreserveFileDetails

Especifique este parámetro para dejar la fecha de modificación (Windows y SharePoint) y los valores modificados por (SharePoint) sin modificar para los documentos que etiquete:

  • En el caso de los archivos locales o de red, el valor fecha de modificación permanece sin cambios.

  • En el caso de los archivos de SharePoint, los valores Fecha de modificación y Modificado por permanecen sin cambios.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoveLabel

Quita cualquier etiqueta que se haya aplicado a un archivo.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-RemoveProtection

Relevante para: Solo cliente de etiquetado unificado

Quita la protección de un archivo. Si el archivo está etiquetado, la etiqueta no se quita.

Debe tener suficientes derechos de uso o ser superusuario para que su organización quite la protección de los archivos. Para obtener más información, consulte Configuración de superusuarios para Azure Rights Management y servicios de detección o recuperación de datos.

Use el cmdlet set-AIPFileLabel de PowerShell para habilitar la eliminación de la protección de archivos de contenedor (zip, .rar, .7z y .pst).

Nota

  • Esta funcionalidad de eliminación de protección está deshabilitada de forma predeterminada y primero debe habilitarse mediante el cmdlet Set-LabelPolicy .

  • Para los archivos .pst, 5 GB es el tamaño máximo de archivo admitido con este cmdlet.

Type:SwitchParameter
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

Entradas

System.String[]

Salidas

Microsoft.InformationProtection.Powershell.AIP.Results.SetAIPFileResult