Get-Recipient

Este cmdlet está disponible en Exchange local y en el servicio basado en la nube. Puede que algunos parámetros y opciones de configuración sean exclusivos de un entorno u otro.

Use el cmdlet Get-Recipient para ver los objetos de destinatario existentes en la organización. Este cmdlet devuelve todos los objetos habilitados para correo (por ejemplo, buzones, usuarios de correo, contactos de correo y grupos de distribución).

Nota: en Exchange Online PowerShell, se recomienda usar el cmdlet Get-EXORecipient en lugar de este cmdlet. Para obtener más información, vea Conexión a Exchange Online PowerShell.

En los entornos de la nube, para devolver los grupos de Microsoft 365, debe usar el parámetro RecipientTypeDetails con el valor GroupMailbox.

Para obtener más información acerca de los conjuntos de parámetros de la sección Sintaxis a continuación, vea Sintaxis del cmdlet de Exchange.

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

El cmdlet Get-Recipient puede que no devuelva todas las propiedades específicas de objeto de un destinatario. Para ver las propiedades específicas de objeto de un destinatario, debe usar el cmdlet correspondiente según el tipo de objeto (por ejemplo, Get-Mailbox, Get-MailUser o Get-DistributionGroup).

Deberá tener asignados permisos antes de poder ejecutar este cmdlet. Aunque en este tema se enumeran todos los parámetros correspondientes a este cmdlet, tal vez no tenga acceso a algunos parámetros si no están incluidos en los permisos que se le han asignado. Para obtener los permisos necesarios para ejecutar cualquier cmdlet o parámetro en su organización, consulte Find the permissions required to run any Exchange cmdlet.

Ejemplos

Ejemplo 1

Get-Recipient -ResultSize unlimited

En este ejemplo se muestra una lista resumida de todos los destinatarios de la organización.

Ejemplo 2

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

En este ejemplo se devuelve información detallada del destinatario denominado Marketing Department.

Ejemplo 3

Get-Recipient -RecipientType MailContact -SortBy Office | Format-Table -Auto Office,Name

En este ejemplo se muestra información sobre todos los contactos de correo de la organización y se los clasifica por oficina.

Parámetros

-ANR

El parámetro Anr especifica una cadena en la que se va a realizar una búsqueda resolución de nombres ambiguos (ANR). 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
  • 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, Security & Compliance Center, Exchange Online Protection
-AuthenticationType

Este parámetro solo está disponible en el servicio basado en la nube.

El parámetro AuthenticationType especifica el destinatario por el el tipo de autenticación. Use uno de los siguientes valores:

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

Este parámetro está reservado para uso interno de 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, Security & Compliance Center, Exchange Online Protection
-Capacidades

Este parámetro está reservado para uso interno de 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, Security & Compliance Center, Exchange Online Protection
-Credential

Este parámetro solo está disponible en Exchange local.

El parámetro credential especifica el nombre de usuario y la contraseña que se usan para ejecutar este comando. Por lo general, este parámetro se usa en scripts o cuando deben proporcionarse credenciales diferentes que disponen de los permisos necesarios.

Un valor para este parámetro requiere el cmdlet Get-Credential. Para pausar este comando y recibir una solicitud de credenciales, use el valor (Get-Credential). O bien, antes de ejecutar este comando, almacene las credenciales en una variable (por ejemplo, $cred = Get-Credential) y, a continuación, use el nombre de variable ($cred) para este parámetro. Para más información, vea Get-Credential.

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 solo está disponible en Exchange local.

El parámetro Database devuelve todos los destinatarios almacenados en la base de datos de buzones de correo especificada. Puede usar cualquier valor que identifique la base de datos de forma exclusiva. Por ejemplo:

  • Nombre
  • Nombre completo (DN)
  • 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 solo está disponible en Exchange local.

El parámetro DomainController especifica el controlador de dominio que el cmdlet usa para leer datos de Active Directory o escribirlos. El controlador de dominio se identifica por su nombre de dominio completo (FQDN). Por ejemplo, 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

