New-ComplianceSearchAction
Este cmdlet está disponible en Exchange local y en el servicio basado en la nube. Puede que algunos parámetros y opciones de configuración sean exclusivos de un entorno u otro.
Use el cmdlet New-ComplianceSearchAction para crear acciones para las búsquedas de contenido en Exchange Server y en el portal de cumplimiento Microsoft Purview.
Para obtener más información acerca de los conjuntos de parámetros de la sección Sintaxis a continuación, vea Sintaxis del cmdlet de Exchange.
Syntax
New-ComplianceSearchAction
[-SearchName] <String[]>
[-Export]
[-ActionName <String>]
[-ArchiveFormat <ComplianceExportArchiveFormat>]
[-Confirm]
[-FileTypeExclusionsForUnindexedItems <String[]>]
[-EnableDedupe <Boolean>]
[-ExchangeArchiveFormat <ComplianceExportArchiveFormat>]
[-Force]
[-Format <ComplianceDataTransferFormat>]
[-IncludeCredential]
[-IncludeSharePointDocumentVersions <Boolean>]
[-JobOptions <Int32>]
[-NotifyEmail <String>]
[-NotifyEmailCC <String>]
[-ReferenceActionName <String>]
[-Region <String>]
[-Report]
[-RetentionReport]
[-RetryOnError]
[-Scenario <ComplianceSearchActionScenario>]
[-Scope <ComplianceExportScope>]
[-SearchNames <String[]>]
[-SharePointArchiveFormat <ComplianceExportArchiveFormat>]
[-ShareRootPath <String>]
[-Version <String>]
[-WhatIf]
[<CommonParameters>] New-ComplianceSearchAction
[-SearchName] <String[]>
[-Preview]
[-ActionName <String>]
[-Confirm]
[-Force]
[-Format <ComplianceDataTransferFormat>]
[-IncludeCredential]
[-JobOptions <Int32>]
[-ReferenceActionName <String>]
[-Region <String>]
[-RetryOnError]
[-Scenario <ComplianceSearchActionScenario>]
[-SearchNames <String[]>]
[-Version <String>]
[-WhatIf]
[<CommonParameters>] New-ComplianceSearchAction
[-SearchName] <String[]>
[-Purge]
[-PurgeType <ComplianceDestroyType>]
[-ActionName <String>]
[-Confirm]
[-Force]
[-Format <ComplianceDataTransferFormat>]
[-IncludeCredential]
[-JobOptions <Int32>]
[-Region <String>]
[-ReferenceActionName <String>]
[-RetryOnError]
[-Scenario <ComplianceSearchActionScenario>]
[-SearchNames <String[]>]
[-Version <String>]
[-WhatIf]
[<CommonParameters>] Description
Después de crear una búsqueda de contenido mediante el cmdlet New-ComplianceSearch y ejecutarla mediante el cmdlet Start-ComplianceSearch, asigne una acción de búsqueda a la búsqueda mediante el cmdlet New-ComplianceSearchAction.
En Exchange local, este cmdlet está disponible en el rol De búsqueda de buzones. De forma predeterminada, este rol solo se asigna al grupo de roles Administración de detección.
Deberá tener asignados permisos antes de poder ejecutar este cmdlet. Aunque en este tema se enumeran todos los parámetros correspondientes a este cmdlet, tal vez no tenga acceso a algunos parámetros si no están incluidos en los permisos que se le han asignado. Para obtener los permisos necesarios para ejecutar cualquier cmdlet o parámetro en su organización, consulte Find the permissions required to run any Exchange cmdlet.
En Microsoft 365, la cuenta que use para ejecutar este cmdlet debe tener asignada una licencia válida de Microsoft 365.
Para usar este cmdlet en PowerShell de cumplimiento de seguridad & , debe tener asignados permisos. Para obtener más información vea Permisos en el portal de cumplimiento de Microsoft Purview.
Ejemplos
Ejemplo 1
New-ComplianceSearchAction -SearchName "Project X" -PreviewEn este ejemplo se crea una acción de búsqueda de vista previa para la búsqueda de contenido denominada Project X.
Ejemplo 2
New-ComplianceSearchAction -SearchName "Project X" -ExportEn este ejemplo se crea una acción de búsqueda de exportación para la búsqueda de contenido denominada Project X.
Ejemplo 3
New-ComplianceSearchAction -SearchName "Remove Phishing Message" -Purge -PurgeType SoftDeleteEn este ejemplo se eliminan los resultados de búsqueda devueltos por una búsqueda de contenido denominada Quitar mensaje de suplantación de identidad. Tenga en cuenta que no se eliminan elementos sin indexar al usar el parámetro Purge.
Ejemplo 4
New-ComplianceSearchAction -SearchName "Case 321 All Sites" -Export -SharePointArchiveFormat SingleZip -ExchangeArchiveFormat PerUserPstEn este ejemplo se exportan los resultados devueltos por la búsqueda de contenido denominada "Caso 321 Todos los sitios". Los resultados de la búsqueda se comprimen y exportan a un único archivo ZIP. Si la búsqueda incluía ubicaciones de Exchange, los resultados de la búsqueda se exportan como un archivo PST por buzón.
Parámetros
-ActionName
Este parámetro solo está disponible en el servicio basado en la nube.
El parámetro ActionName especifica un nombre para la acción de búsqueda de contenido. Este parámetro solo se usa cuando se especifican varias búsquedas de contenido en el parámetro SearchName.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-ArchiveFormat
Este parámetro ya no se usa y quedará obsoleto.
Para especificar el formato de los resultados de búsqueda de Exchange, use el parámetro ExchangeArchiveFormat. Para especificar el formato de los resultados de búsqueda de SharePoint y OneDrive, use el parámetro SharePointArchiveFormat.
| Type: | ComplianceExportArchiveFormat |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Confirm
El modificador Confirm especifica si se debe mostrar u ocultar el mensaje de confirmación. Cómo afecta este modificador el cmdlet depende de si el cmdlet requiere confirmación antes de continuar.
- Los cmdlets destructivos (por ejemplo, cmdlets Remove-*) tienen una pausa integrada que obliga a confirmar el comando antes de continuar. Para estos cmdlets, puede omitir el mensaje de confirmación mediante esta sintaxis exacta:
-Confirm:$false. - La mayoría de los demás cmdlets (por ejemplo, los cmdlets New-* y Set-*) no tienen una pausa integrada. En estos cmdlets, si se especifica el modificador Confirm sin ningún valor, se introduce una pausa que obliga a confirmar el comando antes de continuar.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-EnableDedupe
Este parámetro está reservado para uso interno de Microsoft.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-ExchangeArchiveFormat
Este parámetro solo funciona en el servicio basado en la nube.
Este parámetro requiere el rol Exportar en PowerShell de cumplimiento de seguridad & . De forma predeterminada, este rol solo se asigna al grupo de roles del Administrador de exhibición de documentos electrónicos.
El parámetro ExchangeArchiveFormat especifica cómo exportar los resultados de búsqueda de Exchange. Los valores admitidos son:
- PerUserPst: un archivo PST para cada buzón.
- SinglePst: un archivo PST que contiene todos los mensajes exportados.
- SingleFolderPst: un archivo PST con una sola carpeta raíz para toda la exportación.
- IndividualMessage: exporte cada mensaje como un archivo de mensaje .msg. Este es el valor predeterminado.
- PerUserZip: un archivo ZIP para cada buzón. Cada archivo ZIP contiene los archivos de mensaje .msg exportados desde el buzón.
- SingleZip: un archivo ZIP para todos los buzones. El archivo ZIP contiene todos los archivos de mensajes .msg exportados de todos los buzones de correo. Esta configuración de salida solo está disponible en PowerShell.
Para especificar el formato de los resultados de búsqueda de SharePoint y OneDrive, use el parámetro SharePointArchiveFormat.
| Type: | ComplianceExportArchiveFormat |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Export
Este parámetro solo funciona en el servicio basado en la nube.
Este parámetro requiere el rol Exportar en PowerShell de cumplimiento de seguridad & . De forma predeterminada, este rol solo se asigna al grupo de roles del Administrador de exhibición de documentos electrónicos.
El modificador Exportar especifica que la acción de la búsqueda de contenido es exportar el conjunto completo de resultados que coinciden con los criterios de búsqueda. No es necesario especificar un valor con este modificador.
Para devolver solo la información de cada uno de los elementos que se haya detectado en un informe, use el modificador Report.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-FileTypeExclusionsForUnindexedItems
FileTypeExclusionsForUnindexedItems especifica los tipos de archivo que se van a excluir porque no se pueden indexar. Puede especificar distintos valores separados por comas.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Force
El modificador Force oculta los mensajes de advertencia o confirmación. No es necesario especificar un valor con este modificador.
Este modificador se puede usar para ejecutar tareas mediante programación en las que no es apropiado solicitar una entrada administrativa.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Format
En PowerShell de cumplimiento de seguridad & , este parámetro requiere el rol Exportar. De forma predeterminada, este rol solo se asigna al grupo de roles del Administrador de exhibición de documentos electrónicos.
El parámetro Format especifica el formato de los resultados de la búsqueda cuando se usa el modificador Export. Los valores admitidos son:
- FxStream: Exportar a archivos PST. Esta es la única opción que está disponible al exportar los resultados de búsqueda de la portal de cumplimiento Microsoft Purview.
- Mime: exporte a archivos de mensaje .eml. Este es el valor predeterminado al usar cmdlets para exportar los resultados de la búsqueda.
- Msg: exporte a los archivos de mensaje .msg.
| Type: | ComplianceDataTransferFormat |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-IncludeCredential
El modificador IncludeCredential especifica si se debe incluir la credencial en los resultados. No es necesario especificar un valor con este modificador.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-IncludeSharePointDocumentVersions
Este parámetro solo está disponible en el servicio basado en la nube.
El parámetro IncludeSharePointDocumentVersions especifica si se van a exportar versiones anteriores del documento cuando se usa el modificador Export. Los valores admitidos son:
- $true: exporte todas las versiones del documento.
- $false: exporte solo la versión publicada actual del tema. Este es el valor predeterminado.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-JobOptions
Este parámetro está reservado para uso interno de Microsoft.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-NotifyEmail
En PowerShell de cumplimiento de seguridad & , este parámetro requiere el rol Exportar. De forma predeterminada, esto solo se asigna al grupo de roles del Administrador de exhibición de documentos electrónicos.
El parámetro NotifyEmail especifica el destino de dirección de correo electrónico de los resultados de la búsqueda cuando se usa el modificador Export.
El destinatario que se especifique se encuentra en el campo To: del mensaje.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-NotifyEmailCC
En PowerShell de cumplimiento de seguridad & , este parámetro requiere el rol Exportar. De forma predeterminada, este rol solo se asigna al grupo de roles del Administrador de exhibición de documentos electrónicos.
El parámetro NotifyEmailCC especifica el destino de dirección de correo electrónico de los resultados de la búsqueda cuando se usa el modificador Export.
El destinatario que se especifique se encuentra en el campo Cc: del mensaje.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Preview
En PowerShell de cumplimiento de seguridad & , este parámetro requiere el rol De vista previa. De forma predeterminada, este rol solo se asigna al grupo de roles del Administrador de exhibición de documentos electrónicos.
El modificador Vista previa especifica que la acción de la búsqueda de contenido consiste en obtener una vista previa de los resultados que coinciden con los criterios de búsqueda. No es necesario especificar un valor con este modificador.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Purge
Nota: En PowerShell de cumplimiento de seguridad & , este modificador solo está disponible en el rol Buscar y purgar. De forma predeterminada, este rol solo se asigna a los grupos de roles Administración de la organización e Investigador de datos.
El modificador Purgar especifica que la acción de la búsqueda de contenido consiste en quitar elementos que coincidan con los criterios de búsqueda. No es necesario especificar un valor con este modificador.
- Se puede eliminar un máximo de 10 elementos por buzón a la vez. Como la función de buscar y quitar mensajes está diseñada para ser una herramienta de respuesta a incidentes, este límite ayuda a garantizar que los mensajes se quitan rápidamente de los buzones. Esta acción no está diseñada para limpiar buzones de usuarios.
- Puede quitar elementos de un máximo de 50 000 buzones mediante una búsqueda de contenido única. Para quitar elementos de más de 50 000 buzones, tendrá que crear búsquedas de contenido independientes. Para obtener más información, consulte Búsqueda y eliminación de mensajes de correo electrónico en la organización de Microsoft 365.
- Los elementos no indexados no se quitan de los buzones cuando se usa este modificador.
- El valor del parámetro PurgeType controla cómo se quitan los elementos.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-PurgeType
Nota: En PowerShell de cumplimiento de seguridad & , este parámetro solo está disponible en el rol Buscar y purgar. De forma predeterminada, este rol solo se asigna a los grupos de roles Administración de la organización e Investigador de datos.
El parámetro PurgeType especifica cómo quitar elementos cuando la acción es Purge. Los valores admitidos son:
- SoftDelete: los usuarios pueden recuperar los elementos purgados hasta que expire el período de retención de elementos eliminados.
- HardDelete (solo en la nube): los elementos purgados se marcan para la eliminación permanente del buzón y se quitarán permanentemente la próxima vez que el Asistente para carpetas administradas procese el buzón. Si la recuperación de elementos únicos está habilitada en el buzón de correo, los elementos purgados se quitarán permanentemente después de que expire el período de retención de elementos eliminados.
| Type: | ComplianceDestroyType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-ReferenceActionName
Este parámetro está reservado para uso interno de Microsoft.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Region
Este parámetro está reservado para uso interno de Microsoft.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Report
Este parámetro solo funciona en el servicio basado en la nube.
El modificador Informe especifica que la acción de la búsqueda de contenido es exportar un informe sobre los resultados (información sobre cada elemento en lugar del conjunto completo de resultados) que coincida con los criterios de búsqueda. No es necesario especificar un valor con este modificador.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-RetentionReport
El modificador RetentionReport especifica que la acción de la búsqueda de contenido es exportar un informe de retención. No es necesario especificar un valor con este modificador.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-RetryOnError
El modificador RetryOnError especifica si se vuelve a intentar la acción en los elementos en los que se produjo un error sin volver a ejecutar la acción completa de nuevo. No es necesario especificar un valor con este modificador.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Scenario
En PowerShell de cumplimiento de seguridad & , este parámetro requiere el rol De vista previa. De forma predeterminada, este rol solo se asigna al grupo de roles del Administrador de exhibición de documentos electrónicos.
El parámetro Scenario especifica el tipo de escenario cuando se usa el modificador Export. Los valores admitidos son:
- AnalyzeWithZoom: prepare los resultados de la búsqueda para su procesamiento en Microsoft Purview eDiscovery premium.
- General: exporta los resultados de la búsqueda al equipo local. Los correos electrónicos se exportan a archivos .pst. Los documentos de SharePoint y OneDrive para la Empresa se exportan en sus formatos nativos de Office.
- GenerateReportsOnly:
- Inventario:
- RetentionReports:
- TriagePreview:
| Type: | ComplianceSearchActionScenario |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-Scope
El parámetro Scope especifica los elementos que se incluirán cuando la acción sea Export. Los valores admitidos son:
- IndexedItemsOnly
- UnindexedItemsOnly
- BothIndexedAndUnindexedItems
| Type: | ComplianceExportScope |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-SearchName
El parámetro SearchName especifica el nombre de la búsqueda de contenido existente que se va a asociar a la acción de búsqueda de contenido. Puede especificar varias búsquedas de contenido separadas por comas.
Para encontrar la búsqueda de contenido, ejecute el comando Get-ComplianceSearch | Format-Table -Nombre automático,Estado.
| Type: | String[] |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-SearchNames
Este parámetro solo está disponible en el servicio basado en la nube.
El parámetro SearchNames especifica los nombres de las búsquedas de contenido existentes que se van a asociar a la acción de búsqueda de contenido. Los nombres de búsqueda de contenido se separan por comas.
Para encontrar nombres de búsqueda de contenido, ejecute el comando Get-ComplianceSearch | Format-Table -Nombre automático,Estado.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-SharePointArchiveFormat
Este parámetro solo funciona en el servicio basado en la nube.
Este parámetro requiere el rol Exportar. De forma predeterminada, este rol solo se asigna al grupo de roles del Administrador de exhibición de documentos electrónicos.
El parámetro SharePointArchiveFormat especifica cómo exportar los resultados de búsqueda de SharePoint y OneDrive. Los valores admitidos son:
- IndividualMessage: exporte los archivos sin comprimir. Este es el valor predeterminado.
- PerUserZip: un archivo ZIP para cada usuario. Cada archivo ZIP contiene los archivos exportados para el usuario.
- SingleZip: un archivo ZIP para todos los usuarios. El archivo ZIP contiene todos los archivos exportados de todos los usuarios. Esta configuración de salida solo está disponible en PowerShell.
Para especificar el formato de los resultados de búsqueda de Exchange, use el parámetro ExchangeArchiveFormat.
| Type: | ComplianceExportArchiveFormat |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-ShareRootPath
{{ Fill ShareRootPath Description }}
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019 |
-Version
Este parámetro está reservado para uso interno de Microsoft.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |
-WhatIf
El modificador WhatIf no funciona en PowerShell de cumplimiento de seguridad & .
El modificador WhatIf simula las acciones del comando. Puede usar este modificador para ver los cambios que se producirían, pero sin aplicar los cambios. No es necesario especificar un valor con este modificador.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Security & Compliance |