Compartilhar via

New-ComplianceSearchAction

Módulo:
Exchange PowerShell

Este cmdlet está disponível no Exchange local e no serviço baseado na nuvem. Alguns parâmetros e definições podem ser exclusivos de um ambiente ou outro.

Utilize o cmdlet New-ComplianceSearchAction para criar ações para pesquisas de conteúdos 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.

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údos com o cmdlet New-ComplianceSearch e executá-la com o cmdlet Start-ComplianceSearch, atribui uma ação de pesquisa à pesquisa com o cmdlet New-ComplianceSearchAction.

No Exchange no local, este cmdlet está disponível na função Pesquisa de Caixa de Correio. Por predefinição, esta função é atribuída apenas ao grupo de funções Gestão de Deteção.

Para executar esse cmdlet, você precisa ter permissões. Embora este artigo liste todos os parâmetros do cmdlet, poderá não ter acesso a alguns parâmetros se não estiverem incluídos nas permissões que lhe foram atribuídas. 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 utiliza para executar este cmdlet tem de 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 utilizar este cmdlet para ações de Remoção no PowerShell de Conformidade do & de Segurança, tem de cumprir os seguintes requisitos:

  • Utilize o Exchange Online versão 3.9.0 ou posterior do PowerShell (agosto de 2025). Para obter mais informações, veja Novidades no módulo Exchange Online PowerShell. A instalação desta versão do módulo poderá exigir que desinstale as versões anteriores do módulo.
  • Execute o comando Connect-IPPSSession com o comutador EnableSearchOnlySession .

Exemplos

Exemplo 1

New-ComplianceSearchAction -SearchName "Project X" -Preview

Este exemplo cria uma ação de pesquisa de pré-visualização para a pesquisa de conteúdos denominada 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údos denominada Project X.

Nota: depois de 26 de maio de 2025, este exemplo já não funciona. Para obter mais informações, veja Alterações futuras ao Descoberta Eletrônica do Microsoft Purview.

Exemplo 3

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

Este exemplo elimina os resultados da pesquisa devolvidos por uma pesquisa de conteúdos denominada Remover Mensagem de Phishing. Os itens não identificados não são eliminados quando utiliza o parâmetro Remover.

Exemplo 4

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

Este exemplo exporta os resultados devolvidos pela pesquisa de conteúdos denominada "Caso 321 Todos os Sites". Os resultados da pesquisa são comprimidos e exportados para um único ficheiro ZIP. Se a pesquisa incluir quaisquer localizações do Exchange, os resultados da pesquisa são exportados como um ficheiro PST por caixa de correio.

Nota: depois de 26 de maio de 2025, este exemplo já não funciona. Para obter mais informações, veja Alterações futuras ao Descoberta Eletrônica do Microsoft Purview.

Parâmetros

-ActionName

Aplicável: Conformidade do & de Segurança

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údos. Só utiliza este parâmetro quando especifica múltiplas 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, Conformidade & de Segurança

Este parâmetro foi preterido e já não é utilizado.

Para especificar o formato dos resultados da pesquisa do Exchange, utilize o parâmetro ExchangeArchiveFormat. Para especificar o formato dos resultados de pesquisa do SharePoint e do OneDrive, utilize 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, Conformidade & de Segurança

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, 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 confirmar o comando antes de continuar.

Este cmdlet tem uma pausa incorporada, pelo que deve utilizar -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: Conformidade do & de Segurança

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, Conformidade & de Segurança

Nota: depois de 26 de maio de 2025, este parâmetro já não está funcional. Para obter mais informações, veja Alterações futuras ao Descoberta Eletrônica do Microsoft Purview.

Esse parâmetro só é funcional no serviço baseado em nuvem.

Este parâmetro requer a função Exportar no PowerShell de Conformidade do & de Segurança. Por predefinição, esta função é atribuída apenas ao grupo de funções do Gestor de Deteção de Dados Eletrónicos.

O parâmetro ExchangeArchiveFormat especifica como exportar os resultados da pesquisa do Exchange. Os valores válidos são:

  • PerUserPst: um ficheiro PST para cada caixa de correio.
  • SinglePst: um ficheiro PST que contém todas as mensagens exportadas.
  • SingleFolderPst: um ficheiro PST com uma única pasta raiz para toda a exportação.
  • IndividualMessage: exporte cada mensagem como um ficheiro de mensagem .msg. Este valor é a predefinição.
  • PerUserZip: um ficheiro ZIP para cada caixa de correio. Cada ficheiro ZIP contém os ficheiros de mensagens .msg exportados da caixa de correio.
  • SingleZip: um ficheiro ZIP para todas as caixas de correio. O ficheiro ZIP contém todos os ficheiros de mensagens .msg exportados de todas as caixas de correio. Esta definição de saída só está disponível no PowerShell.