El parámetro filter usa una sintaxis OPath para filtrar los resultados por las propiedades y valores especificados. Los criterios de búsqueda usan la sintaxis "Property -ComparisonOperator 'Value'" .

  • Incluya todo el filtro OPath entre comillas dobles "". Si el filtro contiene valores del sistema (por ejemplo,, $true $false o $null ), use comillas simples ' ' en su lugar. Aunque este parámetro es una cadena (no un bloque del sistema), también puede usar llaves {}, pero solo si el filtro no contiene variables.
  • Es una propiedad que se pueden filtrar. Para obtener más información acerca de las propiedades que se pueden filtrar, consulte filterable Properties for the Filter Parameter.
  • ComparisonOperator es un operador de comparación de OPath (por ejemplo, -eq para Equals y -like para la comparación de cadenas). Para obtener más información acerca de los operadores de comparación, consulte about_Comparison_Operators.
  • Value es el valor de propiedad que se va a buscar. Incluya los valores de texto y las variables entre comillas simples ( 'Value' o '$Variable' ). Si un valor de variable contiene comillas simples, debe identificar (escapar) las comillas simples para expandir la variable correctamente. Por ejemplo, en lugar de '$User' , use '$($User -Replace "'","''")' . No encierre los números enteros o los valores del sistema (por ejemplo,,, 500 $true $false o $null ).

Puede encadenar varios criterios de búsqueda con los operadores lógicos -and y -or . Por ejemplo, "Criteria1 -and Criteria2" o "(Criteria1 -and Criteria2) -or Criteria3" .

Para obtener información detallada acerca de los filtros OPath en Exchange, consulte información adicional acerca de la Sintaxis opath.

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, Security & Compliance Center, Exchange Online Protection
-Identidad

