Get-MailboxSearch
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 Get-MailboxSearch para exibir pesquisas de caixa de correio que estão em andamento, concluídas ou interrompidas.
Observação: a partir de outubro de 2020, os cmdlets *-MailboxSearch foram desativados no PowerShell do Exchange Online. Em vez disso, use os cmdlets *-ComplianceSearch no PowerShell de Segurança & Conformidade. Para obter mais informações, consulte Desativação de ferramentas de descoberta eletrônica herdadas.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Sintaxe
SearchObjectIdentity
Get-MailboxSearch
[[-Identity] <SearchObjectIdParameter>]
[-DomainController <Fqdn>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
EwsStoreObjectIdentity
Get-MailboxSearch
[[-Identity] <EwsStoreObjectIdParameter>]
[-ShowDeletionInProgressSearches]
[-DomainController <Fqdn>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
InPlaceHoldIdentity
Get-MailboxSearch
-InPlaceHoldIdentity <String>
[-ShowDeletionInProgressSearches]
[-DomainController <Fqdn>]
[-ResultSize <Unlimited>]
[<CommonParameters>]
Description
No Exchange local, uma pesquisa de caixa de correio é usada para executar uma Descoberta Eletrônica In-Place ou para colocar os usuários em uma Retenção In-Place. Use o cmdlet Get-MailboxSearch para recuperar detalhes de um tipo de pesquisa de caixa de correio.
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.
Exemplos
Exemplo 1
Get-MailboxSearch -ResultSize "unlimited"
Este exemplo recupera uma lista de todas as pesquisas de caixas de correio.
Exemplo 2
Get-MailboxSearch "Project Hamilton" | Format-List
Este exemplo recupera todas as propriedades da pesquisa de caixa de correio Project Hamilton.
O parâmetro Identity é posicional, o que significa que você pode usá-lo sem o rótulo -Identity no local com suporte no comando (neste caso, primeiro). Para obter mais informações sobre parâmetros posicionais, consulte Sobre parâmetros.
Exemplo 3
(Get-Mailbox Mark).InPlaceHolds
Get-MailboxSearch -InPlaceHoldIdentity 9953d0f0fd03415e949d4b41c5a28cbb
Este exemplo recupera o bloqueio local em que um usuário é colocado. O primeiro comando gera GUIDs de In-Place Bloqueios. O último comando recupera uma pesquisa de caixa de correio com base no GUID da retenção de In-Place em que o usuário é colocado.
Parâmetros
-DomainController
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
Este parâmetro está disponível somente no Exchange local.
O parâmetro DomainController especifica o controlador de domínio que é usado por esse cmdlet para ler dados ou gravar dados no Active Directory. Você identifica o controlador de domínio por seu FQDN (nome de domínio totalmente qualificado). Por exemplo, dc01.contoso.com.
Propriedades do parâmetro
| Tipo: | Fqdn |
| 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 |
-Identity
Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
O parâmetro Identity especifica o nome da consulta de pesquisa. Se um nome não for fornecido, todas as consultas de pesquisa de caixa de correio serão retornadas.
Para melhorar o desempenho desse cmdlet no Exchange Online, algumas propriedades de pesquisa de caixa de correio não serão retornadas se você não especificar o nome de uma pesquisa de caixa de correio. Essas propriedades são:
- SourceMailboxes
- Fontes
- SearchQuery
- ResultadosLink
- PreviewResultsLink
- Erros
Para ver essas propriedades, é necessário fornecer o nome de uma pesquisa de caixa de correio.
Cuidado: O valor $null ou um valor inexistente para o parâmetro Identity retorna todos os objetos como se você tivesse executado o comando Get- sem o parâmetro Identity. Verifique se todas as listas de valores para o parâmetro Identity são precisas e não contêm valores de $null inexistentes.
Propriedades do parâmetro
| Tipo: | SearchObjectIdParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
EwsStoreObjectIdentity
| Cargo: | 1 |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
SearchObjectIdentity
| Cargo: | 1 |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-InPlaceHoldIdentity
Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
O parâmetro InPlaceHoldIdentity especifica a GUID de um Bloqueio Local. Use esse parâmetro para pesquisar por um Bloqueio Local em que o usuário tenha sido colocado. As GUIDs de todos os Bloqueios In-loco em que um usuário é colocado são adicionadas à propriedade InPlaceHolds do usuário. Você pode recuperar a propriedade, usando o cmdlet Get-Mailbox.
Propriedades do parâmetro
| Tipo: | String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
InPlaceHoldIdentity
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-ResultSize
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
O parâmetro ResultSize especifica o número máximo de resultados a serem retornados. Caso pretenda retornar todas as solicitações correspondentes à consulta, use unlimited como valor desse parâmetro. O valor padrão é 1000.
Propriedades do parâmetro
| Tipo: | Unlimited |
| 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 |
-ShowDeletionInProgressSearches
Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online
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 |
Conjuntos de parâmetros
EwsStoreObjectIdentity
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
InPlaceHoldIdentity
| 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.
Entradas
Input types
Para ver os tipos de entrada que este cmdlet aceita, confira Tipos de entrada e saída de cmdlet. Se o campo Tipo de Entrada de um cmdlet estiver em branco, isso significa que o cmdlet não aceita dados de entrada.
Saídas
Output types
Para ver os tipos de retorno, também conhecidos como tipos de saída, que este cmdlet aceita, consulte Tipos de entrada e saída de cmdlet. Se o campo Tipo de Saída estiver em branco, o cmdlet não retorna dados.