Compartilhar via

Get-Recipient

  • Artigo

 

Aplica-se a: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1

Tópico modificado em: 2010-04-27

Use o cmdlet Get-Recipient para retornar uma lista de objetos de destinatário do serviço de diretório do Active Directory.

Sintaxe

get-Recipient [-Identity <RecipientIdParameter>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

get-Recipient [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientPreviewFilter <String>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

get-Recipient [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

get-Recipient [-Anr <String>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-IgnoreDefaultScope <SwitchParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]

Descrição detalhada

O cmdlet Get-Recipient recupera atributos do destinatário especificado. Nenhum parâmetro é necessário. Se o cmdlet for executado sem um parâmetro, será retornada uma lista completa de destinatários da organização.

Para executar o cmdlet Get-Recipient, você deve usar a conta à qual esteja delegada a seguinte função:

  • Função Administrador Somente para Exibição do Exchange

Para obter mais informações sobre permissões, delegação de funções e os direitos necessários para administrar o Exchange Server 2007, consulte Considerações sobre permissão.

Parâmetros

Parâmetro Necessário Tipo Descrição

Anr

Opcional

System.String

O parâmetro Anr especifica uma cadeia de caracteres para executar uma pesquisa de 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 pesquisáveis são:

  • CommonName (CN)

  • DisplayName (displayName)

  • FirstName (givenName)

  • LastName (sn)

  • Alias (mailNickname)

Credential

Opcional

System.Management.Automation.PSCredential

O parâmetro Credential especifica o nome de usuário e a senha a serem usados para acessar o Active Directory.

Se o parâmetro Credential for usado, o comando solicitará a senha da conta antes de continuar.

DomainController

Opcional

Microsoft.Exchange.Data.Fqdn

Para especificar o nome de domínio totalmente qualificado (FQDN) do controlador de domínio que grava essa alteração de configuração no Active Directory, inclua o parâmetro DomainController no comando.

Filter

Opcional

System.String

Use o parâmetro Filter para especificar um ou mais atributos utilizados para restringir os destinatários retornados pela consulta. Esse parâmetro não pode ser usado juntamente com o parâmetro Identity ou Anr.

Para obter mais informações sobre as propriedades filtráveis, consulte Propriedades filtráveis do parâmetro -Filter.

Identity

Opcional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

O parâmetro Identity identifica o destinatário. Você pode usar um dos seguintes valores:

  • GUID

  • Domínio\Conta

  • Nome UPN

  • LegacyExchangeDN

  • Endereço SMTP

  • Name

  • Alias

IgnoreDefaultScope

Optional

System.Management.Automation.SwitchParameter

O parâmetro IgnoreDefaultScope instrui o comando a ignorar a configuração padrão de escopo do destinatário do Shell de Gerenciamento do Exchange e usar toda a floresta como o escopo. Isso permite que o comando acesse objetos do Active Directory que não estão atualmente no escopo padrão. O uso do parâmetro IgnoreDefaultScope introduz as seguintes restrições:

  • Você não pode usar o parâmetro DomainController. O comando usará automaticamente um servidor de catálogo global adequado.

  • Você pode usar o DN somente para o parâmetro Identity. Outras formas de identificação, como alias ou GUID, não são aceitas.

  • Você não pode usar os parâmetros OrganizationalUnit e Identity juntos.

  • Você não pode usar o parâmetro Credential.

OrganizationalUnit

Opcional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

O parâmetro OrganizationalUnit especifica uma unidade organizacional (UO) ou um nome canônico de domínio e é usado para limitar os resultados. Se usar esse parâmetro, você só obterá destinatários no contêiner especificado. Por exemplo:

  • UO: westcoast.contoso.com/users

  • Domínio: westcoast.contoso.com

ReadFromDomainController

Opcional

System.Management.Automation.SwitchParameter

O parâmetro ReadFromDomainController especifica se as informações do usuário são lidas a partir de um controlador de domínio no domínio do usuário. Se você definir o escopo do destinatário para incluir todos os destinatários da floresta e não usar este parâmetro, talvez as informações do usuário sejam lidas a partir de um catálogo global com informações desatualizadas. Se você usar este parâmetro, várias leituras poderão ser necessárias para obter as informações.

Dica

Por padrão, o escopo do destinatário é definido como o domínio que hospeda seus servidores Exchange.

RecipientPreviewFilter

Optional

System.String

Use o parâmetro RecipientPreviewFilter para especificar um filtro de destinatário que defina os destinatários retornados por este comando. É possível criar um filtro de destinatário personalizado para um grupo dinâmico de distribuição, uma lista de endereços ou uma diretiva de endereço de email. Para verificar se o filtro de destinatário especificado retornará os destinatários desejados, é possível passar o filtro OPATH especificado na propriedade RecipientFilter desse grupo dinâmico de distribuição, lista de endereços ou diretiva de endereço de email para o parâmetro RecipientPreviewFilter e visualizar a lista de destinatários.

RecipientType

Opcional

Microsoft.Exchange.Data.Directory.Recipient.RecipientType[]

O parâmetro RecipientType especifica o tipo de destinatários a serem retornados. Você pode usar um ou mais dos seguintes tipos:

  • UserMailbox

  • MailUser

  • MailContact

  • MailUniversalDistributionGroup

  • MailUniversalSecurityGroup

  • MailNonUniversalGroup

  • DynamicDistributionGroup

  • PublicFolder

RecipientTypeDetails

Opcional

Microsoft.Exchange.Data.Directory.Recipient.RecipientTypeDetails[]

O parâmetro RecipientTypeDetails especifica o tipo de destinatários que são retornados. Os tipos de destinatários no Microsoft Exchange Server 2007 são divididos em tipos e subtipos de destinatários. Cada tipo de destinatário contém todas as propriedades comuns para todos os subtipos. Por exemplo, o tipo UserMailbox representa uma conta de usuário no Active Directory com uma caixa de correio associada. Como há vários tipos de caixas de correio, cada tipo é identificado pelo parâmetro RecipientTypeDetails. Por exemplo, uma caixa de correio de sala de conferência tem RecipientTypeDetails definido como ConferenceRoomMailbox, enquanto uma caixa de correio de usuário tem RecipientTypeDetails definido como UserMailbox.

Para este comando, os detalhes de tipo de destinatário disponíveis são:

  • ConferenceRoomMailbox

  • EquipmentMailbox

  • LegacyMailbox

  • LinkedMailbox

  • UserMailbox

  • MailContact

  • DynamicDistributionGroup

  • MailForestContact

  • MailNonUniversalGroup

  • MailUniversalDistributionGroup

  • MailUniversalSecurityGroup

  • MailUser

  • PublicFolder

  • SharedMailbox

ResultSize

Opcional

Microsoft.Exchange.Data.Unlimited

O parâmetro ResultSize especifica o número máximo de resultados a serem retornados. Se desejar retornar todos os destinatários que correspondam ao filtro, use "unlimited" como o valor desse parâmetro. O valor padrão é 1000.

SortBy

Opcional

System.String

O parâmetro SortBy especifica o atributo pelo qual os resultados são classificados. Você pode classificar por apenas um atributo de cada vez. Você pode classificar pelos seguintes atributos:

  • Alias

  • DisplayName

  • Name

Os resultados serão classificados na ordem crescente.

Tipos de entrada

Tipos de retorno

Erros

Erro Descrição

   

 

Exceções

Exceções Descrição

  

 

Exemplo

O primeiro exemplo mostra como obter informações sobre todos os destinatários da organização.

O segundo exemplo mostra como obter informações sobre todos os contatos habilitados para email na organização e como classificá-los por nome.

Get-Recipient -ResultSize unlimited
Get-Recipient -RecipientType MailContact -SortBy Name