Operação GetSearchableMailboxesGetSearchableMailboxes operation

Importante

A partir de 1º de abril de 2020, a operação GetSearchableMailboxes não estará mais disponível no Exchange Online.Starting on April 1, 2020, the GetSearchableMailboxes operation will no longer be available in Exchange Online. Essa operação não será afetada nas versões locais do Exchange Server.This operation won't be affected in on-premises versions of Exchange Server. Para obter mais informações, consulte aposentadoria of Legacy eDiscovery Tools in Exchange Online.For more information, see Retirement of legacy eDiscovery tools in Exchange Online.

Encontre informações sobre a operação do EWS do GetSearchableMailboxes .Find information about the GetSearchableMailboxes EWS operation.

A operação GetSearchableMailboxes Obtém um conjunto com escopo de caixas de correio pesquisáveis para pesquisas de descoberta.The GetSearchableMailboxes operation gets a scoped set of searchable mailboxes for discovery searches. O escopo das caixas de correio que podem ser pesquisadas retornadas na resposta é determinado pelo filtro de pesquisa e se a associação do grupo de distribuição está expandida.The scope of searchable mailboxes returned in the response is determined by the search filter and whether distribution group membership is expanded.

Observação

Esta operação deve ser usada com o filtro de pesquisa e para recuperar apenas as primeiras milhares; Não se destina à recuperação exaustiva.This operation is intended to be used with the search filter and to retrieve only the first few thousands; it's not intended for exhaustive retrieval.

This operation was introduced in Exchange Server 2013.This operation was introduced in Exchange Server 2013.

Usando a operação GetSearchableMailboxesUsing the GetSearchableMailboxes operation

A operação GetSearchableMailboxes Obtém informações sobre caixas de correio pesquisáveis.The GetSearchableMailboxes operation gets information about searchable mailboxes. Os seguintes argumentos podem ser passados na solicitação:The following arguments can be passed in the request:

  • SearchFilter -aceita um único alias de email como um argumento.SearchFilter - Accepts a single email alias as an argument.

  • ExpandGroupMembership -indica se a associação do grupo de distribuição está expandida nos resultados retornados na resposta.ExpandGroupMembership - Indicates whether the distribution group membership is expanded in the results returned in the response.

Se o alias de email definido no filtro de pesquisa for um grupo de distribuição e a associação do grupo de distribuição não for expandida, a resposta conterá as informações de caixa de correio para o grupo de distribuição.If the email alias set in the search filter is a distribution group and the distribution group membership is not expanded, the response will contain the mailbox information for the distribution group. Se o alias de email definido no filtro de pesquisa for um grupo de distribuição e a associação do grupo de distribuição for expandida, a resposta conterá as informações de caixa de correio para cada caixa de correio que seja membro do grupo de distribuição.If the email alias set in the search filter is a distribution group and the distribution group membership is expanded, the response will contain the mailbox information for each mailbox that is a member of the distribution group. Se o filtro de pesquisa contiver um alias de usuário único, a resposta conterá as informações de caixa de correio para o único usuário.If the search filter contains a single user's alias, the response will contain the mailbox information for the single user. A resposta conterá todas as caixas de correio que poderão ser pesquisadas se o elemento GetSearchableMailboxes estiver vazio.The response will contain all searchable mailboxes if the GetSearchableMailboxes element is empty. Isso é o mesmo que ter um elemento SearchFilter vazio e o elemento ExpandGroupMembership definido como false.This is the same as having an empty SearchFilter element and the ExpandGroupMembership element set to false.

Cabeçalhos SOAP de operação GetSearchableMailboxesGetSearchableMailboxes operation SOAP headers

A operação GetSearchableMailboxes pode usar os cabeçalhos SOAP listados na tabela a seguir.The GetSearchableMailboxes operation can use the SOAP headers that are listed in the following table.

