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: no PowerShell do Exchange Online, recomendamos que você use o cmdlet Get-EXORecipient, em vez deste cmdlet. Para saber mais, confira Conectar-se ao Exchange Online usando o PowerShell Remoto.

Em ambientes de nuvem, para retornar os grupos da 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.

Examples

Exemplo 1

Get-Recipient -ResultSize unlimited

Este exemplo recupera uma lista de resumo de todos os destinatários em sua organização.

Exemplo 2

Get-Recipient -Identity "Marketing Department" | Format-List

Este 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,Name

Este exemplo recupera as informações sobre os contatos de email em sua organização e os organiza por departamento.

Parameters

-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

  • LastName

  • Alias

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, 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:

  • Fica

  • Gerenciado

Type:AuthenticationType
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection
-BookmarkDisplayName

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

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, 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 este 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
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 Database 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
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
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 de acordo com as propriedades e os valores especificados. Os critérios de pesquisa usam a sintaxe "Property -ComparisonOperator 'Value'" .

  • Coloque todo o filtro OPath entre aspas duplas "". Se o filtro contiver valores de sistema (por exemplo,, $true $false ou $null ), use aspas simples. Embora esse parâmetro seja uma cadeia de caracteres (não um bloco de sistema), você também pode usar chaves {}, mas somente se o filtro não contiver variáveis.

  • Propriedade é uma propriedade filtrável. Para obter mais informações sobre as propriedades filtráveis, consulte Filterable Properties for the filter Parameter.

  • ComparisonOperator é um operador de comparação de OPath (por exemplo -eq , igual a e -like para comparação de cadeia de caracteres). Para obter mais informações sobre operadores de comparação, consulte about_Comparison_Operators.

  • Value é o valor da propriedade a ser pesquisada. Coloque valores de texto e variáveis entre aspas simples ( 'Value' ou '$Variable' ). Se um valor de variável contiver aspas simples, você precisará identificar (escapar) as aspas simples para expandir a variável corretamente. Por exemplo, em vez de '$User' , use '$($User -Replace "'","''")' . Não coloque números inteiros ou valores do sistema (por exemplo,,, 500 $true $false ou $null ).

Você pode encadear vários critérios de pesquisa juntos 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 do OPath no Exchange, consulte Additional OPATH Syntax Information.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, 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
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection
-IgnoreDefaultScope

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

O parâmetro IgnoreDefaultScope instrui o comando a ignorar a configuração de escopo do destinatário padrão do Shell de Gerenciamento do Exchange e usar toda a floresta como escopo. Isso permite ao comando acessar os objetos do Active Directory que não estão atualmente disponíveis no escopo padrão.

O uso do parâmetro IgnoreDefaultScope apresenta 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
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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection
-IncludeSoftDeletedRecipients

A opção IncludeSoftDeletedRecipients especifica se é para incluir destinatários excluídos por software nos resultados. Não é preciso especificar um valor com essa opção.

Os destinatários excluídos de forma reversível são destinatários excluídos que ainda são recuperáveis.

Type:SwitchParameter
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection
-OrganizationalUnit

O parâmetro OrganizationalUnit filtra os resultados com base no local 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 UO (unidade organizacional) ou um 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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection
-Properties

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

Type:String[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection
-PropertySet

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

Type:PropertySet
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, 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. Se você executar o comando Set-AdServerSettings -ViewEntireForest $true para incluir todos os objetos da floresta e não usar a opção ReadFromDomainController, será possível que as informações do usuário sejam lidas de um catálogo global com informações desatualizadas. Se você usar a opção ReadFromDomainController, várias leituras poderão ser necessárias para obter as informações. Você não precisa especificar um valor com essa opção.

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
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 dinâmico de distribuição, lista de endereços ou diretiva de endereço de email. Esse parâmetro usa a sintaxe de filtro OPATH "Property -ComparisonOperator 'Value'" (a mesma sintaxe do parâmetro RecipientFilter).

  • Coloque todo o filtro OPath entre aspas duplas "". Se o filtro contiver valores de sistema (por exemplo,, $true $false ou $null ), use aspas simples. Embora esse parâmetro seja uma cadeia de caracteres (não um bloco de sistema), você também pode usar chaves {}, mas somente se o filtro não contiver variáveis.

  • Propriedade é uma propriedade filtrável. Para propriedades de destinatário filtráveis, consulte Propriedades filtráveis para o parâmetro RecipientFilter.

  • ComparisonOperator é um operador de comparação de OPath (por exemplo -eq , igual a e -like para comparação de cadeia de caracteres). Para obter mais informações sobre operadores de comparação, consulte about_Comparison_Operators.

  • Value é o valor da propriedade a ser pesquisada. Coloque valores de texto e variáveis entre aspas simples ( 'Value' ou '$Variable' ). Se um valor de variável contiver aspas simples, você precisará identificar (escapar) as aspas simples para expandir a variável corretamente. Por exemplo, em vez de '$User' , use '$($User -Replace "'","''")' . Não coloque números inteiros ou valores do sistema (por exemplo,,, 500 $true $false ou $null ).

Para obter informações detalhadas sobre filtros do OPath no Exchange, consulte Additional OPATH Syntax Information.

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, 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

SPO: exSharePointOnline2ndMen

Type:RecipientType[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, 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

  • GuestMailUser

  • LegacyMailbox

  • LinkedMailbox

  • LinkedRoomMailbox

  • MailContact

  • MailForestContact

  • MailNonUniversalGroup

  • MailUniversalDistributionGroup

  • MailUniversalSecurityGroup

  • MailUser

  • PublicFolder

  • PublicFolderMailbox

  • RemoteEquipmentMailbox

  • RemoteRoomMailbox

  • RemoteSharedMailbox

  • RemoteTeamMailbox

  • RemoteUserMailbox

  • RoomList

  • RoomMailbox

  • SchedulingMailbox

  • SharedMailbox

  • TeamMailbox

  • UserMailbox

SPO: exSharePointOnline2ndMen

O valor do parâmetro RecipientType afeta os valores que você pode usar para esse parâmetro. Por exemplo, se você usar o valor de RecipientType MailContact, não poderá usar o valor UserMailbox para esse parâmetro. Você receberá o erro: nenhum dos RecipientTypeDetails especificados será incluído em qualquer tipo de destinatário especificado.

Type:RecipientTypeDetails[]
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection
-Recursos

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

Type:MultiValuedProperty
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection
-Resultados

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
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, 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 o modo de exibição padrão não incluir a propriedade que você está classificando, você pode anexar o comando com | Format-Table-auto <Property1> , <Property2> ... para criar um novo modo de exibição que contenha todas as propriedades que você deseja ver. Há suporte para caracteres curinga ( * ) nos nomes das propriedades.

É possível classificar pelas seguintes propriedades:

  • Nome

  • DisplayName

  • Alias

  • Cidade

  • FirstName

  • LastName

  • Office

  • ServerLegacyDN

Type:String
Position:Named
Default value:None
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Office 365 Security & Compliance Center, Exchange Online Protection

Inputs

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.

Outputs

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.