El parámetro Identity especifica el objeto de destinatario que desea ver. Puede usar cualquier valor que identifique de forma exclusiva el destinatario. Por ejemplo:

  • Nombre
  • Alias
  • Nombre distintivo (DN)
  • Nombre distintivo (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, Security & Compliance Center, Exchange Online Protection
-IgnoreDefaultScope

Este parámetro solo está disponible en Exchange local.

El modificador IgnoreDefaultScope indica al comando que ignore la configuración predeterminada del ámbito del destinatario para la sesión del 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 disponibles actualmente en el ámbito predeterminado.

El uso de este modificador IgnoreDefaultScope introduce las restricciones siguientes:

  • No puede usar el parámetro DomainController. El comando usa un servidor de catálogo global adecuado de forma automática.
  • No puede usar el parámetro DomainController. El comando usa un servidor de catálogo global adecuado de forma automática.
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

Este parámetro está reservado para uso interno de 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, Security & Compliance Center, Exchange Online Protection
-IncludeSoftDeletedRecipients

El modificador IncludeSoftDeletedRecipients especifica si se deben incluir los destinatarios eliminados temporalmente en los resultados. No es necesario especificar un valor con este modificador.

Los destinatarios eliminados temporalmente son destinatarios eliminados que siguen siendo recuperables.

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, Security & Compliance Center, Exchange Online Protection
-OrganizationalUnit

El parámetro OrganizationalUnit filtra los resultados en función de la ubicación del objeto en Active Directory. Se devuelven solo los objetos que existen en la ubicación especificada. La entrada válida para este parámetro es una unidad organizativa (OU) o un dominio devuelto por el cmdlet Get-OrganizationalUnit. Puede usar cualquier valor que identifique la OU o el dominio de forma exclusiva. Por ejemplo:

  • Nombre
  • Nombre
  • Nombre completo (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, Security & Compliance Center, Exchange Online Protection
-PropertySet

Este parámetro está reservado para uso interno de 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, Security & Compliance Center, Exchange Online Protection
-Propiedades

Este parámetro está reservado para uso interno de 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, Security & Compliance Center, Exchange Online Protection
-ReadFromDomainController

Este parámetro solo está disponible en Exchange local.

El conmutador ReadFromDomainController especifica que la información se debe leer de un controlador de dominio en el dominio del usuario. Si ejecuta el comando Set-AdServerSettings -ViewEntireForest $true para que se incluyan todos los objetos del bosque y no utiliza el conmutador ReadFromDomainController, es posible que la información se lea de un catálogo global que tenga información no actualizada. Cuando se utiliza el conmutador ReadFromDomainController, es posible que se necesiten varias lecturas para obtener la información. No es necesario especificar ningún valor con este modificador.

De forma predeterminada, el ámbito del destinatario se establece en el dominio que hospeda los servidores de 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

El parámetro RecipientPreviewFilter prueba un filtro de destinatarios que se usaría en un grupo de distribución dinámico, una lista de direcciones o una directiva de direcciones de correo electrónico. Este parámetro usa la sintaxis de filtro Opath "Property -ComparisonOperator 'Value'" (la misma sintaxis que el parámetro RecipientFilter).

  • Incluya todo el filtro OPath entre comillas dobles "". Si el filtro contiene valores del sistema (por ejemplo,, $true $false o $null ), use comillas simples ' ' en su lugar. Aunque este parámetro es una cadena (no un bloque del sistema), también puede usar llaves {}, pero solo si el filtro no contiene variables.
  • Es una propiedad que se pueden filtrar. Para obtener más propiedades de destinatarios que se pueden filtrar, vea filterable Properties for the RecipientFilter Parameter.
  • ComparisonOperator es un operador de comparación de OPath (por ejemplo, -eq para Equals y -like para la comparación de cadenas). Para obtener más información acerca de los operadores de comparación, consulte about_Comparison_Operators.
  • Value es el valor de propiedad que se va a buscar. Incluya los valores de texto y las variables entre comillas simples ( 'Value' o '$Variable' ). Si un valor de variable contiene comillas simples, debe identificar (escapar) las comillas simples para expandir la variable correctamente. Por ejemplo, en lugar de '$User' , use '$($User -Replace "'","''")' . No encierre los números enteros o los valores del sistema (por ejemplo,,, 500 $true $false o $null ).

Para obtener información detallada acerca de los filtros OPath en Exchange, consulte información adicional acerca de la Sintaxis opath.

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, Security & Compliance Center, Exchange Online Protection
-RecipientType

El parámetro RecipientType filtra los resultados por el tipo de destinatario especificado. Los valores válidos son:

  • DynamicDistributionGroup
  • MailContact
  • MailNonUniversalGroup
  • MailUniversalDistributionGroup
  • MailUniversalSecurityGroup
  • MailUser
  • PublicFolder
  • UserMailbox

Puede especificar distintos valores separados por comas.

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, Security & Compliance Center, Exchange Online Protection
-RecipientTypeDetails

El parámetro RecipientTypeDetails filtra los resultados por el subtipo de destinatario especificado. Los valores válidos son:

  • 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
  • Buzón
  • UserMailbox

Puede especificar distintos valores separados por comas.

El valor del parámetro RecipientType afecta a los valores que se pueden usar para este parámetro. Por ejemplo, si usa el valor MailContact de RecipientType, no puede usar el valor UserMailbox para este parámetro. Recibirá el error: ninguno de los RecipientTypeDetails especificados se incluye en ningún tipo de destinatario 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, Security & Compliance Center, Exchange Online Protection
-ResultSize

El parámetro ResultSize especifica el número máximo de resultados que se van a devolver. Si desea incluir en los resultados devueltos todas las solicitudes que coincidan con la consulta, use el valor ilimitado para este parámetro. El valor predeterminado es 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, Security & Compliance Center, Exchange Online Protection
-SortBy

El parámetro SortBy especifica la propiedad según la cual se ordenan los resultados. Solo se puede seleccionar una propiedad a la vez. Los resultados se clasifican en orden ascendente.

Si la vista predeterminada no incluye la propiedad que está ordenando, puede anexar el comando con | Format-Table -Auto Property1,Property2,...PropertyX . para crear una vista nueva que contenga todas las propiedades que desea ver. *Se admiten caracteres comodín () en los nombres de las propiedades.

Puede realizar la clasificación por las propiedades siguientes:

  • Nombre
  • DisplayName
  • Alias
  • Ciudad
  • 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, Security & Compliance Center, Exchange Online Protection

Entradas

Para ver los tipos de entrada que acepta este cmdlet, consulte Tipos de entrada y salida de cmdlet. Si el campo Tipo de entrada de un cmdlet está en blanco, el cmdlet no acepta datos de entrada.

Salidas

Para ver los tipos de valor devuelto (también conocidos como tipos de resultado) que acepta este cmdlet, consulte Tipos de entrada y salida de cmdlet. Si el campo Tipo de resultado está en blanco, el cmdlet no devuelve datos.