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 ambiente ou de outro.
Use o cmdlet New-ComplianceSearchAction para criar ações para pesquisas de conteúdo no Exchange Server e no Microsoft Purview.
Observação: vários dos parâmetros neste cmdlet são funcionais somente no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Sintaxe
Export
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>]
Preview
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>]
Purge
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á-la 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 somente ao grupo de funções Gerenciamento de Descobertas.
Para executar esse cmdlet, você precisa ter permissões. Embora este artigo 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 este cmdlet no PowerShell de Segurança e Conformidade, você precisa receber permissões. Para obter mais informações, confira Permissões no portal de conformidade do Microsoft Purview.
Para usar este cmdlet para ações de limpeza no PowerShell de Segurança & Conformidade, você precisa atender aos seguintes requisitos:
- Use o PowerShell do Exchange Online versão 3.9.0 ou posterior (agosto de 2025). Para obter mais informações, consulte Novidades no módulo do PowerShell do Exchange Online. A instalação desta versão do módulo pode exigir que você una todas as versões anteriores do módulo.
- Execute o comando Connect-IPPSSession com o switch EnableSearchOnlySession .
Exemplos
Exemplo 1
New-ComplianceSearchAction -SearchName "Project X" -Preview
Este exemplo cria uma ação de pesquisa de visualização para a pesquisa de conteúdo chamada Project X.
Exemplo 2
New-ComplianceSearchAction -SearchName "Project X" -Export
Este exemplo cria uma ação de pesquisa de exportação para a pesquisa de conteúdo chamada Project X.
Observação: este exemplo funciona apenas no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
Exemplo 3
New-ComplianceSearchAction -SearchName "Remove Phishing Message" -Purge -PurgeType SoftDelete
Este exemplo exclui os resultados da pesquisa retornados por uma pesquisa de conteúdo chamada Remover Mensagem de Phishing. 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 PerUserPst -Format FxStream
Este 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 incluir locais do Exchange, os resultados da pesquisa serão exportados como um arquivo PST por caixa de correio.
Observação: este exemplo funciona apenas no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
Parâmetros
-ActionName
Aplicável: Segurança & Conformidade
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ê usará esse parâmetro somente quando especificar várias pesquisas de conteúdo no parâmetro SearchName.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ArchiveFormat
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Esse parâmetro foi preterido e não é mais usado.
Para especificar o formato para os resultados da pesquisa do Exchange, use o parâmetro ExchangeArchiveFormat. Para especificar o formato para os resultados de pesquisa do SharePoint e do OneDrive, use o parâmetro SharePointArchiveFormat.
Propriedades do parâmetro
| Tipo: | ComplianceExportArchiveFormat |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Export
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Confirm
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
A opção Confirm especifica se a solicitação de confirmação deve ser mostrada ou ocultada. A forma como essa opção afeta o cmdlet depende se o cmdlet requer confirmação antes de continuar.
- Cmdlets destrutivos (por exemplo, Remover- cmdlets) têm uma pausa interna que força você a confirmar o comando antes de continuar. Para estes cmdlets, você pode pular o pedido de confirmação usando esta sintaxe exata:
-Confirm:$false. - A maioria dos outros cmdlets (por exemplo, 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 reconhecer o comando antes de continuar.
Este cmdlet tem uma pausa interna, portanto, use -Confirm:$false para ignorar a confirmação.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | cf |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-EnableDedupe
Aplicável: Segurança & Conformidade
Esse parâmetro só está disponível no serviço baseado em nuvem.
Esse parâmetro está reservado para uso interno da Microsoft.
Propriedades do parâmetro
| Tipo: | Boolean |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Export
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ExchangeArchiveFormat
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Observação: esse parâmetro é funcional somente no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
Esse parâmetro só é funcional no serviço baseado em nuvem.
Esse parâmetro requer a função Exportar no PowerShell de Segurança & Conformidade. Por padrão, essa função é atribuída apenas ao grupo de funções do Gerente de Descoberta Eletrônica.
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 valor é o 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 está disponível somente no PowerShell.
Para especificar o formato para os resultados de pesquisa do SharePoint e do OneDrive, use o parâmetro SharePointArchiveFormat.
Propriedades do parâmetro
| Tipo: | ComplianceExportArchiveFormat |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Export
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Export
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Observação: esse parâmetro é funcional somente no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
Esse parâmetro só é funcional no serviço baseado em nuvem.
Esse parâmetro requer a função Exportar no PowerShell de Segurança & Conformidade. Por padrão, essa função é atribuída apenas ao grupo de funções do Gerente de Descoberta Eletrônica.
A opção Exportar especifica que a ação para a pesquisa de conteúdo é exportar o conjunto completo de resultados que correspondem 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.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Export
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-FileTypeExclusionsForUnindexedItems
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Observação: esse parâmetro é funcional somente no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
O FileTypeExclusionsForUnindexedItems especifica os tipos de arquivo a serem excluídos porque eles não podem ser indexados. Vários valores, separados por vírgulas, podem ser especificados.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Export
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Force
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
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.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Format
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
No PowerShell de Segurança & Conformidade, esse parâmetro requer a função Exportar. Por padrão, essa função é atribuída apenas ao grupo de funções do Gerente de Descoberta Eletrônica.
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 .eml arquivos de mensagens. Este é o valor padrão ao usar cmdlets para exportar os resultados da pesquisa.
- Msg: Exportar para .msg arquivos de mensagem.
Propriedades do parâmetro
| Tipo: | ComplianceDataTransferFormat |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-IncludeCredential
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
A opção IncludeCredential especifica se a credencial deve ser incluída nos resultados. Não é preciso especificar um valor com essa opção.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-IncludeSharePointDocumentVersions
Aplicável: Segurança & Conformidade
Observação: esse parâmetro é funcional somente no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
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 publicada atual do documento. Esse valor é o padrão.
Propriedades do parâmetro
| Tipo: | Boolean |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Export
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-JobOptions
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Esse parâmetro está reservado para uso interno da Microsoft.
Propriedades do parâmetro
| Tipo: | Int32 |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-NotifyEmail
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Observação: esse parâmetro é funcional somente no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
No PowerShell de Segurança & Conformidade, esse parâmetro requer a função Exportar. Por padrão, isso é atribuído somente ao grupo de funções do Gerente 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.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Export
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-NotifyEmailCC
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Observação: esse parâmetro é funcional somente no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
No PowerShell de Segurança & Conformidade, esse parâmetro requer a função Exportar. Por padrão, essa função é atribuída apenas ao grupo de funções do Gerente de Descoberta Eletrônica.
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.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Export
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Preview
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Observação: esse parâmetro é funcional somente no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
No PowerShell de Segurança & Conformidade, esse parâmetro requer a função de Versão prévia. Por padrão, essa função é atribuída apenas ao grupo de funções do Gerente de Descoberta Eletrônica.
A opção Visualizar especifica que a ação da pesquisa de conteúdo é visualizar os resultados que correspondem aos critérios de pesquisa. Não é preciso especificar um valor com essa opção.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Preview
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Purge
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Observação: no PowerShell de Segurança & Conformidade, essa opção está disponível somente na função Pesquisar e Limpar. Por padrão, essa função é atribuída somente aos grupos de funções Gerenciamento da Organização e Investigador de Dados.
A opção Limpar especifica que a ação para a pesquisa de conteúdo é remover os itens que correspondem 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.
Dica: para limpar mais de 10 itens, consulte ediscoverySearch: purgeData na API do Graph, que permite limpar no máximo 100 itens por local.
Você pode remover itens de no máximo 50.000 caixas de correio usando uma única pesquisa de conteúdo. Para remover itens de mais de 50.000 caixas de correio, você precisa 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.
Os itens não indexados 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.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Purge
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-PurgeType
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Observação: no PowerShell de Segurança & Conformidade, esse parâmetro está disponível somente na função Pesquisar e Limpar. Por padrão, essa função é atribuída somente aos grupos de funções Gerenciamento da Organização e Investigador 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 podem ser recuperados pelos usuários até que o período de retenção do item excluído expire.
- HardDelete (somente nuvem): os itens limpos são marcados para remoção permanente da caixa de correio e sã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 removidos serão removidos permanentemente após o período de retenção de item excluído expirar.
Propriedades do parâmetro
| Tipo: | ComplianceDestroyType |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Purge
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ReferenceActionName
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Esse parâmetro está reservado para uso interno da Microsoft.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Region
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Esse parâmetro está reservado para uso interno da Microsoft.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Report
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Observação: esse parâmetro é funcional somente no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
Esse parâmetro só é funcional 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.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Export
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-RetentionReport
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Observação: esse parâmetro é funcional somente no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
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.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Export
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-RetryOnError
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
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.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Scenario
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
No PowerShell de Segurança & Conformidade, esse parâmetro requer a função de Versão prévia. Por padrão, essa função é atribuída apenas ao grupo de funções do Gerente de Descoberta Eletrônica.
O parâmetro Scenario especifica o tipo de cenário. Os valores válidos são:
- AnalyzeWithZoom: prepare os resultados da pesquisa para processamento no 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 do OneDrive são exportados em seus formatos nativos do Office.
- GenerateReportsOnly
- Inventário
- RetentionReports
- TriagePreview
Propriedades do parâmetro
| Tipo: | ComplianceSearchActionScenario |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Scope
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Observação: esse parâmetro é funcional somente no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
O parâmetro Scope especifica os itens a incluir quando a ação for Export. Os valores válidos são:
- IndexedItemsOnly
- UnindexedItemsOnly
- BothIndexedAndUnindexedItems
Propriedades do parâmetro
| Tipo: | ComplianceExportScope |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Export
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-SearchName
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
O parâmetro SearchName especifica o nome da pesquisa de conteúdo existente a ser associada à ação de pesquisa de conteúdo. Você pode especificar várias pesquisas de conteúdo separadas por vírgulas.
Você pode encontrar a pesquisa de conteúdo executando o comando Get-ComplianceSearch | Format-Table -Auto Name,Status.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | 1 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-SearchNames
Aplicável: Segurança & Conformidade
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 da pesquisa de conteúdo por vírgulas.
Você pode encontrar nomes de pesquisa de conteúdo executando o comando Get-ComplianceSearch | Format-Table -Auto Name,Status.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-SharePointArchiveFormat
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Observação: esse parâmetro é funcional somente no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
Esse parâmetro só é funcional 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 Gerente de Descoberta Eletrônica.
O parâmetro SharePointArchiveFormat especifica como exportar os resultados da pesquisa do SharePoint e do OneDrive. Os valores válidos são:
- IndividualMessage: Exporte os arquivos descompactados. Esse valor é o 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 está disponível somente no PowerShell.
Para especificar o formato para os resultados da pesquisa do Exchange, use o parâmetro ExchangeArchiveFormat.
Propriedades do parâmetro
| Tipo: | ComplianceExportArchiveFormat |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Export
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ShareRootPath
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Este parâmetro está disponível somente no Exchange local.
Observação: esse parâmetro é funcional somente no Exchange local. Para obter mais informações, consulte as alterações de maio de 2025 na Descoberta Eletrônica do Microsoft Purview.
{{ Preencher descrição do ShareRootPath }}
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Export
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Version
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Esse parâmetro está reservado para uso interno da Microsoft.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-WhatIf
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
A opção WhatIf não funciona no PowerShell de Segurança e Conformidade.
A opção WhatIf mostra o que o comando faz sem fazer nenhuma alteração. Não é preciso especificar um valor com essa opção.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | wi |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet dá suporte aos parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.