Get-EXOMailbox

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

Sintaxis

Identity (valor predeterminado) 

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

Anr 

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

En este ejemplo se devuelve una lista resumida de todos los buzones de correo de la organización e incluye el conjunto predeterminado de propiedades de salida mínimas. Para devolver propiedades adicionales, utilice los parámetros Properties y/o PropertySets.

Ejemplo 2

Get-EXOMailbox -PropertySets Archive

En este ejemplo se devuelven las propiedades definidas en el conjunto de propiedades de Archivo. Para obtener una lista completa de estas propiedades, consulte Conjuntos de propiedades Get-EXOMailbox.

Ejemplo 3

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

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

  • Las propiedades de los conjuntos de propiedades Archivo y Auditoría.
  • 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 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

-Archive

Aplicable: Exchange Online

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

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

-Async

Aplicable: Exchange Online

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

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

-ExternalDirectoryObjectId

Aplicable: Exchange Online

El parámetro ExternalDirectoryObjectId identifica el buzón que desea ver por el 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, vea Conjuntos de propiedades Get-EXOMailbox 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

-GroupMailbox

Aplicable: Exchange Online

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

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

-Identity

Aplicable: Exchange Online

El parámetro Identity especifica el buzón que desea ver. Para obtener el mejor rendimiento, te recomendamos que uses los siguientes valores:

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

-InactiveMailboxOnly

Aplicable: Exchange Online

El modificador InactiveMailboxOnly especifica si se devolverán solo 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 buzones activos e inactivos en los resultados, no use este modificador. En su lugar, use el modificador IncludeInactiveMailbox.

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

-IncludeInactiveMailbox

Aplicable: Exchange Online

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 los buzones inactivos en los resultados, no use este modificador. En su lugar, usa el modificador InactiveMailboxOnly.

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

-MailboxPlan

Aplicable: Exchange Online

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.

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

-Migration

Aplicable: Exchange Online

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

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 buzón 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, consulte Conjuntos de propiedades Get-EXOMailbox.

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:

  • todas
  • Mínimo (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, consulte Conjuntos de propiedades Get-EXOMailbox.

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

-PublicFolder

Aplicable: Exchange Online

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

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

-RecipientTypeDetails

Aplicable: Exchange Online

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

  • Buzón de detección
  • EquipoBuzón
  • Buzón heredado
  • Buzón vinculado
  • LinkedRoomMailbox
  • RoomMailbox
  • SchedulingMailbox
  • SharedMailbox
  • TeamMailbox
  • 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

-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

-SoftDeletedMailbox

Aplicable: Exchange Online

El modificador SoftDeletedMailbox es necesario para devolver los buzones eliminados de forma temporal 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.

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

-UserPrincipalName

Aplicable: Exchange Online

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

Entradas

Input types

Los siguientes parámetros de Get-Mailbox no están disponibles o no funcionan 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
  • Nombre del servidor
  • AdminDisplayVersion
  • DelayReleaseHoldApplied
  • Marcas de tiempo forzadas
  • Descripción
  • OriginatingServer
  • IsValid
  • Estado de objeto