Get-Recipient

  • Artículo

 

Se aplica a: Exchange Server 2007 SP3, Exchange Server 2007 SP2, Exchange Server 2007 SP1

Última modificación del tema: 2010-04-27

Use el cmdlet Get-Recipient para obtener una lista de objetos de destinatario del servicio de directorio de Active Directory.

Sintaxis

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>]

Descripción detallada

El cmdlet Get-Recipient recupera atributos del destinatario especificado. No se necesita ningún parámetro. Si el cmdlet se ejecuta sin ningún parámetro, se devuelve una lista completa de destinatarios de la organización.

Para ejecutar el cmdlet Get-Recipient, la cuenta que use debe tener delegada la siguiente función:

  • Función Administrador de Exchange con permiso de vista

Para obtener más información acerca de los permisos, la delegación de funciones y los derechos necesarios para administrar Exchange Server 2007, consulte Consideraciones sobre permisos.

Parámetros

Parámetro Necesario Tipo Descripción

Anr

Opcional

System.String

El parámetro Anr especifica una cadena para realizar una búsqueda de resolución de nombres ambiguos. Puede especificar una cadena parcial y buscar objetos con un atributo que coincida con esa cadena. Los atributos predeterminados que se buscan son:

  • CommonName (CN)

  • DisplayName (displayName)

  • FirstName (givenName)

  • LastName (sn)

  • Alias (mailNickname)

Credential

Opcional

System.Management.Automation.PSCredential

El parámetro Credential especifica el nombre de usuario y la contraseña que se van a usar para obtener acceso a Active Directory.

Si se usa el parámetro Credential, el comando solicita la contraseña de la cuenta antes de continuar.

DomainController

Opcional

Microsoft.Exchange.Data.Fqdn

Para especificar el nombre de dominio completo (FQDN) del controlador de dominio que escribe este cambio de configuración Active Directory, incluya el parámetro DomainController del comando.

Filter

Opcional

System.String

Use el parámetro Filter para especificar uno o más atributos usados para limitar los destinatarios que devuelve la consulta. Este parámetro no se puede usar en conjunción con el parámetro Identity ni el parámetro Anr.

Para obtener más información acerca de las propiedades filtrables, consulte Propiedades a las que se puede aplicar un filtro para el parámetro de filtrado.

Identity

Opcional

Microsoft.Exchange.Configuration.Tasks.RecipientIdParameter

El parámetro Identity identifica al destinatario. Puede usar uno de los valores siguientes:

  • GUID

  • Dominio\Cuenta

  • Nombre principal de usuario (UPN)

  • LegacyExchangeDN

  • Dirección del Protocolo simple de transferencia de correo (SMTP)

  • Name

  • Alias

IgnoreDefaultScope

Opcional

System.Management.Automation.SwitchParameter

El parámetro IgnoreDefaultScope indica al comando que omita la opción predeterminada del ámbito de destinatario para el Shell de administración de Exchange y que use todo el bosque como ámbito. Esto permite que el comando tenga acceso a objetos de Active Directory que no están actualmente en el ámbito predeterminado. El uso del parámetro IgnoreDefaultScope introduce las siguientes restricciones:

  • No puede usar el parámetro DomainController. El comando usará un servidor de catálogo global adecuado automáticamente.

  • Sólo puede usar el DN para el parámetro Identity. No se aceptan otras formas de identificación, como alias o GUID.

  • No puede usar los parámetros OrganizationalUnit e Identity juntos.

  • No puede usar el parámetro Credential.

OrganizationalUnit

Opcional

Microsoft.Exchange.Configuration.Tasks.OrganizationalUnitIdParameter

El parámetro OrganizationalUnit especifica una unidad organizativa o nombre de dominio canónico y se usa para limitar los resultados. Si usa este parámetro, sólo obtendrá los destinatarios del contenedor que especifique. Por ejemplo:

  • OU: westcoast.contoso.com/users

  • Dominio: westcoast.contoso.com

