Partager via


New-ComplianceSearchAction

Cette cmdlet est disponible dans Exchange sur site et dans le service cloud. Certains paramètres peuvent être propres à un environnement ou à un autre.

Utilisez l’applet de commande New-ComplianceSearchAction pour créer des actions pour les recherches de contenu dans Exchange Server et dans le portail de conformité Microsoft Purview.

Pour plus d’informations sur les jeux de paramètres dans la section Syntaxe ci-après, voir Syntaxe da la cmdlet 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

Après avoir créé une recherche de contenu à l’aide de l’applet de commande New-ComplianceSearch et l’avoir exécutée à l’aide de l’applet de commande Start-ComplianceSearch, vous affectez une action de recherche à la recherche à l’aide de l’applet de commande New-ComplianceSearchAction.

Dans Exchange local, cette applet de commande est disponible dans le rôle Recherche de boîtes aux lettres. Par défaut, ce rôle est attribué uniquement au groupe de rôles Gestion de la découverte.

Des autorisations doivent vous être attribuées avant de pouvoir exécuter cette cmdlet. Bien que cette rubrique répertorie tous les paramètres de cette cmdlet, il est possible que vous n’ayez pas accès à certains paramètres s’ils ne sont pas inclus dans les autorisations qui vous ont été attribuées. Pour rechercher les autorisations requises pour exécuter une cmdlet ou un paramètre dans votre organisation, voir Find the permissions required to run any Exchange cmdlet.

Dans Microsoft 365, une licence Microsoft 365 valide doit être attribuée au compte que vous utilisez pour exécuter cette applet de commande.

Pour utiliser cette applet de commande dans PowerShell de conformité de la sécurité & , des autorisations doivent vous être attribuées. Pour plus d’informations, consultez la rubrique Autorisations dans le portail de conformité Microsoft Purview.

Exemples

Exemple 1

New-ComplianceSearchAction -SearchName "Project X" -Preview

Cet exemple crée une action de recherche d’aperçu pour la recherche de contenu nommée Project X.

Exemple 2

New-ComplianceSearchAction -SearchName "Project X" -Export

Cet exemple crée une action de recherche d’exportation pour la recherche de contenu nommée Project X.

Exemple 3

New-ComplianceSearchAction -SearchName "Remove Phishing Message" -Purge -PurgeType SoftDelete

Cet exemple supprime les résultats de recherche retournés par une recherche de contenu nommée Supprimer le message d’hameçonnage. Notez que les éléments non indexés ne sont pas supprimés lorsque vous utilisez le paramètre Purge.

Exemple 4

New-ComplianceSearchAction -SearchName "Case 321 All Sites" -Export -SharePointArchiveFormat SingleZip -ExchangeArchiveFormat PerUserPst

Cet exemple exporte les résultats retournés par la recherche de contenu nommée « Cas 321 Tous les sites ». Les résultats de la recherche sont compressés et exportés vers un seul fichier ZIP. Si la recherche incluait des emplacements Exchange, les résultats de la recherche sont exportés sous la forme d’un fichier PST par boîte aux lettres.

Paramètres

-ActionName

Ce paramètre est disponible uniquement dans le service basé sur le cloud.

Le paramètre ActionName spécifie un nom pour l’action de recherche de contenu. Vous utilisez ce paramètre uniquement lorsque vous spécifiez plusieurs recherches de contenu dans le paramètre SearchName.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ArchiveFormat

Ce paramètre est obsolète et inutilisé.

Pour spécifier le format des résultats de recherche Exchange, utilisez le paramètre ExchangeArchiveFormat. Pour spécifier le format des résultats de recherche SharePoint et OneDrive, utilisez le paramètre 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

