Get-Recipient
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 Get-Recipient para ver objetos de destinatários existentes em sua organização. Este cmdlet retorna todos os objetos habilitados para email (por exemplo, caixas de correio, usuários de email, contatos de email e grupos de distribuição).
Observação: em Exchange Online PowerShell, recomendamos que você use o cmdlet Get-EXORecipient em vez desse cmdlet. Para saber mais, confira Conectar-se ao Exchange Online usando o PowerShell Remoto.
Em ambientes de nuvem, para retornar Grupos do Microsoft 365, você precisa usar o parâmetro RecipientTypeDetails com o valor GroupMailbox.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Syntax
Get-Recipient
[-Anr <String>]
[-AuthenticationType <AuthenticationType>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-PropertySet <PropertySet>]
[-ReadFromDomainController]
[-RecipientType <RecipientType[]>]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[-Capabilities <MultiValuedProperty>]
[-Database <DatabaseIdParameter>]
[-Properties <String[]>]
[-IncludeSoftDeletedRecipients]
[<CommonParameters>]Get-Recipient
[[-Identity] <RecipientIdParameter>]
[-AuthenticationType <AuthenticationType>]
[-BookmarkDisplayName <String>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-IncludeBookmarkObject <Boolean>]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-PropertySet <PropertySet>]
[-ReadFromDomainController]
[-RecipientType <RecipientType[]>]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[-Capabilities <MultiValuedProperty>]
[-Properties <String[]>]
[-IncludeSoftDeletedRecipients]
[<CommonParameters>]Get-Recipient
[-Database <DatabaseIdParameter>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-Properties <String[]>]
[-PropertySet <PropertySet>]
[-ReadFromDomainController]
[-RecipientType <RecipientType[]>]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[-IncludeSoftDeletedRecipients] [<CommonParameters>]
[<CommonParameters>]Get-Recipient
[-RecipientPreviewFilter <String>]
[-AuthenticationType <AuthenticationType>]
[-Capabilities <MultiValuedProperty>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-IncludeSoftDeletedRecipients]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-Properties <String[]>]
[-PropertySet <PropertySet>]
[-ReadFromDomainController]
[-RecipientType <RecipientType[]>]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>]Description
O cmdlet Get-Recipient pode não retornar todas as propriedades específicas de um objeto para um destinatário. Para ver as propriedades específicas de um objeto de um destinatário, é necessário usar o cmdlet correspondente baseado no tipo de objeto (por exemplo, Get-Mailbox, Get-MailUser ou Get-DistributionGroup).
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.
Exemplos
Exemplo 1
Get-Recipient -ResultSize unlimitedEste exemplo recupera uma lista de resumo de todos os destinatários em sua organização.
Exemplo 2
Get-Recipient -Identity "Marketing Department" | Format-ListEste exemplo retorna informações detalhadas para o destinatário chamado Departamento de Marketing.
Exemplo 3
Get-Recipient -RecipientType MailContact -SortBy Office | Format-Table -Auto Office,NameEste exemplo recupera as informações sobre os contatos de email em sua organização e os organiza por departamento.
Parâmetros
-Anr
O parâmetro Anr especifica uma cadeia de caracteres na qual executar uma pesquisa ANR (resolução de nomes ambíguos). Você pode especificar uma cadeia de caracteres parcial para objetos com um atributo correspondente a esta cadeia de caracteres. Os atributos padrão pesquisados são:
- CommonName (CN)
- DisplayName
- FirstName
- Sobrenome
- Alias
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-AuthenticationType
Esse parâmetro só está disponível no serviço baseado em nuvem.
O parâmetro AuthenticationType especifica o destinatário por tipo de autenticação. Use um dos valores a seguir:
- Federado
- Gerenciado
| Type: | AuthenticationType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online, Security & Compliance, Exchange Online Protection |
-BookmarkDisplayName
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 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-Capabilities
Esse parâmetro só está disponível no serviço baseado em nuvem.
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online, Security & Compliance, Exchange Online Protection |
-Credential
Este parâmetro está disponível somente no Exchange local.
O parâmetro Credential especifica o nome de usuário e a senha usados para executar esse comando. Normalmente, você usa esse parâmetro em scripts ou quando você precisa fornecer credenciais diferentes que têm as permissões necessárias.
Um valor para esse parâmetro requer o cmdlet Get-Credential. Para pausar o comando e receber uma solicitação de credenciais, use o valor (Get-Credential). Ou, antes de executar esse comando, armazene as credenciais em uma variável (por exemplo, $cred = Get-Credential) e, em seguida, use o nome da variável ($cred) para esse parâmetro. Para saber mais, confira Obter credencial.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Database
Este parâmetro está disponível somente no Exchange local.
O parâmetro Banco de Dados retorna todos os destinatários armazenados no banco de dados de caixa de correio especificado. É possível usar qualquer valor que identifique o banco de dados com exclusividade. Por exemplo:
- Nome
- DN (nome diferenciado)
- GUID
| Type: | DatabaseIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-DomainController
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.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Filter
O parâmetro Filter usa a sintaxe OPATH para filtrar os resultados pelas propriedades e valores especificados. Os critérios de pesquisa usam a sintaxe "Property -ComparisonOperator 'Value'".
- Inclua todo o filtro OPATH nas aspas duplas " ". Se o filtro contiver valores do sistema (por exemplo,
$true,$falseou$null), use aspas individuais ' ' em vez disso. Embora esse parâmetro seja uma cadeia de caracteres (não um bloco do sistema), você também pode usar chaves { }, mas somente se o filtro não contiver variáveis. - A propriedade é uma propriedade filtrada. Para obter mais informações sobre as propriedades filtradas no servidor exchange e Exchange Online, consulte Propriedades filtreáveis para o parâmetro Filter.
- ComparisonOperator é um operador de comparação OPATH (por exemplo
-eq, para iguais e-likepara comparação de cadeia de caracteres). Para obter mais informações sobre operadores de comparação, consulte about_Comparison_Operators. - Valor é o valor da propriedade a ser pesquisado. Inclua valores e variáveis de texto em aspas individuais (
'Value'ou'$Variable'). Se um valor variável contiver aspas individuais, você precisará identificar (escapar) as aspas individuais para expandir a variável corretamente. Por exemplo, em vez de'$User', use'$($User -Replace "'","''")'. Não inclua inteiros ou valores do sistema entre aspas (por exemplo, use500,$true,$falseou$nullem vez disso).
Você pode encadear vários critérios de pesquisa usando os operadores lógicos -and e -or. Por exemplo: "Criteria1 -and Criteria2" ou "(Criteria1 -and Criteria2) -or Criteria3".
Para obter informações detalhadas sobre filtros OPATH no Exchange, consulte Informações adicionais de sintaxe OPATH.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-Identity
O parâmetro Identity especifica o objeto destinatário que você deseja visualizar. É possível usar qualquer valor que identifique o destinatário com exclusividade. Por exemplo:
- Nome
- Alias
- Nome diferenciado (DN)
- Nome diferenciado (DN)
- DN canônico
- GUID
| Type: | RecipientIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-IgnoreDefaultScope
Este parâmetro está disponível somente no Exchange local.
A opção IgnoreDefaultScope informa ao comando para ignorar a configuração de escopo padrão do destinatário para a sessão do Exchange PowerShell e usar toda a floresta como o escopo. Não é preciso especificar um valor com essa opção.
Essa opção permite que o comando acesse objetos do Active Directory que não estão disponíveis no momento no escopo padrão, mas também introduz as seguintes restrições:
- Não é possível usar o parâmetro DomainController. O comando usa um servidor de catálogo global adequado automaticamente.
- Não é possível usar o parâmetro DomainController. O comando usa um servidor de catálogo global adequado automaticamente.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-IncludeBookmarkObject
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-IncludeSoftDeletedRecipients
A opção IncludeSoftDeletedRecipients especifica se deve incluir destinatários excluídos suavemente nos resultados. Não é preciso especificar um valor com essa opção.
Os destinatários excluídos são destinatários excluídos que ainda podem ser recuperados.
Observação: use essa opção com os parâmetros Identity ou RecipientTypeDetails para obter os SoftDeletedRecipients.
| 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, Exchange Online, Exchange Online Protection |
-OrganizationalUnit
O parâmetro OrganizationalUnit filtra os resultados com base na localização do objeto no Active Directory. Somente objetos que existem na localização especificada são retornados. A entrada válida para esse parâmetro é uma OU (unidade organizacional) ou domínio retornado pelo cmdlet Get-OrganizationalUnit. É possível usar qualquer valor que identifique a UO ou o domínio com exclusividade. Por exemplo:
- Nome
- Nome
- Nome diferenciado (DN)
- GUID
| Type: | OrganizationalUnitIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-Properties
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 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-PropertySet
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | PropertySet |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-ReadFromDomainController
Este parâmetro está disponível somente no Exchange local.
A opção ReadFromDomainController especifica se as informações devem ser lidas de um controlador de domínio no domínio do usuário. Não é preciso especificar um valor com essa opção.
O comando: Set-AdServerSettings -ViewEntireForest $true para incluir todos os objetos na floresta requer a opção ReadFromDomainController. Caso contrário, o comando pode usar um catálogo global que contém informações desatualizadas. Além disso, talvez seja necessário executar várias iterações do comando com a opção ReadFromDomainController para obter as informações.
Por padrão, o escopo do destinatário é definido como o domínio que hospeda seus servidores do Exchange.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-RecipientPreviewFilter
O parâmetro RecipientPreviewFilter testa um filtro de destinatário que você usaria em um grupo de distribuição dinâmica, lista de endereços ou política de endereço de email. Esse parâmetro usa a sintaxe de filtro LDAP.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-RecipientType
O parâmetro RecipientType filtra os resultados pelo tipo de destinatário especificado. Os valores válidos são:
- DynamicDistributionGroup
- MailContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- UserMailbox
Vários valores, separados por vírgulas, podem ser especificados.
| Type: | RecipientType[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-RecipientTypeDetails
O parâmetro RecipientTypeDetails filtra os resultados pelo subtipo de destinatário especificado. Os valores válidos são:
- DiscoveryMailbox
- DynamicDistributionGroup
- EquipmentMailbox
- GroupMailbox (Exchange 2013 ou posterior e nuvem)
- GuestMailUser (Exchange 2016 ou posterior e nuvem)
- LegacyMailbox
- LinkedMailbox
- LinkedRoomMailbox (Exchange 2013 ou posterior e nuvem)
- MailContact
- MailForestContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- PublicFolderMailbox (Exchange 2013 ou posterior e nuvem)
- RemoteEquipmentMailbox
- RemoteRoomMailbox
- RemoteSharedMailbox
- RemoteTeamMailbox (Exchange 2013 ou posterior e nuvem)
- RemoteUserMailbox
- RoomList
- RoomMailbox
- SchedulingMailbox (Exchange 2016 ou posterior e nuvem)
- SharedMailbox
- SharedWithMailUser (somente nuvem)
- TeamMailbox (Exchange 2013 ou posterior e nuvem)
- UserMailbox
Vários valores, separados por vírgulas, podem ser especificados.
O valor do parâmetro RecipientType afeta os valores que você pode usar para esse parâmetro. Por exemplo, se você usar o valor RecipientType MailContact, não poderá usar o valor UserMailbox para este parâmetro. Você receberá o erro: nenhum dos RecipientTypeDetails especificados está incluído em qualquer tipo de destinatário especificado.
| Type: | RecipientTypeDetails[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-ResultSize
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.
| Type: | Unlimited |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-SortBy
O parâmetro SortBy especifica a propriedade pela qual classificar os resultados. Você pode classificar apenas por uma propriedade de cada vez. Os resultados são classificados em ordem crescente.
Se a exibição padrão não incluir a propriedade pela qual você está classificando, você poderá acrescentar o comando com | Format-Table -Auto Property1,Property2,...PropertyX. para criar uma nova exibição que contenha todas as propriedades que você deseja ver. Os caracteres curinga (*) nos nomes de propriedade são permitidos.
É possível classificar pelas seguintes propriedades:
- Nome
- DisplayName
- Alias
- Cidade
- FirstName
- Sobrenome
- Office
- ServerLegacyDN
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
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.