ReadFromDomainController

Opcional

System.Management.Automation.SwitchParameter

El parámetro ReadFromDomainController especifica que la información de usuario se lee desde un controlador de dominio en el dominio del usuario. Si define el ámbito del destinatario para que incluya a todos los destinatarios del bosque y no usa este parámetro, es posible que la información de usuario se lea desde un catálogo global con información no actualizada. Si usa este parámetro, podrían ser posibles varias lecturas para obtener la información.

Nota

De forma predeterminada, el ámbito del destinatario se establece en el dominio que hospeda los servidores de Exchange.

RecipientPreviewFilter

Opcional

System.String

Use el parámetro RecipientPreviewFilter para especificar un filtro de destinatario que defina los destinatarios que devolverá este comando. Puede crear un filtro de destinatario personalizado para un grupo de distribución dinámico, una lista de direcciones o una directiva de dirección de correo electrónico. Para comprobar que el filtro de destinatario que ha especificado devolverá los destinatarios que desea, puede pasar el filtro OPATH especificado en la propiedad RecipientFilter para ese grupo de distribución dinámico, esa lista de direcciones o esa directiva de dirección de correo electrónico para el parámetro RecipientPreviewFilter y obtener una vista previa de la lista de destinatarios.

RecipientType

Opcional

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

El parámetro RecipientType especifica el tipo de destinatarios que se devolverán. Puede usar uno o varios de estos tipos:

  • UserMailbox

  • MailUser

  • MailContact

  • MailUniversalDistributionGroup

  • MailUniversalSecurityGroup

  • MailNonUniversalGroup

  • DynamicDistributionGroup

  • PublicFolder

RecipientTypeDetails

Opcional

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

El parámetro RecipientTypeDetails especifica el tipo de destinatario que se devuelve. Los tipos de destinatario de Microsoft Exchange Server 2007 se dividen en tipos y subtipos de destinatarios. Cada tipo de destinatario contiene todas las propiedades comunes de todos los subtipos. Por ejemplo, el tipo UserMailbox representa una cuenta de usuario de Active Directory con un buzón asociado. Dado que hay varios tipos de buzón, cada tipo de buzón se identifica mediante el parámetro RecipientTypeDetails. Por ejemplo, un buzón de una sala de conferencias tiene el parámetro RecipientTypeDetails establecido en ConferenceRoomMailbox, mientras que un buzón de usuario tendrá RecipientTypeDetails establecido en UserMailbox.

Para este comando, los tipos de destinatarios disponibles son:

  • ConferenceRoomMailbox

  • EquipmentMailbox

  • LegacyMailbox

  • LinkedMailbox

  • UserMailbox

  • MailContact

  • DynamicDistributionGroup

  • MailForestContact

  • MailNonUniversalGroup

  • MailUniversalDistributionGroup

  • MailUniversalSecurityGroup

  • MailUser

  • PublicFolder

  • SharedMailbox

ResultSize

Opcional

Microsoft.Exchange.Data.Unlimited

El parámetro ResultSize especifica el número máximo de resultados que se van a devolver. Si desea que se devuelvan todos los destinatarios que coincidan con el filtro, use el valor "ilimitado" en este parámetro. El valor predeterminado es 1000.

SortBy

Opcional

System.String

El parámetro SortBy especifica el atributo según el que se ordenan los resultados. Sólo se puede seleccionar un atributo a la vez. Puede realizar la clasificación por los atributos siguientes:

  • Alias

  • DisplayName

  • Name

Los resultados se clasificarán en orden ascendente.

Tipos de entrada

Tipos de valores devueltos

Errores

Error Descripción

   

 

Excepciones

Excepciones Descripción

  

 

Ejemplo

El primer ejemplo muestra cómo obtener información acerca de todos los destinatarios de su organización.

El segundo ejemplo muestra cómo obtener información acerca de todos los contactos con correo habilitado de su organización y clasificarlos por el nombre.

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