Le commutateur Confirme spécifie s’il faut afficher ou masquer l’invite de confirmation. L’incidence de ce commutateur sur la cmdlet varie selon que la cmdlet requiert une confirmation avant de poursuivre.

  • Les applets de commande destructrices (par exemple, les applets de commande Remove-*) ont une pause intégrée qui vous oblige à accuser réception de la commande avant de continuer. Pour ces cmdlets, vous pouvez ignorer l’invite de confirmation à l’aide de cette syntaxe exacte : -Confirm:$false.
  • La plupart des autres applets de commande (par exemple, les applets de commande New-* et Set-*) n’ont pas de pause intégrée. Pour ces cmdlets, la spécification du commutateur Confirm sans valeur introduit une pause qui vous oblige à confirmer la commande avant de poursuivre.
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

Ce paramètre est réservé à l’usage interne chez Microsoft.

Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-ExchangeArchiveFormat

Ce paramètre est fonctionnel uniquement dans le service cloud.

Ce paramètre nécessite le rôle Exporter dans PowerShell conformité de la sécurité & . Par défaut, ce rôle est attribué uniquement au groupe de rôles Gestionnaire eDiscovery.

Le paramètre ExchangeArchiveFormat spécifie comment exporter les résultats de recherche Exchange. Les valeurs valides sont les suivantes :

  • PerUserPst : un fichier PST pour chaque boîte aux lettres.
  • SinglePst : un fichier PST qui contient tous les messages exportés.
  • SingleFolderPst : un fichier PST avec un dossier racine unique pour l’exportation entière.
  • IndividualMessage : exportez chaque message sous la forme d’un fichier de message .msg. Il s’agit de la valeur par défaut.
  • PerUserZip : un fichier ZIP pour chaque boîte aux lettres. Chaque fichier ZIP contient les fichiers de messages .msg exportés à partir de la boîte aux lettres.
  • SingleZip : un fichier ZIP pour toutes les boîtes aux lettres. Le fichier ZIP contient tous les fichiers de messages .msg exportés de toutes les boîtes aux lettres. Ce paramètre de sortie est disponible uniquement dans PowerShell.

Pour spécifier le format des résultats de recherche SharePoint et OneDrive, utilisez le paramètre 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

Ce paramètre est fonctionnel uniquement dans le service cloud.

Ce paramètre nécessite le rôle Exporter dans PowerShell conformité de la sécurité & . Par défaut, ce rôle est attribué uniquement au groupe de rôles Gestionnaire eDiscovery.

Le commutateur Exporter spécifie que l’action de la recherche de contenu consiste à exporter l’ensemble complet des résultats qui correspondent aux critères de recherche. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Pour renvoyer uniquement les informations relatives à chaque élément détecté dans un rapport, utilisez le commutateur 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 spécifie les types de fichiers à exclure, car ils ne peuvent pas être indexés. Vous pouvez spécifier plusieurs valeurs séparées par des virgules.

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

Le commutateur Force masque les messages d’avertissement ou de confirmation. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

Vous pouvez utiliser ce commutateur pour exécuter des tâches par programme, lorsqu’une intervention administrative est inappropriée.

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

Dans PowerShell conformité de la sécurité & , ce paramètre nécessite le rôle Exporter. Par défaut, ce rôle est attribué uniquement au groupe de rôles Gestionnaire eDiscovery.

Le paramètre Format spécifie le format des résultats de recherche lorsque vous utilisez le commutateur Export. Les valeurs valides sont les suivantes :

  • FxStream : exporter vers des fichiers PST. Il s’agit de la seule option disponible lorsque vous exportez les résultats de la recherche à partir du portail de conformité Microsoft Purview.
  • Mime : exporter vers des fichiers de message .eml. Il s’agit de la valeur par défaut lorsque vous utilisez des cmdlets pour exporter les résultats de recherche.
  • Msg : exporter vers des fichiers de message .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

Le commutateur IncludeCredential spécifie s’il faut inclure les informations d’identification dans les résultats. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

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

Ce paramètre est disponible uniquement dans le service basé sur le cloud.