Nome de cabeçalhoHeader name ElementoElement DescriçãoDescription
ManagementRoleManagementRole
ManagementRoleManagementRole
Identifica as funções de servidor necessárias para que o chamador faça a solicitação.Identifies the server roles that are necessary in order for the caller to make the request. Este cabeçalho é aplicável a uma solicitação.This header is applicable to a request.
RequestVersionRequestVersion
RequestServerVersionRequestServerVersion
Identifica a versão do esquema para a solicitação de operação.Identifies the schema version for the operation request. Este cabeçalho é aplicável a uma solicitação.This header is applicable to a request.
ServerVersionServerVersion
ServerVersionInfoServerVersionInfo
Identifica a versão do servidor que respondeu à solicitação.Identifies the version of the server that responded to the request. Este cabeçalho é aplicável a uma resposta.This header is applicable to a response.

Exemplo de solicitação de operação GetSearchableMailboxes: solicitar informações sobre um grupo de distribuiçãoGetSearchableMailboxes operation request example: Request information about a distribution group

O exemplo a seguir de uma solicitação de operação GetSearchableMailboxes mostra como obter as informações de caixa de correio para o grupo de distribuição lolgroup.The following example of a GetSearchableMailboxes operation request shows how to get the mailbox information for the lolgroup distribution group.

<?xml version="1.0" encoding="UTF-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
               xmlns:t="https://schemas.microsoft.com/exchange/services/2006/types"
               xmlns:m="https://schemas.microsoft.com/exchange/services/2006/messages">
   <soap:Header>
      <t:RequestServerVersion Version="Exchange2013" />
   </soap:Header>
   <soap:Body >
      <m:GetSearchableMailboxes>
         <m:SearchFilter>lolgroup</m:SearchFilter>
         <m:ExpandGroupMembership>false</m:ExpandGroupMembership>
      </m:GetSearchableMailboxes>
   </soap:Body>
</soap:Envelope>

O corpo SOAP de solicitação contém os seguintes elementos:The request SOAP body contains the following elements:

Resposta de operação GetSearchableMailboxes bem-sucedida: obter informações sobre um grupo de distribuiçãoSuccessful GetSearchableMailboxes operation response: Get information about a distribution group

O exemplo a seguir mostra uma resposta bem-sucedida a uma solicitação de operação GetSearchableMailboxes para obter as informações de descoberta para o grupo de distribuição lolgroup.The following example shows a successful response to a GetSearchableMailboxes operation request to get the discovery information for the lolgroup distribution group.

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <h:ServerVersionInfo MajorVersion="15" 
                           MinorVersion="0" 
                           MajorBuildNumber="526" 
                           MinorBuildNumber="0" 
                           Version="Exchange2013" 
                           xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
                           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
           xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <GetSearchableMailboxesResponse ResponseClass="Success" 
                                      xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
         <ResponseCode>NoError</ResponseCode>
         <SearchableMailboxes>
            <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
               <Guid>33a408fe-2574-4e3b-49f5-5e1e000a3035</Guid>
               <PrimarySmtpAddress>LOLgroup@contoso.com</PrimarySmtpAddress>
               <IsExternalMailbox>false</IsExternalMailbox>
               <ExternalEmailAddress/>
               <DisplayName>LOLgroup</DisplayName>
               <IsMembershipGroup>true</IsMembershipGroup>
               <ReferenceId>/o=First/ou=Exchange(FYLT)/cn=Recipients/cn=81213b958a0b5295b13b3f02b812bf1bc-LOLgroup</ReferenceId>
            </SearchableMailbox>
         </SearchableMailboxes>
      </GetSearchableMailboxesResponse>
   </s:Body>
</s:Envelope>

O corpo SOAP de resposta contém os seguintes elementos:The response SOAP body contains the following elements:

Resposta de operação GetSearchableMailboxes bem-sucedida: obter informações sobre um grupo de distribuição expandidoSuccessful GetSearchableMailboxes operation response: Get information about an expanded distribution group

