Get-EXOMailbox

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-EXOMailbox para ver objetos y atributos de buzón de correo, rellenar páginas de propiedades o proporcionar información de buzón a otras tareas.

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-EXOMailbox
   [[-Identity] <String>]
   [-Archive]
   [-Async]
   [-ExternalDirectoryObjectId <Guid>]
   [-Filter <String>]
   [-GroupMailbox]
   [-InactiveMailboxOnly]
   [-IncludeInactiveMailbox]
   [-MailboxPlan <String>]
   [-Migration]
   [-OrganizationalUnit <String>]
   [-PrimarySmtpAddress <String>]
   [-Properties <String[]>]
   [-PropertySets <PropertySet[]>]
   [-PublicFolder]
   [-RecipientTypeDetails <String[]>]
   [-ResultSize <Unlimited>]
   [-SoftDeletedMailbox]
   [-UserPrincipalName <String>]
   [<CommonParameters>]
Get-EXOMailbox
   [-Anr <String>]
   [-Archive]
   [-Async]
   [-Filter <String>]
   [-GroupMailbox]
   [-InactiveMailboxOnly]
   [-IncludeInactiveMailbox]
   [-MailboxPlan <String>]
   [-Migration]
   [-OrganizationalUnit <String>]
   [-Properties <String[]>]
   [-PropertySets <PropertySet[]>]
   [-PublicFolder]
   [-RecipientTypeDetails <String[]>]
   [-ResultSize <Unlimited>]
   [-SoftDeletedMailbox]
   [<CommonParameters>]

Description

De forma predeterminada, este cmdlet devuelve una lista de resumen (un conjunto mínimo de propiedades) de todos los buzones de correo de la organización.

Ejemplos

Ejemplo 1

Get-EXOMailbox -ResultSize unlimited

Este ejemplo devuelve una lista de resumen de todos los buzones de la organización e incluye el conjunto predeterminado de propiedades de salida mínimas. Para devolver propiedades adicionales, use los parámetros Properties o PropertySets.

Ejemplo 2

Get-EXOMailbox -PropertySets Archive

Este ejemplo devuelve las propiedades definidas en el conjunto de propiedades Archive. Para obtener una lista completa de estas propiedades, vea Conjuntos de propiedades Get-EXOMailbox.

Ejemplo 3

Get-EXOMailbox -Properties Name,DistinguishedName,Guid -PropertySets Archive,Audit

En este ejemplo se devuelve una lista de resumen de todos los buzones de la organización e se incluyen las siguientes propiedades:

  • Propiedades de los conjuntos de propiedades Archive y Audit.
  • Las propiedades Name y DistinguishedName.

Ejemplo 4

Get-EXOMailbox -Identity John@contoso.com -Properties DisplayName,EmailAddresses,Alias

En este ejemplo se devuelven las propiedades especificadas para el buzón de correo 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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Archive

El modificador Archivo filtra los resultados por buzones que tienen habilitado un archivo (solo se devuelven los buzones que tienen un buzón de archivo). No es necesario especificar un valor con este modificador.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Async

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-ExternalDirectoryObjectId

El parámetro ExternalDirectoryObjectId identifica el buzón que desea ver mediante ObjectId en Azure Active Directory.

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

Type:Guid
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to: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 Conjuntos de propiedades Get-EXOMailbox y Propiedades filtrables para el parámetro Filter.
  • 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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-GroupMailbox

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Identity

El parámetro Identity especifica el buzón que desea ver. Para obtener el mejor rendimiento, se recomienda usar los valores siguientes:

  • 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 el buzón. 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.

Type:String
Position:0
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Online

-InactiveMailboxOnly

El modificador InactiveMailboxOnly especifica si se deben devolver solo buzones inactivos en los resultados. No es necesario especificar un valor con este modificador.

Un buzón inactivo es un buzón que se pone en modo de retención por juicio o en conservación local antes de ser eliminado temporalmente. El contenido de un buzón inactivo se conserva hasta que se elimina la retención.

Para devolver tanto buzones activos como buzones inactivos en los resultados, no use este modificador. En su lugar, use el modificador IncludeInactiveMailbox.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-IncludeInactiveMailbox

El modificador IncludeInactiveMailbox especifica si se incluyen los buzones inactivos en los resultados. No es necesario especificar un valor con este modificador.

Un buzón inactivo es un buzón que se pone en modo de retención por juicio o en conservación local antes de ser eliminado temporalmente. El contenido de un buzón inactivo se conserva hasta que se elimina la retención.

Para devolver solo buzones inactivos en los resultados, no use este modificador. En su lugar, use el modificador InactiveMailboxOnly.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-MailboxPlan

El parámetro MailboxPlan filtra los resultados por plan de buzón. Cuando se utiliza este parámetro, en los resultados solo se devuelven los buzones que tienen asignado el plan de buzón especificado. Es posible usar cualquier valor que identifique de forma exclusiva el plan de buzón. Por ejemplo:

  • Nombre
  • Alias
  • Nombre para mostrar
  • Nombre distintivo (DN)
  • GUID

Un plan de buzón especifica los permisos y las características disponibles para un usuario de buzón en organizaciones basadas en la nube. Puede ver los planes de buzón disponibles mediante el cmdlet Get-MailboxPlan.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-Migration

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to: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
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-PrimarySmtpAddress

PrimarySmtpAddress identifica el buzón 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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to: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 Conjuntos de propiedades Get-EXOMailbox.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to: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:

  • todas
  • Mínimo (este es el valor predeterminado)
  • AddressList
  • Archivar
  • Auditoría
  • Personalizado
  • Entrega
  • Hold
  • Moderación
  • Mover
  • Policy
  • PublicFolder
  • Quota
  • Recurso
  • Retención
  • SCL
  • SoftDelete
  • StatisticsSeed

Puede especificar distintos valores separados por comas.

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

Type:PropertySet[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-PublicFolder

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

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-RecipientTypeDetails

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

  • DiscoveryMailbox
  • EquipmentMailbox
  • GroupMailbox
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox
  • RoomMailbox
  • SchedulingMailbox
  • SharedMailbox
  • TeamMailbox
  • UserMailbox

Puede especificar distintos valores separados por comas.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to: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.

Type:Unlimited
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-SoftDeletedMailbox

El modificador SoftDeletedMailbox es necesario para devolver buzones eliminados temporalmente en los resultados. No es necesario especificar un valor con este modificador.

Los buzones de correo eliminados temporalmente son buzones de correo que se han eliminado pero que todavía se pueden recuperar.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False
Applies to:Exchange Online

-UserPrincipalName

El parámetro UserPrincipalName identifica el buzón 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.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:True
Accept wildcard characters:False
Applies to:Exchange Online

Entradas

Input types

Los siguientes parámetros de Get-Mailbox no están disponibles ni son funcionales en Get-EXOMailbox:

  • Async
  • GroupMailbox
  • Migración
  • PublicFolder
  • SortBy

Salidas

Output types

Las siguientes propiedades no se incluyen en la salida de Get-EXOMailbox:

  • RunspaceId
  • Nombredeservidor
  • AdminDisplayVersion
  • DelayReleaseHoldApplied
  • EnforcedTimestamps
  • Descripción
  • OriginatingServer
  • IsValid
  • ObjectState