New-ComplianceSearchAction
Este cmdlet está disponível no Exchange local e no serviço baseado na nuvem. Alguns parâmetros e configurações podem ser exclusivos de um ou outro ambiente.
Use o cmdlet New-ComplianceSearchAction para criar ações para pesquisas de conteúdo no Exchange Server e no portal de conformidade do Microsoft Purview.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
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
Depois de criar uma pesquisa de conteúdo usando o cmdlet New-ComplianceSearch e executá-lo usando o cmdlet Start-ComplianceSearch, você atribui uma ação de pesquisa à pesquisa usando o cmdlet New-ComplianceSearchAction.
No Exchange local, esse cmdlet está disponível na função Pesquisa de Caixa de Correio. Por padrão, essa função é atribuída apenas ao grupo de funções do Gerenciamento de Descobertas.
Para executar esse cmdlet, você precisa ter permissões. Embora este tópico liste todos os parâmetros do cmdlet, talvez você não tenha acesso a alguns parâmetros se eles não estiverem incluídos nas permissões atribuídas a você. Para localizar as permissões necessárias para executar qualquer cmdlet ou parâmetro em sua organização, confira Find the permissions required to run any Exchange cmdlet.
No Microsoft 365, a conta que você usa para executar esse cmdlet deve ter uma licença válida do Microsoft 365 atribuída.
Para usar esse cmdlet no PowerShell de Conformidade de Segurança & , você precisa receber permissões. Para obter mais informações, confira Permissões no portal de conformidade do Microsoft Purview.
Exemplos
Exemplo 1
New-ComplianceSearchAction -SearchName "Project X" -PreviewEste exemplo cria uma ação de pesquisa prévia para a pesquisa de conteúdo chamada Project X.
Exemplo 2
New-ComplianceSearchAction -SearchName "Project X" -ExportEste exemplo cria uma ação de pesquisa de exportação para a pesquisa de conteúdo chamada Project X.
Exemplo 3
New-ComplianceSearchAction -SearchName "Remove Phishing Message" -Purge -PurgeType SoftDeleteEste exemplo exclui os resultados da pesquisa retornados por uma pesquisa de conteúdo chamada Remover Mensagem de Phishing. Observe que os itens não indexados não são excluídos quando você usa o parâmetro Purge.
Exemplo 4
New-ComplianceSearchAction -SearchName "Case 321 All Sites" -Export -SharePointArchiveFormat SingleZip -ExchangeArchiveFormat PerUserPstEste exemplo exporta os resultados retornados pela pesquisa de conteúdo chamada "Caso 321 Todos os Sites". Os resultados da pesquisa são compactados e exportados para um único arquivo ZIP. Se a pesquisa incluiu quaisquer locais do Exchange, os resultados da pesquisa serão exportados como um arquivo PST por caixa de correio.
Parâmetros
-ActionName
Esse parâmetro só está disponível no serviço baseado em nuvem.
O parâmetro ActionName especifica um nome para a ação de pesquisa de conteúdo. Você usa esse parâmetro somente quando especifica várias pesquisas de conteúdo no 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 foi substituído e não é mais usado.
Para especificar o formato dos resultados da pesquisa do Exchange, use o parâmetro ExchangeArchiveFormat. Para especificar o formato dos resultados da pesquisa do SharePoint e do OneDrive, use o 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
A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. Como essa opção afeta o cmdlet dependerá do fato de o cmdlet exigir ou não confirmação antes de continuar.
- Cmdlets destrutivos (por exemplo, cmdlets Remove-*) têm uma pausa interna que força você a reconhecer o comando antes de prosseguir. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata:
-Confirm:$false. - A maioria dos outros cmdlets (por exemplo, cmdlets New-* e Set-*) não tem uma pausa interna. Para esses cmdlets, especificar a opção Confirm sem um valor introduz uma pausa que força você a confirmar o 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
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-ExchangeArchiveFormat
Esse parâmetro é funcional apenas no serviço baseado em nuvem.
Esse parâmetro requer a função Exportar no PowerShell de Conformidade de Segurança & . Por padrão, essa função é atribuída apenas ao grupo de funções do eDiscovery Manager.
O parâmetro ExchangeArchiveFormat especifica como exportar os resultados da pesquisa do Exchange. Os valores válidos são:
- PerUserPst: um arquivo PST para cada caixa de correio.
- SinglePst: um arquivo PST que contém todas as mensagens exportadas.
- SingleFolderPst: um arquivo PST com uma única pasta raiz para toda a exportação.
- IndividualMessage: exporte cada mensagem como um arquivo de mensagem .msg. Esse é o valor padrão.
- PerUserZip: um arquivo ZIP para cada caixa de correio. Cada arquivo ZIP contém os arquivos de mensagem .msg exportados da caixa de correio.
- SingleZip: um arquivo ZIP para todas as caixas de correio. O arquivo ZIP contém todos os arquivos de mensagens .msg exportados de todas as caixas de correio. Essa configuração de saída só está disponível no PowerShell.
Para especificar o formato dos resultados da pesquisa do SharePoint e do OneDrive, use o 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
Esse parâmetro é funcional apenas no serviço baseado em nuvem.
Esse parâmetro requer a função Exportar no PowerShell de Conformidade de Segurança & . Por padrão, essa função é atribuída apenas ao grupo de funções do eDiscovery Manager.
A opção Exportar especifica que a ação para a pesquisa de conteúdo é exportar o conjunto completo de resultados que correspondam aos critérios de pesquisa. Não é preciso especificar um valor com essa opção.
Para retornar somente a informação sobre cada item detectado em um relatório, use a opção 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
O FileTypeExclusionsForUnindexedItems especifica os tipos de arquivo a serem excluídos porque não podem ser indexados. Vários valores, separados por vírgulas, podem ser especificados.
| 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
A opção Forçar oculta mensagens de aviso ou confirmação. Não é preciso especificar um valor com essa opção.
Você pode usar essa opção para executar tarefas de modo programático onde a solicitação por entrada administrativa é inadequada.
| 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
No PowerShell de Conformidade de Segurança & , esse parâmetro requer a função Exportar. Por padrão, essa função é atribuída apenas ao grupo de funções do eDiscovery Manager.
O parâmetro Format especifica o formato dos resultados da pesquisa quando você usar a opção Export. Os valores válidos são:
- FxStream: exportar para arquivos PST. Essa é a única opção disponível quando você exporta os resultados da pesquisa do portal de conformidade do Microsoft Purview.
- Mime: exportar para arquivos de mensagem .eml. Este é o valor padrão ao usar cmdlets para exportar os resultados da pesquisa.
- Msg: exportar para arquivos de mensagem .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
A opção IncludeCredential especifica se deve incluir a credencial nos resultados. Não é preciso especificar um valor com essa opção.
| 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
Esse parâmetro só está disponível no serviço baseado em nuvem.
O parâmetro IncludeSharePointDocumentVersions especifica quando exportar as versões anteriores ao usar a opção Export. Os valores válidos são:
- $true: exportar todas as versões do documento.
- $false: exporte apenas a versão atual publicada do tópico. Esse é o valor padrão.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-JobOptions
Esse parâmetro está reservado para uso interno da 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
No PowerShell de Conformidade de Segurança & , esse parâmetro requer a função Exportar. Por padrão, isso é atribuído apenas ao grupo de funções do Gerenciador de Descoberta Eletrônica.
O parâmetro NotifyEmail especifica a meta do endereço de email para os resultados da pesquisa ao usar a opção Export.
O destinatário especificado está no campo To: da mensagem.
| 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
No PowerShell de Conformidade de Segurança & , esse parâmetro requer a função Exportar. Por padrão, essa função é atribuída apenas ao grupo de funções do eDiscovery Manager.
O parâmetro NotifyEmailCC especifica a meta do endereço de email para os resultados da pesquisa ao usar a opção Export.
O destinatário especificado está no campo Cc: da mensagem.
| 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
No PowerShell de Conformidade de Segurança & , esse parâmetro requer a função Preview. Por padrão, essa função é atribuída apenas ao grupo de funções do eDiscovery Manager.
A opção Versão prévia especifica que a ação para a pesquisa de conteúdo é visualizar os resultados que correspondem aos critérios de pesquisa. Não é preciso especificar um valor com essa opção.
| 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
Observação: no PowerShell de Conformidade de Segurança & , essa opção só está disponível na função Pesquisar e Limpar. Por padrão, essa função é atribuída apenas aos grupos de funções Gerenciamento de Organização e Pesquisador de Dados.
A opção Limpar especifica que a ação para a pesquisa de conteúdo é remover itens que correspondam aos critérios de pesquisa. Não é preciso especificar um valor com essa opção.
- Só é possível remover no máximo dez itens de cada vez por caixa de correio. Como o recurso de pesquisa e remoção de mensagens tem como objetivo ser uma ferramenta de resposta a incidentes, esse limite ajuda a garantir que as mensagens sejam rapidamente removidas das caixas de correio. Essa ação não tem como objetivo limpar as caixas de correio do usuário.
- Você pode remover itens de um máximo de 50.000 caixas de correio usando uma única pesquisa de conteúdo. Para remover itens de mais de 50.000 caixas de correio, você precisará criar pesquisas de conteúdo separadas. Para obter mais informações, consulte Pesquisar e excluir mensagens de email em sua organização do Microsoft 365.
- Itens não especificados não são removidos das caixas de correio quando você usa essa opção.
- O valor do parâmetro PurgeType controla como os itens são removidos.
| 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
Observação: no PowerShell de Conformidade de Segurança & , esse parâmetro está disponível apenas na função Pesquisar e Limpar. Por padrão, essa função é atribuída apenas aos grupos de funções Gerenciamento de Organização e Pesquisador de Dados.
O parâmetro PurgeType especifica como remover itens quando a ação é Purge. Os valores válidos são:
- SoftDelete: os itens limpos são recuperáveis pelos usuários até que o período de retenção de item excluído expire.
- HardDelete (somente nuvem): os itens limpos são marcados para remoção permanente da caixa de correio e serão removidos permanentemente na próxima vez que a caixa de correio for processada pelo Assistente de Pasta Gerenciada. Se a recuperação de item único estiver habilitada na caixa de correio, os itens limpos serão removidos permanentemente depois que o período de retenção de item excluído expirar.
| 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
Esse parâmetro está reservado para uso interno da 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
Esse parâmetro está reservado para uso interno da 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
Esse parâmetro é funcional apenas no serviço baseado em nuvem.
A opção Relatório especifica que a ação para a pesquisa de conteúdo é exportar um relatório sobre os resultados (informações sobre cada item em vez do conjunto completo de resultados) que correspondam aos critérios de pesquisa. Não é preciso especificar um valor com essa opção.
| 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
A opção RetentionReport especifica que a ação para a pesquisa de conteúdo é exportar um relatório de retenção. Não é preciso especificar um valor com essa opção.
| 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
A opção RetryOnError especifica se deve repetir a ação em todos os itens que apresentaram falhas, sem executar novamente toda a ação. Não é preciso especificar um valor com essa opção.
| 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
No PowerShell de Conformidade de Segurança & , esse parâmetro requer a função Preview. Por padrão, essa função é atribuída apenas ao grupo de funções do eDiscovery Manager.
O parâmetro Scenario especifica o tipo de cenário ao usar a opção Export. Os valores válidos são:
- AnalyzeWithZoom: prepare os resultados da pesquisa para processamento em Descoberta Eletrônica Premium do Microsoft Purview.
- Geral: exporta os resultados da pesquisa para o computador local. Os emails são exportados para arquivos .pst. Os documentos do SharePoint e OneDrive for Business são exportados em seus formatos nativos do Office.
- GenerateReportsOnly:
- Inventário:
- 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
O parâmetro Scope especifica os itens a incluir quando a ação for Export. Os valores válidos são:
- 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
O parâmetro SearchName especifica o nome da pesquisa de conteúdo existente para associar à ação de pesquisa de conteúdo. Você pode especificar várias pesquisas de conteúdo separadas por vírgulas.
Você pode localizar a pesquisa de conteúdo executando o comando Get-ComplianceSearch | Format-Table -Nome automático, status.
| 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
Esse parâmetro só está disponível no serviço baseado em nuvem.
O parâmetro SearchNames especifica os nomes das pesquisas de conteúdo existentes a serem associadas à ação de pesquisa de conteúdo. Você separa os nomes de pesquisa de conteúdo por vírgulas.
Você pode encontrar nomes de pesquisa de conteúdo executando o comando Get-ComplianceSearch | Format-Table -Nome automático, status.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Security & Compliance |
-SharePointArchiveFormat
Esse parâmetro é funcional apenas no serviço baseado em nuvem.
Esse parâmetro requer a função Exportar. Por padrão, essa função é atribuída apenas ao grupo de funções do eDiscovery Manager.
O parâmetro SharePointArchiveFormat especifica como exportar os resultados da pesquisa do SharePoint e do OneDrive. Os valores válidos são:
- IndividualMessage: exportar os arquivos não compactados. Esse é o valor padrão.
- PerUserZip: um arquivo ZIP para cada usuário. Cada arquivo ZIP contém os arquivos exportados para o usuário.
- SingleZip: um arquivo ZIP para todos os usuários. O arquivo ZIP contém todos os arquivos exportados de todos os usuários. Essa configuração de saída só está disponível no PowerShell.
Para especificar o formato dos resultados da pesquisa do Exchange, use o 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
{{ Preencher Descrição do ShareRootPath }}
| 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
Esse parâmetro está reservado para uso interno da 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
A opção WhatIf não funciona no PowerShell de Conformidade de Segurança & .
A opção WhatIf simula as ações do comando. Você pode usar essa opção para exibir as alterações que ocorreriam sem realmente aplicar essas alterações. Não é preciso especificar um valor com essa opção.
| 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 |
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de