Para especificar o formato dos resultados de pesquisa do SharePoint e do OneDrive, utilize 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, Conformidade & de Segurança

Nota: depois de 26 de maio de 2025, este parâmetro já não está funcional. Para obter mais informações, veja Alterações futuras ao Descoberta Eletrônica do Microsoft Purview.

Esse parâmetro só é funcional no serviço baseado em nuvem.

Este parâmetro requer a função Exportar no PowerShell de Conformidade do & de Segurança. Por predefinição, esta função é atribuída apenas ao grupo de funções do Gestor de Deteção de Dados Eletrónicos.

O comutador Exportar especifica que a ação da pesquisa de conteúdos é 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, Conformidade & de Segurança

Nota: depois de 26 de maio de 2025, este parâmetro já não está funcional. Para obter mais informações, veja Alterações futuras ao Descoberta Eletrônica do Microsoft Purview.

FileTypeExclusionsForUnindexedItems especifica os tipos de ficheiro a excluir porque 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, Conformidade & de Segurança

O comutador 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, Conformidade & de Segurança

No PowerShell de Conformidade do & de Segurança, este parâmetro requer a função Exportar. Por predefinição, esta função é atribuída apenas ao grupo de funções do Gestor de Deteção de Dados Eletrónicos.

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 ficheiros PST. Esta é a única opção disponível quando exporta os resultados da pesquisa do portal de conformidade do Microsoft Purview.
  • Mime: exportar para .eml ficheiros de mensagens. Este é o valor padrão ao usar cmdlets para exportar os resultados da pesquisa.
  • Msg: exportar para .msg ficheiros de mensagens.

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, Conformidade & de Segurança

O comutador IncludeCredential especifica se deve incluir a credencial 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: Conformidade do & de Segurança

Nota: depois de 26 de maio de 2025, este parâmetro já não está funcional. Para obter mais informações, veja Alterações futuras ao 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. Este valor é a predefiniçã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, Conformidade & de Segurança

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, Conformidade & de Segurança

Nota: depois de 26 de maio de 2025, este parâmetro já não está funcional. Para obter mais informações, veja Alterações futuras ao Descoberta Eletrônica do Microsoft Purview.

No PowerShell de Conformidade do & de Segurança, este parâmetro requer a função Exportar. Por predefinição, esta opção é atribuída apenas ao grupo de funções gestor de deteção de dados eletrónicos.

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, Conformidade & de Segurança

Nota: depois de 26 de maio de 2025, este parâmetro já não está funcional. Para obter mais informações, veja Alterações futuras ao Descoberta Eletrônica do Microsoft Purview.

No PowerShell de Conformidade do & de Segurança, este parâmetro requer a função Exportar. Por predefinição, esta função é atribuída apenas ao grupo de funções do Gestor de Deteção de Dados Eletrónicos.

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, Conformidade & de Segurança

No PowerShell de Conformidade do & de Segurança, este parâmetro requer a função pré-visualização. Por predefinição, esta função é atribuída apenas ao grupo de funções do Gestor de Deteção de Dados Eletrónicos.

O comutador Pré-visualização especifica que a ação da pesquisa de conteúdos é pré-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, Conformidade & de Segurança

Nota: no PowerShell de Conformidade & de Segurança, este comutador só está disponível na função Procurar e Remover. Por predefinição, esta função é atribuída apenas aos grupos de funções Gestão da Organização e Investigador de Dados.

O comutador Remover especifica que a ação para a pesquisa de conteúdos é 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.

    Sugestão: para remover mais de 10 itens, consulte ediscoverySearch: purgeData no microsoft API do Graph, que permite remover um máximo de 100 itens por localização.

  • Pode remover itens de um máximo de 50 000 caixas de correio através de uma única pesquisa de conteúdo. Para remover itens de mais de 50 000 caixas de correio, tem de criar pesquisas de conteúdo separadas. Para obter mais informações, consulte Procurar e eliminar mensagens de e-mail na sua organização do Microsoft 365.

  • Os itens não identificados não são removidos das caixas de correio quando utiliza este comutador.

  • O valor do parâmetro PurgeType controla a forma 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, Conformidade & de Segurança

