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 entornos en la nube, para devolver 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 unlimitedEn este ejemplo se muestra una lista resumida de todos los destinatarios de la organización.
Ejemplo 2
Get-Recipient -Identity "Marketing Department" | Format-ListEn este ejemplo se devuelve información detallada del destinatario denominado Departamento de marketing.
Ejemplo 3
Get-Recipient -RecipientType MailContact -SortBy Office | Format-Table -Auto Office,NameEn 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 |
| Required: | False |
| 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, 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:
- Federados
- Administrados
| Type: | AuthenticationType |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online, Security & Compliance, Exchange Online Protection |
-BookmarkDisplayName
Este parámetro está reservado para uso interno de Microsoft.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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, Exchange Online Protection |
-Capabilities
Este parámetro solo está disponible en el servicio basado en la nube.
Este parámetro está reservado para uso interno de Microsoft.
| Type: | MultiValuedProperty |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online, Security & Compliance, 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 |
| Required: | False |
| 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 buzón 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 |
| Required: | False |
| 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 |
| Required: | False |
| 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 la sintaxis de 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 de OPATH entre comillas dobles " ". Si el filtro contiene valores del sistema (por ejemplo, ,
$true$falseo$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. - La propiedad es una propiedad filtrable. Para obtener más información sobre las propiedades filtrables en exchange server y Exchange Online, vea Propiedades filtrables para el parámetro Filter.
- ComparisonOperator es un operador de comparación de OPATH (por ejemplo
-eq, para igual y-likepara la comparación de cadenas). Para obtener más información sobre los operadores de comparación, consulte about_Comparison_Operators. - Value es el valor de propiedad que se va a buscar. Incluya valores de texto y variables entre comillas simples (
'Value'o'$Variable'). Si un valor de variable contiene comillas simples, debe identificar (escape) las comillas simples para expandir la variable correctamente. Por ejemplo, en lugar de'$User', use'$($User -Replace "'","''")'. No incluya enteros ni valores del sistema entre comillas (por ejemplo, use500,$true,$falseo$nullen su lugar).
Puede encadenar varios criterios de búsqueda mediante los operadores lógicos -and y -or. Por ejemplo, "Criteria1 -and Criteria2" o "(Criteria1 -and Criteria2) -or Criteria3".
Para obtener información detallada sobre los filtros de OPATH en Exchange, consulte Información adicional de la sintaxis de OPATH.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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, Exchange Online Protection |
-Identity
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 |
| Required: | False |
| 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, 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 de Exchange PowerShell y que use todo el bosque como ámbito. No es necesario especificar un valor con este modificador.
Este cambio habilita el comando tenga acceso a objetos de Active Directory que no están actualmente disponibles en el ámbito predeterminado, pero también introduce las siguientes restricciones:
- No puede usar el parámetro DomainController. El comando usa un servidor de catálogo global adecuado de forma automática.
- Sólo puede usar el DN para el parámetro Identity. No se aceptan otras formas de identificación, como alias o GUID.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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 |
| Required: | False |
| 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, Exchange Online Protection |
-IncludeSoftDeletedRecipients
El modificador IncludeSoftDeletedRecipients especifica si se deben incluir destinatarios eliminados temporalmente en los resultados. No es necesario especificar un valor con este modificador.
Los destinatarios eliminados temporalmente son destinatarios eliminados que todavía se pueden recuperar.
Nota: Use este modificador con los parámetros Identity o RecipientTypeDetails para obtener SoftDeletedRecipients.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019, Exchange Online, 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 (UO) o dominio que devuelve 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 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-Properties
Este parámetro está reservado para uso interno de Microsoft.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance, Exchange Online Protection |
-PropertySet
Este parámetro está reservado para uso interno de Microsoft.
| Type: | PropertySet |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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, 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. No es necesario especificar un valor con este modificador.
El comando : Set-AdServerSettings -ViewEntireForest $true para incluir todos los objetos en el bosque, es necesario el modificador ReadFromDomainController. De lo contrario, el comando podría usar un catálogo global que contenga información obsoleta. Además, es posible que tenga que ejecutar varias iteraciones del comando con el modificador ReadFromDomainController para obtener la información.
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 |
| Required: | False |
| 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 destinatario que usaría en un grupo de distribución dinámica, una lista de direcciones o una directiva de dirección de correo electrónico. Este parámetro usa la sintaxis de filtro LDAP.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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, Exchange Online Protection |
-RecipientType
El parámetro RecipientType filtra los resultados por el tipo de destinatario especificado. Los valores admitidos son:
- DynamicDistributionGroup
- MailContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- UserMailbox
Puede especificar distintos valores separados por comas.
| Type: | RecipientType[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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, Exchange Online Protection |
-RecipientTypeDetails
El parámetro RecipientTypeDetails filtra los resultados por el subtipo de destinatario especificado. Los valores admitidos son:
- DiscoveryMailbox
- DynamicDistributionGroup
- EquipmentMailbox
- GroupMailbox (Exchange 2013 o posterior y en la nube)
- GuestMailUser (Exchange 2016 o posterior y en la nube)
- LegacyMailbox
- LinkedMailbox
- LinkedRoomMailbox (Exchange 2013 o posterior y la nube)
- MailContact
- MailForestContact
- MailNonUniversalGroup
- MailUniversalDistributionGroup
- MailUniversalSecurityGroup
- MailUser
- PublicFolder
- PublicFolderMailbox (Exchange 2013 o posterior y en la nube)
- RemoteEquipmentMailbox
- RemoteRoomMailbox
- RemoteSharedMailbox
- RemoteTeamMailbox (Exchange 2013 o posterior y la nube)
- RemoteUserMailbox
- RoomList
- RoomMailbox
- SchedulingMailbox (Exchange 2016 o posterior y en la nube)
- SharedMailbox
- SharedWithMailUser (solo en la nube)
- TeamMailbox (Exchange 2013 o posterior y la nube)
- UserMailbox
Puede especificar distintos valores separados por comas.
El valor del parámetro RecipientType afecta a los valores que puede usar para este parámetro. Por ejemplo, si usa el valor RecipientType MailContact, 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 |
| Required: | False |
| 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, 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 |
| Required: | False |
| 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, 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 por la que va a ordenar, puede anexar el comando con | Format-Table -Auto Property1,Property2,...PropertyX. para crear una nueva vista que contenga todas las propiedades que desea ver. Se admiten caracteres comodín (*) en los nombres de propiedad.
Puede realizar la clasificación por las propiedades siguientes:
- Nombre
- DisplayName
- Alias
- Ciudad
- FirstName
- LastName
- Office
- ServerLegacyDN
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| 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, Exchange Online Protection |
Entradas
Input types
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
Output types
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.