O exemplo a seguir mostra uma resposta bem-sucedida a uma solicitação de operação GetSearchableMailboxes para obter as informações de descoberta sobre os membros do grupo de distribuição lolgroup expandido.The following example shows a successful response to a GetSearchableMailboxes operation request to get the discovery information about members of the expanded lolgroup distribution group.

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Header>
    <h:ServerVersionInfo MajorVersion="15" MinorVersion="0" MajorBuildNumber="526" MinorBuildNumber="0" Version="Exchange2013" xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types" xmlns="https://schemas.microsoft.com/exchange/services/2006/types" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  </s:Header>
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <GetSearchableMailboxesResponse ResponseClass="Success" xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
      <ResponseCode>NoError</ResponseCode>
      <SearchableMailboxes>
        <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
          <Guid>e2d42cdf-a227-1ec3-486b-6fa0ebaadb9f5</Guid>
          <PrimarySmtpAddress>JSmith@contoso.com</PrimarySmtpAddress>
          <IsExternalMailbox>false</IsExternalMailbox>
          <ExternalEmailAddress/>
          <DisplayName>Julia Smith</DisplayName>
          <IsMembershipGroup>false</IsMembershipGroup>
          <ReferenceId>/o=First Organization/ou=Exchange Administrative Group (FYDLT)/cn=Recipients/cn=0a1fc86f883846152405d60956dd02e7-Julia</ReferenceId>
        </SearchableMailbox>
        <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
          <Guid>45d0fff1-6541-459a-a343-52453b30e12ca</Guid>
          <PrimarySmtpAddress>LMoore@contoso.com</PrimarySmtpAddress>
          <IsExternalMailbox>false</IsExternalMailbox>
          <ExternalEmailAddress/>
          <DisplayName>Laura Moore</DisplayName>
          <IsMembershipGroup>false</IsMembershipGroup>
          <ReferenceId>/o=First Organization/ou=Exchange Administrative Group (FYDLT)/cn=Recipients/cn=2910d8f8316f4378bbf9338d8f9d714b-Laura</ReferenceId>
        </SearchableMailbox>
        <SearchableMailbox xmlns="https://schemas.microsoft.com/exchange/services/2006/types">
          <Guid>3c620d04-8b33-435a-95be-5b939375576</Guid>
          <PrimarySmtpAddress>SBrown@contoso.com</PrimarySmtpAddress>
          <IsExternalMailbox>false</IsExternalMailbox>
          <ExternalEmailAddress/>
          <DisplayName>Steven Brown</DisplayName>
          <IsMembershipGroup>false</IsMembershipGroup>
          <ReferenceId>/o=First Organization/ou=Exchange Administrative Group (FYDLT)/cn=Recipients/cn=90312341a742f0e47e392c80a60d13ecf-Steve</ReferenceId>
        </SearchableMailbox>
      </SearchableMailboxes>
    </GetSearchableMailboxesResponse>
  </s:Body>
</s:Envelope>

O corpo SOAP de resposta contém os seguintes elementos:The response SOAP body contains the following elements:

Resposta de erro de operação GetSearchableMailboxesGetSearchableMailboxes operation error response

O exemplo a seguir mostra uma resposta de erro a uma solicitação de operação GetSearchableMailboxes .The following example shows an error response to a GetSearchableMailboxes operation request. Esta é uma resposta a uma solicitação para obter todas as caixas de correio pesquisáveis quando o argumento ExpandGroupMembership estiver definido como true.This is a response to a request to get all searchable mailboxes when the ExpandGroupMembership argument is set to true.

<?xml version="1.0" encoding="utf-8"?>
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Header>
      <h:ServerVersionInfo MajorVersion="15" 
                           MinorVersion="0" 
                           MajorBuildNumber="526"
                           MinorBuildNumber="0" 
                           Version="Exchange2013" 
                           xmlns:h="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns="https://schemas.microsoft.com/exchange/services/2006/types" 
                           xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
                           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
   </s:Header>
   <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
           xmlns:xsd="http://www.w3.org/2001/XMLSchema">
      <GetSearchableMailboxesResponse ResponseClass="Error" 
                                      xmlns="https://schemas.microsoft.com/exchange/services/2006/messages">
         <MessageText>Cannot use wildcard or empty query when auto group expansion is enabled.</MessageText>
         <ResponseCode>ErrorInvalidArgument</ResponseCode>
         <DescriptiveLinkKey>0</DescriptiveLinkKey>
         <SearchableMailboxes/>
      </GetSearchableMailboxesResponse>
   </s:Body>
</s:Envelope>

O corpo SOAP de resposta de erro contém os seguintes elementos:The error response SOAP body contains the following elements:

Para obter códigos de erro adicionais genéricos para o EWS e específicos para essa operação, consulte ResponseCode.For additional error codes that are generic to EWS and specific to this operation, see ResponseCode.

Confira tambémSee also