Get-EXORecipient

Módulo:
Exchange PowerShell

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

Use el cmdlet Get-EXORecipient para ver los objetos de destinatarios 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

Identity (valor predeterminado) 

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

Anr 

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 objetos de destinatarios 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).

Ejemplos

Ejemplo 1

Get-EXORecipient -ResultSize 100

En este ejemplo se devuelven los primeros 100 objetos de destinatarios por orden de nombre.

Ejemplo 2

Get-EXORecipient -Identity john@contoso.com

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

Parámetros

-Anr

Aplicable: Exchange Online

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 puede usar este parámetro con los parámetros ExternalDirectoryObjectId, Identity, PrimarySmtpAddress o UserPrincipalName.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

Anr
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ExternalDirectoryObjectId

Aplicable: Exchange Online

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

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

Propiedades de parámetro

Tipo:Guid
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

Identity
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Filter

Aplicable: Exchange Online

El parámetro Filter utiliza la sintaxis OPATH para filtrar los resultados por las propiedades y valores especificados. Los criterios de búsqueda utilizan la sintaxis "Property -ComparisonOperator 'Value'".

  • Incluya todo el filtro OPATH entre comillas dobles " ". Si el filtro contiene valores del sistema (por ejemplo, $true, , $falseo $null), use las 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, consulte Conjuntos de propiedades Get-EXORecipient y Propiedades filtrables para el parámetro Filter.
  • ComparisonOperator es un operador de comparación OPATH (por ejemplo -eq , para la comparación 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.
  • El valor es el valor de propiedad que se va a buscar. Escriba los valores de texto y las 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 escriba enteros ni valores del sistema entre comillas (por ejemplo, use 500, $true, $false, o $null , en su lugar).

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

Para obtener información detallada sobre los filtros OPATH en Exchange, consulte Información adicional de sintaxis de OPATH.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Identity

Aplicable: Exchange Online

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

En caso 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 puede usar este parámetro con los parámetros Anr, ExternalDirectoryObjectId, PrimarySmtpAddress o UserPrincipalName.

Precaución: El valor $null o un valor inexistente para el parámetro Identity devuelve todos los objetos como si ejecutara el comando Get- sin el parámetro Identity. Compruebe que las listas de valores para el parámetro Identidad sean precisas y no contengan valores $null inexistentes.

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

Identity
Posición:0
Obligatorio:False
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-IncludeSoftDeletedRecipients

Aplicable: Exchange Online

El modificador IncludeSoftDeletedRecipients especifica si se incluirán destinatarios eliminados de forma temporal en los resultados. No es necesario especificar un valor con este modificador.

Los destinatarios eliminados temporalmente son destinatarios eliminados que aún se pueden recuperar.

Propiedades de parámetro

Tipo:SwitchParameter
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-OrganizationalUnit

Aplicable: Exchange Online

El parámetro OrganizationalUnit filtra los resultados según 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

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-PrimarySmtpAddress

Aplicable: Exchange Online

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

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

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

Identity
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Properties

Aplicable: Exchange Online

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 acerca de las propiedades disponibles, vea Conjuntos de propiedades Get-EXORecpient.

Propiedades de parámetro

Tipo:

String[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-PropertySets

Aplicable: Exchange Online

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 (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 Conjuntos de propiedades Get-EXORecpicient.

Propiedades de parámetro

Tipo:

PropertySet[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-RecipientPreviewFilter

Aplicable: Exchange Online

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

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-RecipientType

Aplicable: Exchange Online

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.

Propiedades de parámetro

Tipo:

String[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-RecipientTypeDetails

Aplicable: Exchange Online

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

  • Buzón de detección
  • DynamicDistributionGroup
  • EquipoBuzón
  • GroupMailbox
  • GuestMailUser
  • Buzón heredado
  • Buzón vinculado
  • 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 MailContact de RecipientType, no podrá usar el valor UserMailbox para este parámetro. Se produce el error: Ninguno de los RecipientTypeDetails especificados se incluye en ningún tipo de destinatario especificado.

Propiedades de parámetro

Tipo:

String[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-ResultSize

Aplicable: Exchange Online

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.

Propiedades de parámetro

Tipo:Unlimited
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-UserPrincipalName

Aplicable: Exchange Online

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

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

Propiedades de parámetro

Tipo:String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

Identity
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para más información, consulte about_CommonParameters.