Compartilhar via


Set-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 Set-ComplianceSearch para modificar pesquisas de conformidade não em execução no Exchange Server 2016 ou posterior e no portal de conformidade do Microsoft Purview.

Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.

Syntax

Set-ComplianceSearch
   [-Identity] <ComplianceSearchIdParameter>
   [-AddExchangeLocation <String[]>]
   [-AddExchangeLocationExclusion <String[]>]
   [-AddSharePointLocation <String[]>]
   [-AddSharePointLocationExclusion <String[]>]
   [-AllowNotFoundExchangeLocationsEnabled <Boolean>]
   [-Confirm]
   [-ContentMatchQuery <String>]
   [-Description <String>]
   [-ExchangeLocation <String[]>]
   [-ExchangeLocationExclusion <String[]>]
   [-Force]
   [-HoldNames <String[]>]
   [-IncludeOrgContent <Boolean>]
   [-IncludeUserAppContent <Boolean>]
   [-Language <CultureInfo>]
   [-Name <String>]
   [-PublicFolderLocation <String[]>]
   [-RefinerNames <String[]>]
   [-RemoveExchangeLocation <String[]>]
   [-RemoveExchangeLocationExclusion <String[]>]
   [-RemovePublicFolderLocation <String[]>]
   [-RemoveSharePointLocation <String[]>]
   [-RemoveSharePointLocationExclusion <String[]>]
   [-SharePointLocation <String[]>]
   [-SharePointLocationExclusion <String[]>]
   [-WhatIf]
   [<CommonParameters>]

Description

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

Set-ComplianceSearch -Identity "Project X" -ExchangeLocation All

Este exemplo altera a pesquisa de conformidade existente chamada Project X. O escopo da pesquisa do Exchange é alterado para todas as caixas de correio.

Exemplo 2

Set-ComplianceSearch -Identity "Contoso Case Search 1" -HoldNames All -ExchangeLocation $null -SharePointLocation $null

Este exemplo altera uma pesquisa de conformidade existente associada a um caso de descoberta eletrônica no portal de conformidade do Microsoft Purview. O escopo da pesquisa é alterado de pesquisar caixas de correio selecionadas e sites do SharePoint para pesquisar todos os locais de conteúdo que foram colocados em espera no caso de descoberta eletrônica.

Exemplo 3

Set-ComplianceSearch -Identity "China Subsidiary Search" -Language zh-CN

Este exemplo altera a configuração de idioma para uma pesquisa de conformidade existente em chinês.

Talvez você precise alterar a configuração do idioma se estiver usando palavras-chave não inglesas na consulta de pesquisa (que é especificada no parâmetro ContentMatchQuery).

Parâmetros

-AddExchangeLocation

O parâmetro AddExchangeLocation especifica as caixas de correio a serem adicionadas à lista de caixas de correio incluídas quando você não estiver usando o valor All para o parâmetro ExchangeLocation. 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

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

-AddExchangeLocationExclusion

Esse parâmetro é funcional apenas no Exchange local.

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

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

-AddSharePointLocation

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

O parâmetro AddSharePointLocation especifica os sites do SharePoint Online a serem adicionados à lista de sites incluídos quando você não estiver usando o valor All para o parâmetro SharePointLocation. Você pode identificar o site pelo valor da URL.

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

-AddSharePointLocationExclusion

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

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

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

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

  • 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

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 espera no caso de descoberta eletrônica serão pesquisados. Use o valor All para esse parâmetro. Você pode usar esse parâmetro somente para pesquisas de conformidade que estão associadas a um caso de Descoberta Eletrônica.

Se os locais de conteúdo na pesquisa de conformidade incluirem caixas de correio, você também precisará usar o parâmetro ExchangeLocation com o valor $null. Da mesma forma, se a pesquisa de conformidade incluir sites do SharePoint, você também precisará usar o parâmetro SharePointLocation com o valor $null.

Além disso, se um local de conteúdo tiver sido colocado em um caso de retenção baseado em consulta, somente os itens que estão no bloqueio serão pesquisados quando você reiniciar 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.

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

-Identity

O parâmetro Identity especifica a pesquisa de conformidade que você deseja modificar.

Quando você usa esse parâmetro, o parâmetro Identity é obrigatório, mas o valor será ignorado. Por exemplo, use o valor 000 para o parâmetro Identity.

  • Nome
  • JobRunId (GUID)

JobRunId (GUID)

Type:ComplianceSearchIdParameter
Position:1
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, 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 em qualquer um dos parâmetros de localização do Exchange 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

-Name

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

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

-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

-RemoveExchangeLocation

O parâmetro RemoveExchangeLocation especifica as caixas de correio a serem removidas da lista de caixas de correio incluídas quando você não estiver usando o valor All para o parâmetro ExchangeLocation. Os valores válidos são:

  • Este parâmetro especifica as caixas de correio a serem removidas da lista de caixas de correio excluídas quando você usa o valor All para o parâmetro ExchangeLocation. 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

-RemoveExchangeLocationExclusion

Esse parâmetro é funcional apenas no Exchange local.

Esse parâmetro especifica as caixas de correio a serem removidas da lista de caixas de correio excluídas quando você usa o valor All para o parâmetro ExchangeLocation. Os valores válidos são:

  • Este parâmetro especifica as caixas de correio a serem removidas da lista de caixas de correio excluídas quando você usa o valor All para o parâmetro ExchangeLocation. 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

-RemovePublicFolderLocation

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

-RemoveSharePointLocation

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

O parâmetro RemoveSharePointLocation especifica os sites do SharePoint Online a serem removidos da lista de sites incluídos quando você não estiver usando o valor All para o parâmetro SharePointLocation. Você pode identificar o site pelo valor da URL.

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

-RemoveSharePointLocationExclusion

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

-WhatIf

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

A opção WhatIf simula as ações do comando. Você pode usar essa opção para exibir as alterações que ocorreriam sem realmente aplicar essas alterações. Não é preciso especificar um valor com essa opção.

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Security & Compliance