Compartilhar via


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 ou outro ambiente.

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.

Syntax

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 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 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 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-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

O parâmetro AllowNotFoundExchangeLocationsEnabled especifica se deve incluir caixas de correio diferentes das caixas de correio de usuário regulares na pesquisa de conformidade. Os valores válidos são:

  • $true: a pesquisa não tenta validar a existência da caixa de correio antes de prosseguir. Esse valor será necessário se você quiser pesquisar caixas de correio que não são resolvidas como caixas de correio regulares.
  • $false: a pesquisa tenta validar a existência da caixa de correio antes de prosseguir. Se você especificar uma caixa de correio que não seja uma caixa de correio de usuário regular, a pesquisa falhará. Esse é o valor padrão.

Os tipos de caixa de correio afetados pelo valor deste parâmetro incluem:

  • Caixas de correio inativas
  • Usuários sem licença de Exchange Online que usam aplicativos do Office
  • Microsoft 365 usuários convidados
  • Usuários locais cuja identidade é sincronizada com sua organização Microsoft 365
Type:Boolean
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

-Case

Esse parâmetro só está disponível no serviço baseado em nuvem.

O parâmetro Case especifica o nome de um caso standard de descoberta eletrônica para 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ê usa o parâmetro Case.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to: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

-ContentMatchQuery

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 KQL (Linguagem de Consulta de Palavra-Chave) e consultas de palavra-chave e condições de pesquisa para descoberta eletrônica.

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

-Description

O parâmetro Description especifica uma descrição opcional para a pesquisa de conformidade. Se o valor contiver espaços, coloque-o entre aspas.

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

-ExchangeLocation

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 regular. Incluir outros tipos de caixas de correio (por exemplo, caixas de correio inativas ou Microsoft 365 usuários convidados) é controlado pelo parâmetro AllowNotFoundExchangeLocationsEnabled.
  • Uma caixa de correio
  • O valor All 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.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Security & Compliance

-ExchangeLocationExclusion

Esse parâmetro é funcional apenas no Exchange local.

Esse parâmetro especifica as caixas de correio a serem excluídas quando você usa o valor Todos 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.

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

-HoldNames

Esse parâmetro só está disponível no serviço baseado em nuvem.

O parâmetro HoldNames especifica que os locais de conteúdo que foram colocados em retenção no caso de Descoberta Eletrônica especificado serã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 caso de retenção baseado em consulta, somente os itens que estão no bloqueio serão pesquisados quando você executar a 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.

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

-IncludeOrgContent

{{ Fill IncludeOrgContent Description }}

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

-IncludeUserAppContent

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 Microsoft 365 em sua organização. Esses tipos de usuários incluem usuários sem uma licença Exchange Online que usam aplicativos do Office, Microsoft 365 usuários convidados e usuários locais cuja identidade é sincronizada com sua organização 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 será incluído na pesquisa. Se você usar o valor All para o parâmetro ExchangeLocation, o local de armazenamento baseado em nuvem para qualquer usuário convidado ou 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 será incluído na pesquisa. 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

-Language

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 Microsoft .NET Framework CultureInfo. Por exemplo, da-DK para dinamarquês ou ja-JP para japonês. Para obter mais informações, consulte Classe CultureInfo.

Type:CultureInfo
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

-LogLevel

Este parâmetro está disponível somente no Exchange local.

Esse parâmetro está reservado para uso interno da Microsoft.

Type:ComplianceJobLogLevel
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019

-Name

O parâmetro Name 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ê usa o parâmetro Case.

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

-PublicFolderLocation

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.

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

-RefinerNames

Esse parâmetro só está disponível no serviço baseado em nuvem.

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:Security & Compliance

-SharePointLocation

Esse parâmetro só está disponível no serviço baseado em nuvem.

O parâmetro SharePointLocation especifica os sites do SharePoint Online 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".

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

-SharePointLocationExclusion

Esse parâmetro só está disponível no serviço baseado em nuvem.

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:Security & Compliance

-StatusMailRecipients

Este parâmetro está disponível somente no Exchange local.

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

-WhatIf

Esse parâmetro está reservado para uso interno da Microsoft.

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