Compartir a través de

Get-EXORecipient

  • Referencia
Módulo:
ExchangePowerShell
Se aplica a:
Exchange Online

Este cmdlet solo está disponible en el módulo de PowerShell Exchange Online. Para obtener más información, vea Acerca de la Exchange Online módulo de PowerShell.

Use el cmdlet Get-EXORecipient para ver los objetos de destinatario existentes en su 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).

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.

Sintaxis

Get-EXORecipient
   [[-Identity] <String>]
   [-ExternalDirectoryObjectId <Guid>]
   [-Filter <String>]
   [-IncludeSoftDeletedRecipients]
   [-OrganizationalUnit <String>]
   [-PrimarySmtpAddress <String>]
   [-Properties <String[]>]
   [-PropertySets <PropertySet[]>]
   [-RecipientPreviewFilter <String>]
   [-RecipientType <String[]>]
   [-RecipientTypeDetails <String[]>]
   [-ResultSize <Unlimited>]
   [-UserPrincipalName <String>]
   [<CommonParameters>]
Get-EXORecipient
   [-Anr <String>]
   [-Filter <String>]
   [-IncludeSoftDeletedRecipients]
   [-OrganizationalUnit <String>]
   [-Properties <String[]>]
   [-PropertySets <PropertySet[]>]
   [-RecipientPreviewFilter <String>]
   [-RecipientType <String[]>]
   [-RecipientTypeDetails <String[]>]
   [-ResultSize <Unlimited>]
   [<CommonParameters>]

Description

Get-EXORecipient cmdlet se puede usar 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).

Ejemplos

Ejemplo 1

Get-EXORecipient -ResultSize 100

En este ejemplo se devuelven los primeros 100 objetos de destinatario en orden de nombre.

Ejemplo 2

Get-EXORecipient -Identity john@contosot.com

En este ejemplo se devuelven los detalles del atributo de destinatario para el usuario. john@contoso.com

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

No se puede usar este parámetro con los parámetros ExternalDirectoryObjectId, Identity, PrimarySmtpAddress o UserPrincipalName.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False
Se aplica a:Exchange Online

-ExternalDirectoryObjectId

El parámetro ExternalDirectoryObjectId identifica el destinatario que desea ver por objectId en Microsoft Entra ID.

No se puede usar este parámetro con los parámetros Anr, Identity, PrimarySmtpAddress o UserPrincipalName.

Tipo:Guid
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False
Se aplica a:Exchange Online

-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, vea Get-EXORecipient property sets and Filterable properties for the Filter parameter.
  • ComparisonOperator es un operador de comparación de OPATH (por ejemplo -eq , para igual y -like para 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, use 500, $true, $falseo $null en 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.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False
Se aplica a:Exchange Online

-Identity

El parámetro Identity especifica el objeto de destinatario que desea ver. Para obtener el mejor rendimiento, se recomienda usar los siguientes valores para identificar al destinatario:

  • ID de usuario o nombre de la entidad de seguridad de usuario (UPN)
  • GUID

De lo contrario, puede usar cualquier valor que identifique de forma única al destinatario. Por ejemplo:

  • Nombre
  • Alias
  • Nombre distintivo (DN)
  • Dominio\Nombre de usuario
  • Dirección de correo electrónico
  • LegacyExchangeDN
  • SamAccountName

No se puede usar este parámetro con los parámetros Anr, ExternalDirectoryObjectId, PrimarySmtpAddress o UserPrincipalName.

Tipo:String
Posición:0
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False
Se aplica a:Exchange Online

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

Tipo:SwitchParameter
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False
Se aplica a:Exchange Online

-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. Para este parámetro se puede especificar una unidad organizativa (OU) o dominio visible mediante 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
Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False
Se aplica a:Exchange Online

-PrimarySmtpAddress

PrimarySmtpAddress identifica el destinatario que desea ver por dirección de correo electrónico SMTP principal (por ejemplo, navin@contoso.com).

No se puede usar este parámetro con los parámetros Anr, ExternalDirectoryObjectId, Identity o UserPrincipalName.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False
Se aplica a:Exchange Online

-Properties

El parámetro Properties especifica las propiedades que se devuelven en la salida de este cmdlet. Puede especificar distintos valores separados por comas.

Para obtener más información sobre las propiedades disponibles, vea Get-EXORecipient property sets.

Tipo:String[]
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False
Se aplica a:Exchange Online

-PropertySets

El parámetro PropertySets especifica una agrupación lógica de propiedades que se devuelven en la salida de este cmdlet. Los valores admitidos son:

  • Mínimo (este es el valor predeterminado)
  • Archivar
  • Personalizado
  • MailboxMove
  • Policy

Para obtener más información sobre las propiedades que se incluyen en cada conjunto de propiedades, vea Get-EXORecipient property sets.

Tipo:PropertySet[]
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False
Se aplica a:Exchange Online

-RecipientPreviewFilter

Este parámetro está reservado para uso interno de Microsoft.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False
Se aplica a:Exchange Online

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

Tipo:String[]
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False
Se aplica a:Exchange Online

-RecipientTypeDetails

El parámetro RecipientTypeDetails filtra los resultados por el subtipo de destinatario especificado. Los valores admitidos 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
  • SharedWithMailUser
  • TeamMailbox
  • 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.

Tipo:String[]
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False
Se aplica a:Exchange Online

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

Tipo:Unlimited
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:False
Aceptar caracteres comodín:False
Se aplica a:Exchange Online

-UserPrincipalName

El parámetro UserPrincipalName identifica el destinatario que quiere ver por UPN (por ejemplo, navin@contoso.onmicrosoft.com).

No se puede usar este parámetro con los parámetros Anr, ExternalDirectoryObjectId, Identity o PrimarySmtpAddress.

Tipo:String
Posición:Named
Valor predeterminado:None
Requerido:False
Aceptar entrada de canalización:True
Aceptar caracteres comodín:False
Se aplica a:Exchange Online