.png)
Get-Recipient
Aplica-se a: Exchange Server 2013, Exchange Online
Tópico modificado em: 2013-02-08
Use o cmdlet Get-Recipient para retornar uma lista de objetos de destinatário do Active Directory.
Para obter informações sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Sintaxe.
Get-Recipient [-RecipientPreviewFilter <String>] <COMMON PARAMETERS>
Get-Recipient [-BookmarkDisplayName <String>] [-Identity <RecipientIdParameter>] [-IncludeBookmarkObject <$true | $false>] <COMMON PARAMETERS>
Get-Recipient [-Database <DatabaseIdParameter>] <COMMON PARAMETERS>
Get-Recipient [-Anr <String>] <COMMON PARAMETERS>
COMMON PARAMETERS: [-AccountPartition <AccountPartitionIdParameter>] [-AuthenticationType <Managed | Federated>] [-Capabilities <MultiValuedProperty>] [-Credential <PSCredential>] [-DomainController <Fqdn>] [-Filter <String>] [-IgnoreDefaultScope <SwitchParameter>] [-Organization <OrganizationIdParameter>] [-OrganizationalUnit <OrganizationalUnitIdParameter>] [-Properties <String[]>] [-PropertySet <All | ControlPanel | ConsoleSmallSet | ConsoleLargeSet | Minimum>] [-ReadFromDomainController <SwitchParameter>] [-RecipientType <RecipientType[]>] [-RecipientTypeDetails <RecipientTypeDetails[]>] [-ResultSize <Unlimited>] [-SortBy <String>]
Este exemplo recupera informações sobre todos os destinatários de sua organização.
Get-Recipient -ResultSize unlimited
Este exemplo recupera informações sobre todos os contatos de email de sua organização e os classifica por nome.
Get-Recipient -RecipientType MailContact -SortBy Name
Para executar esse cmdlet, você precisa ter permissões. Embora todos os parâmetros para este cmdlet estejam listados neste tópico, talvez você não tenha acesso a alguns parâmetros, caso eles não estejam incluídos nas permissões atribuídas a você. Para ver de que permissões você precisa, consulte o Seção "Permissões de provisionamento do destinatário" do tópico Permissões de Destinatários.
| Parâmetro | Obrigatório | Tipo | Descrição | ||
|---|---|---|---|---|---|
| AccountPartition | Opcional | Microsoft.Exchange.Configuration.Tasks.AccountPartitionIdParameter | Esse parâmetro está reservado para uso interno da Microsoft. | ||
| Anr | Opcional | System.String | 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:
| ||
| AuthenticationType | Opcional | Microsoft.Exchange.Data.Directory.AuthenticationType | Esse parâmetro se aplica a objetos no serviço baseado em nuvem. Ele não está disponível para implantações locais. O parâmetro AuthenticationType especifica o destinatário por tipo de autenticação. Use um dos valores a seguir:
| ||
| BookmarkDisplayName | Opcional | System.String | Esse parâmetro está reservado para uso interno da Microsoft. | ||
| Capabilities | Opcional | Microsoft.Exchange.Data.MultiValuedProperty | Esse parâmetro está reservado para uso interno da Microsoft. | ||
| 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. Esse parâmetro exige a criação e a passagem de um objeto de credencial. Esse objeto de credencial é criado com o cmdlet Get-Credential. Para mais informações, consulte Get-Credential. | ||
| Database | Opcional | Microsoft.Exchange.Configuration.Tasks.DatabaseIdParameter | O parâmetro Database especifica um banco de dados de caixa de correio. Utilize este parâmetro para retornar todos os destinatários armazenados em um banco de dados específico de caixa de correio. Use a propriedade Name do banco de dados de caixa de correio como valor para este parâmetro. | ||
| DomainController | Opcional | Microsoft.Exchange.Data.Fqdn | O parâmetro DomainController especifica o FQDN do controlador de domínio que recupera dados do Active Directory. | ||
| Filter | Opcional | System.String | O parâmetro Filter indica o filtro OPath usado para filtrar destinatários. Para mais informações sobre as propriedades filtráveis, consulte Propriedades filtráveis para o parâmetro de filtro. | ||
| Identity | Opcional | Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter | O parâmetro Identity especifica o destinatário. Esse parâmetro aceita os seguintes valores:
| ||
| IgnoreDefaultScope | Opcional | System.Management.Automation.SwitchParameter | 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 que o comando acesse objetos do Active Directory que não estejam no escopo padrão. O uso do parâmetro IgnoreDefaultScope introduz as seguintes restrições:
| ||
| IncludeBookmarkObject | Opcional | System.Boolean | Esse parâmetro está reservado para uso interno da Microsoft. | ||
| Organization | Opcional | Microsoft.Exchange.Configuration.Tasks.OrganizationIdParameter | O parâmetro Organization está reservado para uso interno da Microsoft. | ||
| 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ê terá apenas destinatários no local que você especificar, por exemplo:
| ||
| Properties | Opcional | System.String[] | Esse parâmetro está reservado para uso interno da Microsoft. | ||
| PropertySet | Opcional | Microsoft.Exchange.Data.Directory.Management.PropertySet | Esse parâmetro está reservado para uso interno da Microsoft. | ||
| ReadFromDomainController | Opcional | System.Management.Automation.SwitchParameter | O parâmetro ReadFromDomainController especifica se as informações do usuário são lidas em um controlador de domínio no domínio do usuário. Se o escopo do destinatário for definido para incluir todos os destinatários da floresta e não usar esse parâmetro, é possível que as informações do usuário sejam lidas de um catálogo global com informações desatualizadas. Se este parâmetro for usado, várias leituras poderão ser necessárias para obter as informações.
| ||
| RecipientPreviewFilter | Opcional | System.String | O parâmetro RecipientPreviewFilter especifica um filtro de destinatário que defina os destinatários retornados por este comando. Você pode 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 que você deseja, pode passar o filtro OPATH especificado na propriedade RecipientFilter para esse 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ário a ser retornado. É possível usar um ou mais dos seguintes valores:
| ||
| RecipientTypeDetails | Opcional | Microsoft.Exchange.Data.Directory.Recipient.RecipientTypeDetails[] | O parâmetro RecipientTypeDetails especifica o tipo de destinatário retornado. Os tipos de destinatário são divididos em tipos e subtipos de destinatário. 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 que tem uma caixa de correio associada. Como há vários tipos de caixa 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. É possível selecionar um dos seguintes valores:
| ||
| ResultSize | Opcional | Microsoft.Exchange.Data.Unlimited | O parâmetro ResultSize especifica o número máximo de resultados a serem retornados. Se quiser retornar todos os destinatários que correspondam ao filtro, use | ||
| SortBy | Opcional | System.String | O parâmetro SortBy especifica o atributo segundo o qual os resultados são classificados. Você pode classificar por apenas um atributo de cada vez. Classifique pelos seguintes atributos:
Os resultados são classificados na ordem crescente. |
Observação: Para ver os tipos de entrada que este cmdlet aceita, consulte Tipos de entrada e saída de cmdlets. Se o campo Tipo de Entrada de um cmdlet estiver em branco, é porque o cmdlet não aceita dados de entrada.
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 cmdlets. Se o campo Tipo de Saída estiver em branco, o cmdlet não retorna dados.