Le paramètre IncludeSharePointDocumentVersions spécifie si les versions précédentes du document doivent être exportées lorsque vous utilisez le commutateur Export. Les valeurs valides sont les suivantes :

  • $true : exporter toutes les versions du document.
  • $false : exportez uniquement la version publiée actuelle de la rubrique. Il s’agit de la valeur par défaut.
Type:Boolean
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-JobOptions

Ce paramètre est réservé à l’usage interne chez 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

Dans PowerShell conformité de la sécurité & , ce paramètre nécessite le rôle Exporter. Par défaut, ce n’est affecté qu’au groupe de rôles Gestionnaire eDiscovery.

Le paramètre NotifyEmail spécifie la cible d’adresse de messagerie pour les résultats de recherche lorsque vous utilisez le commutateur Export.

Le destinataire que vous spécifiez se trouve dans le champ To: du message.

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

Dans PowerShell conformité de la sécurité & , ce paramètre nécessite le rôle Exporter. Par défaut, ce rôle est attribué uniquement au groupe de rôles Gestionnaire eDiscovery.

Le paramètre NotifyEmailCC spécifie la cible d’adresse de messagerie pour les résultats de recherche lorsque vous utilisez le commutateur Export.

Le destinataire que vous spécifiez se trouve dans le champ Cc: du message.

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

Dans PowerShell de conformité de la sécurité & , ce paramètre nécessite le rôle Préversion. Par défaut, ce rôle est attribué uniquement au groupe de rôles Gestionnaire eDiscovery.

Le commutateur Aperçu spécifie que l’action de la recherche de contenu consiste à afficher un aperçu des résultats qui correspondent aux critères de recherche. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

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

Remarque : Dans PowerShell de conformité de la sécurité & , ce commutateur est disponible uniquement dans le rôle Rechercher et vider. Par défaut, ce rôle est attribué uniquement aux groupes de rôles Gestion de l’organisation et Enquêteur de données.

Le commutateur Vider spécifie que l’action de la recherche de contenu consiste à supprimer les éléments qui correspondent aux critères de recherche. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

  • Un maximum de 10 éléments par boîte aux lettres peuvent être supprimés à la fois. Sachant que la fonction de recherche et de suppression de messages est censée être un outil de réponse aux incidents, cette limite permet de s’assurer que les messages sont rapidement supprimés des boîtes aux lettres. Cette action n’est pas conçue pour nettoyer les boîtes aux lettres des utilisateurs.
  • Vous pouvez supprimer des éléments d’un maximum de 50 000 boîtes aux lettres à l’aide d’une seule recherche de contenu. Pour supprimer des éléments de plus de 50 000 boîtes aux lettres, vous devez créer des recherches de contenu distinctes. Pour plus d’informations, consultez Rechercher et supprimer des messages électroniques dans votre organisation Microsoft 365.
  • Les éléments non indexés ne sont pas supprimés des boîtes aux lettres lorsque vous utilisez ce commutateur.
  • La valeur du paramètre PurgeType contrôle la façon dont les éléments sont supprimés.
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

Remarque : Dans PowerShell conformité de la sécurité & , ce paramètre est disponible uniquement dans le rôle Rechercher et vider. Par défaut, ce rôle est attribué uniquement aux groupes de rôles Gestion de l’organisation et Enquêteur de données.

Le paramètre PurgeType permet de définir la méthode de suppression des éléments lorsque l’action est Purge. Les valeurs valides sont les suivantes :

  • SoftDelete : les éléments vidés peuvent être récupérés par les utilisateurs jusqu’à l’expiration de la période de rétention des éléments supprimés.
  • HardDelete (cloud uniquement) : les éléments vidés sont marqués pour être supprimés définitivement de la boîte aux lettres et seront supprimés définitivement la prochaine fois que la boîte aux lettres sera traitée par l’Assistant Dossier managé. Si la récupération d’élément unique est activée sur la boîte aux lettres, les éléments vidés sont supprimés définitivement après l’expiration de la période de rétention des éléments supprimés.
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

