New-ComplianceSearch
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-ComplianceSearch para criar pesquisas de conformidade no Exchange Server 2016 ou posterior e no portal de conformidade do Microsoft Purview. Você pode usar esse cmdlet para definir os critérios de pesquisa.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Observação
Na nuvem, esse cmdlet tem os seguintes requisitos:
- Versão 3.9.0 ou posterior do módulo do PowerShell do Exchange Online (agosto de 2025).
- Use o parâmetro EnableSearchOnlySession ao executar o comando Connect-IPPSSession para se conectar ao PowerShell de Segurança & Conformidade.
Sintaxe
Default (Default)
New-ComplianceSearch
[-Name] <String>
[-AllowNotFoundExchangeLocationsEnabled <Boolean>]
[-Case <String>]
[-Confirm]
[-ContentMatchQuery <String>]
[-Description <String>]
[-ExchangeLocation <String[]>]
[-ExchangeLocationExclusion <String[]>]
[-Force]
[-HoldNames <String[]>]
[-IncludeOrgContent <Boolean>]
[-IncludeUserAppContent <Boolean>]
[-Language <CultureInfo>]
[-LogLevel <ComplianceJobLogLevel>]
[-PublicFolderLocation <String[]>]
[-RefinerNames <String[]>]
[-SharePointLocation <String[]>]
[-SharePointLocationExclusion <String[]>]
[-StatusMailRecipients <String[]>]
[-WhatIf]
[<CommonParameters>]
Description
Uma pesquisa de conformidade exige pelo menos um local. Por exemplo, caixas de correio usando o parâmetro ExchangeLocation ou sites do SharePoint usando o parâmetro SharePointLocation.
Depois de criar uma pesquisa de conformidade usando o cmdlet New-ComplianceSearch, execute a pesquisa usando o cmdlet Start-ComplianceSearch.
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 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 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.
Exemplos
Exemplo 1
New-ComplianceSearch -Name "Hold Project X" -ExchangeLocation "Finance Department"
Este exemplo cria uma nova pesquisa de conformidade chamada Hold-Project X que pesquisa todos os membros do grupo de distribuição chamado Departamento Financeiro. Como a pesquisa não usa o parâmetro ContentMatchQuery, a pesquisa é realizada em todos os itens das caixas de correio.
Exemplo 2
New-ComplianceSearch -Name "Hold-Tailspin Toys" -ExchangeLocation "Research Department" -ContentMatchQuery "'Patent' AND 'Project Tailspin Toys'"
Este exemplo cria uma nova pesquisa de conformidade chamada Hold-Tailspin Toys que pesquisa todos os membros do grupo de distribuição chamado Departamento de Pesquisa. Como a pesquisa usa o parâmetro ContentMatchQuery, a pesquisa é realizada apenas nas mensagens que correspondam à consulta.
Exemplo 3
New-ComplianceSearch -Name "AnnBeebe-InactiveMailbox" -ExchangeLocation .annb@contoso.onmicrosoft.com -AllowNotFoundExchangeLocationsEnabled $true
Este exemplo cria uma nova pesquisa de conformidade chamada AnnBeebe-InactiveMailbox, que procura uma caixa de correio inativa e retorna todos os itens na caixa de correio. Para procurar por caixas de correio inativas, você precisa usar o endereço SMTP principal da caixa de correio inativa, precedido por um ponto (".") Você também precisa incluir o parâmetro AllowNotFoundExchangeLocationsEnabled para que a pesquisa não tente validar a existência da caixa de correio inativa.
Parâmetros
-AllowNotFoundExchangeLocationsEnabled
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
O parâmetro AllowNotFoundExchangeLocationsEnabled especifica se as caixas de correio devem ser incluídas na pesquisa de conformidade com caixas de correio diferentes das caixas de correio normais do usuário. Os valores válidos são:
- $true: A pesquisa não tenta validar a existência da caixa de correio antes de continuar. Esse valor será necessário se você quiser pesquisar caixas de correio que não resolvem como caixas de correio normais.
- $false: A pesquisa tenta validar a existência da caixa de correio antes de continuar. Se você especificar uma caixa de correio que não seja uma caixa de correio de usuário comum, a pesquisa falhará. Esse valor é o padrão.
Os tipos de caixa de correio afetados pelo valor desse parâmetro incluem:
- Caixas de correio inativas
- Usuários sem uma licença do Exchange Online que usam aplicativos do Office
- Usuários convidados do Microsoft 365
- Usuários locais cuja identidade é sincronizada com sua organização do Microsoft 365
Propriedades do parâmetro
| Tipo: | Boolean |
| 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 |
-Case
Aplicável: Segurança & Conformidade
Esse parâmetro só está disponível no serviço baseado em nuvem.
O parâmetro Case especifica o nome de um caso do eDiscovery Standard ao qual associar a nova pesquisa de conformidade. Se o valor contiver espaços, coloque-o entre aspas.
Você não pode usar esse parâmetro para criar pesquisas de conformidade associadas a casos Premium de Descoberta Eletrônica.
Se o parâmetro Name contiver espaços, o valor do parâmetro ExchangeLocation será limpo quando você usar o parâmetro Case.
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 |
-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.
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 |
-ContentMatchQuery
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
O parâmetro ContentMatchQuery especifica um filtro de pesquisa de conteúdo.
Este parâmetro usa a cadeia de caracteres de pesquisa de texto ou uma consulta formatada através do uso da linguagem de consulta de palavra-chave (KQL). Para obter mais informações, consulte Referência de sintaxe QL por palavra-chave (KQL) e Consultas de palavra-chave e condições de pesquisa para descoberta eletrônica.
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 |
-Description
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
O parâmetro Description especifica uma descrição opcional para a pesquisa de conformidade. Se o valor contiver espaços, coloque-o entre aspas.
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 |
-ExchangeLocation
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
O parâmetro ExchangeLocation especifica as caixas de correio a serem incluídas. Os valores válidos são:
- Uma caixa de correio de usuário normal. A inclusão de outros tipos de caixas de correio (por exemplo, caixas de correio inativas ou usuários convidados do Microsoft 365) é controlada pelo parâmetro AllowNotFoundExchangeLocationsEnabled.
- Uma caixa de correio
- O valor Todas para todas as caixas de correio. Você só pode usar esse valor sozinho.
Para especificar uma caixa de correio ou grupo de distribuição, use o endereço de email. 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
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-ExchangeLocationExclusion
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
Este parâmetro só é funcional no Exchange local.
Esse parâmetro especifica as caixas de correio a serem excluídas quando você usa o valor All para o parâmetro ExchangeLocation. Os valores válidos são:
- O parâmetro ExchangeLocation especifica as caixas de correio que devem ser incluídas na política. Os valores válidos são:
- Uma caixa de correio
Para especificar uma caixa de correio ou grupo de distribuição, use o endereço de email. 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
(All)
| 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 |
-HoldNames
Aplicável: Segurança & Conformidade
Esse parâmetro só está disponível no serviço baseado em nuvem.
O parâmetro HoldNames especifica que os locais de conteúdo colocados em espera no caso de Descoberta Eletrônica especificado são pesquisados. Use o valor All para esse parâmetro. Você também precisa especificar o nome de um caso de Descoberta Eletrônica usando o parâmetro Case.
Além disso, se um local de conteúdo foi colocado em um bloqueio de caso baseado em consulta, somente os itens que estiverem em espera serão pesquisados quando você executar essa pesquisa de conformidade. Por exemplo, se um usuário foi colocado em um caso de retenção baseado em consulta que preserva os itens que foram enviados ou criados antes de uma data específica, somente esses itens serão pesquisados usando os critérios de pesquisa especificados por essa pesquisa de conformidade.
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 |
-IncludeOrgContent
Aplicável: Segurança & Conformidade
{{ Preencher IncludeOrgContent Description }}
Propriedades do parâmetro
| Tipo: | Boolean |
| 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 |
-IncludeUserAppContent
Aplicável: Segurança & Conformidade
Esse parâmetro só está disponível no serviço baseado em nuvem.
O parâmetro IncludeUserAppContent especifica que você deseja pesquisar o local de armazenamento baseado em nuvem para usuários que não têm uma conta de usuário regular do Microsoft 365 em sua organização. Esses tipos de usuários incluem usuários sem uma licença do Exchange Online que usam aplicativos do Office, usuários convidados do Microsoft 365 e usuários locais cuja identidade está sincronizada com sua organização do Microsoft 365. Os valores válidos são:
- $true: O local de armazenamento baseado em nuvem para os usuários especificados no parâmetro ExchangeLocation está incluído na pesquisa. Se você usar o valor All para o parâmetro ExchangeLocation, o local de armazenamento baseado em nuvem para qualquer convidado ou usuário local será incluído na pesquisa.
- $false: o local de armazenamento baseado em nuvem para os usuários especificados no parâmetro ExchangeLocation não está incluído na pesquisa. 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
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Language
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
O parâmetro Language especifica o idioma da pesquisa de conformidade.
A entrada válida para esse parâmetro é um valor de código de cultura com suporte da classe CultureInfo do Microsoft .NET Framework. Por exemplo, da-DK para dinamarquês ou ja-JP para japonês. Para obter mais informações, consulte Classe CultureInfo.
Propriedades do parâmetro
| Tipo: | CultureInfo |
| 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 |
-LogLevel
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Este parâmetro está disponível somente no Exchange local.
Esse parâmetro está reservado para uso interno da Microsoft.
Propriedades do parâmetro
| Tipo: | ComplianceJobLogLevel |
| 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 |
-Name
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Segurança & Conformidade
O parâmetro Nome especifica o nome da pesquisa de conformidade. Se o valor contiver espaços, coloque-o entre aspas.
Não use espaços no valor desse parâmetro se você planeja usar o parâmetro Case. Se o parâmetro Name contiver espaços, o valor do parâmetro ExchangeLocation será limpo quando você usar o parâmetro Case.
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 |
-PublicFolderLocation
Aplicável: Segurança & Conformidade
Esse parâmetro só está disponível no serviço baseado em nuvem.
O parâmetro PublicFolderLocation especifica que você deseja incluir todas as pastas públicas na pesquisa. Use o valor All para esse parâmetro.
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 |
-RefinerNames
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: | 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 |
-SharePointLocation
Aplicável: Segurança & Conformidade
Esse parâmetro só está disponível no serviço baseado em nuvem.
O parâmetro SharePointLocation especifica os sites do SharePoint a serem incluídos. Identifique o site pelo respectivo valor de URL ou use o valor All para incluir todos os sites.
Update Se os valores contiverem espaços ou exigirem aspas, use a seguinte sintaxe: "Value1","Value2",..."ValueN".
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 |
-SharePointLocationExclusion
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: | 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 |
-StatusMailRecipients
Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Este parâmetro está disponível somente no Exchange local.
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
Esse parâmetro está reservado para uso interno da Microsoft.
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.