Nota: no PowerShell de Conformidade do & de Segurança, este parâmetro só está disponível na função Procurar e Remover. Por predefinição, esta função é atribuída apenas aos grupos de funções Gestão 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 removidos são recuperáveis pelos utilizadores até que o período de retenção do item eliminado expire.
  • HardDelete (apenas na nuvem): os itens removidos são marcados para remoção permanente da caixa de correio e são removidos permanentemente da próxima vez que a caixa de correio for processada pelo Assistente de Pastas Geridas. Se a recuperação de itens únicos estiver ativada na caixa de correio, os itens removidos são removidos permanentemente após o período de retenção do item eliminado 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, Conformidade & de Segurança

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, Conformidade & de Segurança

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, Conformidade & de Segurança

Nota: depois de 26 de maio de 2025, este parâmetro já não está funcional. Para obter mais informações, veja Alterações futuras ao Descoberta Eletrônica do Microsoft Purview.

Esse parâmetro só é funcional no serviço baseado em nuvem.

O comutador Relatório especifica que a ação da pesquisa de conteúdos é exportar um relatório sobre os resultados (informações sobre cada item em vez do conjunto completo de 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

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, Conformidade & de Segurança

Nota: depois de 26 de maio de 2025, este parâmetro já não está funcional. Para obter mais informações, veja Alterações futuras ao Descoberta Eletrônica do Microsoft Purview.

O comutador RetentionReport especifica que a ação para a pesquisa de conteúdos é 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, Conformidade & de Segurança

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, Conformidade & de Segurança

No PowerShell de Conformidade do & de Segurança, este parâmetro requer a função pré-visualização. Por predefinição, esta função é atribuída apenas ao grupo de funções do Gestor de Deteção de Dados Eletrónicos.

O parâmetro Cenário 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 nos respetivos 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, Conformidade & de Segurança

Nota: depois de 26 de maio de 2025, este parâmetro já não está funcional. Para obter mais informações, veja Alterações futuras ao 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, Conformidade & de Segurança

O parâmetro SearchName especifica o nome da pesquisa de conteúdo existente a associar à ação de pesquisa de conteúdos. Pode especificar múltiplas pesquisas de conteúdos separadas por vírgulas.

Pode encontrar a pesquisa de conteúdos ao executar o comando Get-ComplianceSearch | Format-Table -Nome Automático, Estado.

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: Conformidade do & de Segurança

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 para associar à ação de pesquisa de conteúdos. Separa os nomes da pesquisa de conteúdos por vírgulas.

Pode encontrar nomes de pesquisa de conteúdos ao executar o comando Get-ComplianceSearch | Format-Table -Nome Automático, Estado.

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, Conformidade & de Segurança

Nota: depois de 26 de maio de 2025, este parâmetro já não está funcional. Para obter mais informações, veja Alterações futuras ao Descoberta Eletrônica do Microsoft Purview.

Esse parâmetro só é funcional no serviço baseado em nuvem.

Este parâmetro requer a função Exportar. Por predefinição, esta função é atribuída apenas ao grupo de funções do Gestor de Deteção de Dados Eletrónicos.

O parâmetro SharePointArchiveFormat especifica como exportar os resultados de pesquisa do SharePoint e do OneDrive. Os valores válidos são:

  • IndividualMessage: exporte os ficheiros descomprimidos. Este valor é a predefinição.
  • PerUserZip: um ficheiro ZIP para cada utilizador. Cada ficheiro ZIP contém os ficheiros exportados para o utilizador.
  • SingleZip: um ficheiro ZIP para todos os utilizadores. O ficheiro ZIP contém todos os ficheiros exportados de todos os utilizadores. Esta definição de saída só está disponível no PowerShell.

Para especificar o formato dos resultados da pesquisa do Exchange, utilize 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.

Nota: depois de 26 de maio de 2025, este parâmetro já não está funcional. Para obter mais informações, veja Alterações futuras ao Descoberta Eletrônica do Microsoft Purview.

{{ Fill ShareRootPath Description }}

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, Conformidade & de Segurança

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, Conformidade & de Segurança

A opção WhatIf não funciona no PowerShell de Segurança e Conformidade.

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.

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 suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.