Ce paramètre est réservé à l’usage interne chez 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

Ce paramètre est réservé à l’usage interne chez 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

Ce paramètre est fonctionnel uniquement dans le service cloud.

Le commutateur Rapport spécifie que l’action de la recherche de contenu consiste à exporter un rapport sur les résultats (informations sur chaque élément au lieu de l’ensemble complet des résultats) qui correspondent aux critères de recherche. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

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

Le commutateur RetentionReport spécifie que l’action de la recherche de contenu consiste à exporter un rapport de rétention. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

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

Le commutateur RetryOnError permet d’indiquer si l’action doit être relancée sur les éléments qui ont échoué, sans réexécuter l’action en entier. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

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

Dans PowerShell de conformité de la sécurité & , ce paramètre nécessite le rôle Préversion. Par défaut, ce rôle est attribué uniquement au groupe de rôles Gestionnaire eDiscovery.

Le paramètre Scenario spécifie le type de scénario lorsque vous utilisez le commutateur Export. Les valeurs valides sont les suivantes :

  • AnalyzeWithZoom : préparez les résultats de la recherche pour le traitement dans Microsoft Purview eDiscovery Premium.
  • Général : exporte les résultats de la recherche vers l’ordinateur local. Les messages électroniques sont exportés vers des fichiers .pst. Les documents SharePoint et OneDrive Entreprise sont exportés dans leurs formats Office natifs.
  • GenerateReportsOnly :
  • Inventaire:
  • 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

Le paramètre Scope permet de définir les éléments à inclure lorsque l’action est Export. Les valeurs valides sont les suivantes :

  • 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

Le paramètre SearchName spécifie le nom de la recherche de contenu existante à associer à l’action de recherche de contenu. Vous pouvez spécifier plusieurs recherches de contenu séparées par des virgules.

Vous pouvez trouver la recherche de contenu en exécutant la commande Get-ComplianceSearch | Format-Table -Nom automatique,État.

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

Ce paramètre est disponible uniquement dans le service basé sur le cloud.

Le paramètre SearchNames spécifie les noms des recherches de contenu existantes à associer à l’action de recherche de contenu. Vous séparez les noms de recherche de contenu par des virgules.

Vous pouvez trouver des noms de recherche de contenu en exécutant la commande Get-ComplianceSearch | Format-Table -Nom automatique,État.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Security & Compliance

-SharePointArchiveFormat

Ce paramètre est fonctionnel uniquement dans le service cloud.

Ce paramètre nécessite le rôle Exporter. Par défaut, ce rôle est attribué uniquement au groupe de rôles Gestionnaire eDiscovery.

Le paramètre SharePointArchiveFormat spécifie comment exporter les résultats de recherche SharePoint et OneDrive. Les valeurs valides sont les suivantes :

  • IndividualMessage : exportez les fichiers non compressés. Il s’agit de la valeur par défaut.
  • PerUserZip : un fichier ZIP pour chaque utilisateur. Chaque fichier ZIP contient les fichiers exportés pour l’utilisateur.
  • SingleZip : un fichier ZIP pour tous les utilisateurs. Le fichier ZIP contient tous les fichiers exportés de tous les utilisateurs. Ce paramètre de sortie est disponible uniquement dans PowerShell.

Pour spécifier le format des résultats de recherche Exchange, utilisez le paramètre 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

Ce paramètre est réservé à l’usage interne chez 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

Le commutateur WhatIf ne fonctionne pas dans PowerShell conformité de la sécurité & .

Le commutateur WhatIf simule les actions de la commande. Vous pouvez utiliser ce commutateur pour afficher les modifications qui se produiraient sans réellement appliquer ces modifications. Il n’est pas nécessaire de spécifier une valeur pour ce commutateur.

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