Get-EXOMailbox

Módulo:
Exchange PowerShell

Este cmdlet está disponível somente no módulo do PowerShell do Exchange Online. Para obter mais informações, consulte Sobre o módulo do PowerShell do Exchange Online.

Use o cmdlet Get-EXOMailbox para exibir objetos e atributos de caixa de correio, preencher páginas de propriedades ou fornecer informações de caixa de correio para outras tarefas.

Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.

Sintaxe

Identity (Default) 

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

Por padrão, esse cmdlet retorna uma lista resumida (um conjunto mínimo de propriedades) de todas as caixas de correio em sua organização.

Exemplos

Exemplo 1

Get-EXOMailbox -ResultSize unlimited

Este exemplo retorna uma lista resumida de todas as caixas de correio da organização e inclui o conjunto padrão de propriedades mínimas de saída. Para retornar propriedades adicionais, use os parâmetros Properties e/ou PropertySets.

Exemplo 2

Get-EXOMailbox -PropertySets Archive

Este exemplo retorna as Propriedades definidas no conjunto de propriedades do Arquivo. Para obter uma lista completa dessas propriedades, consulte Conjuntos de propriedades Get-EXOMailbox.

Exemplo 3

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

Este exemplo retorna uma lista resumida de todas as caixas de correio da organização e inclui as seguintes propriedades:

  • As propriedades nos conjuntos de propriedades Arquivo e Auditoria.
  • As propriedades Name e DistinguishedName.

Exemplo 4

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

Este exemplo retorna as propriedades especificadas para a caixa de correio John@contoso.com.

Parâmetros

-Anr

Aplicável: Exchange Online

O parâmetro Anr especifica uma cadeia de caracteres na qual executar uma pesquisa ANR (resolução de nomes ambíguos). Você pode especificar uma cadeia de caracteres parcial para objetos com um atributo correspondente a esta cadeia de caracteres. Os atributos padrão pesquisados são:

  • Nome comum (CN)
  • DisplayName
  • FirstName
  • Sobrenome
  • Alias

Não é possível usar esse parâmetro com os parâmetros ExternalDirectoryObjectId, Identity, PrimarySmtpAddress ou UserPrincipalName.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Anr
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Archive

Aplicável: Exchange Online

A opção Arquivo filtra os resultados por caixas de correio que têm um arquivo morto habilitado (somente caixas de correio que têm uma caixa de correio de arquivo morto são retornadas). Não é preciso especificar um valor com essa opção.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Async

Aplicável: Exchange Online

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ExternalDirectoryObjectId

Aplicável: Exchange Online

O parâmetro ExternalDirectoryObjectId identifica a caixa de correio que você deseja exibir pelo ObjectId no Microsoft Entra ID.

Não é possível usar esse parâmetro com os parâmetros Anr, Identity, PrimarySmtpAddress ou UserPrincipalName.

Propriedades do parâmetro

Tipo:Guid
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Identity
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Filter

Aplicável: Exchange Online

O parâmetro Filter usa a sintaxe OPATH para filtrar os resultados pelas propriedades e valores especificados. O critério de pesquisa usa a sintaxe "Property -ComparisonOperator 'Value'".

  • Coloque todo o filtro OPATH entre aspas duplas " ". Se o filtro contiver valores do sistema (por exemplo, $true, $false, ou $null), use aspas simples " '. Embora esse parâmetro seja uma cadeia de caracteres (não um bloco do sistema), você também poderá usar chaves { }, mas somente se o filtro não contiver variáveis.
  • A propriedade é uma propriedade filtrável. Para obter mais informações sobre as propriedades filtráveis, consulte Conjuntos de propriedades Get-EXOMailbox e Propriedades filtráveis para o parâmetro Filter.
  • ComparisonOperator é um operador de comparação OPATH (por exemplo, -eq para igual e -like para comparação de cadeia de caracteres). Para obter mais informações sobre operadores de comparação, consulte about_Comparison_Operators.
  • Valor é o valor da propriedade a ser pesquisado. Coloque os valores de texto e variáveis entre aspas simples ('Value' ou '$Variable'). Se um valor de variável contiver aspas simples, você precisará identificar (escapar) as aspas simples para expandir a variável corretamente. Por exemplo, em vez de '$User', use '$($User -Replace "'","''")'. Não coloque números inteiros ou valores do sistema entre aspas (por exemplo, use 500, $true, $false, ou $null em vez disso).

Você pode encadear vários critérios de pesquisa usando os operadores -and lógicos e -or. Por exemplo: "Criteria1 -and Criteria2" ou "(Criteria1 -and Criteria2) -or Criteria3".

Para obter informações detalhadas sobre filtros OPATH no Exchange, consulte Informações adicionais de sintaxe OPATH.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-GroupMailbox

Aplicável: Exchange Online

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Identity

Aplicável: Exchange Online

O parâmetro Identity especifica a caixa de correio que você deseja exibir. Para obter o melhor desempenho, recomendamos o uso dos seguintes valores:

  • ID de usuário ou nome UPN
  • GUID

Caso contrário, você poderá usar qualquer valor que identifique exclusivamente a caixa de correio. Por exemplo:

  • Nome
  • Alias
  • Nome diferenciado (DN)
  • Domínio\Nome de usuário
  • Endereço de email
  • LegacyExchangeDN
  • SamAccountName

Não é possível usar esse parâmetro com os parâmetros Anr, ExternalDirectoryObjectId, PrimarySmtpAddress ou UserPrincipalName.

Cuidado: O valor $null ou um valor inexistente para o parâmetro Identity retorna todos os objetos como se você tivesse executado o comando Get- sem o parâmetro Identity. Verifique se todas as listas de valores para o parâmetro Identity são precisas e não contêm valores de $null inexistentes.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Identity
Cargo:0
Obrigatório:False
Valor do pipeline:True
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-InactiveMailboxOnly

Aplicável: Exchange Online

A opção InactiveMailboxOnly especifica se as caixas de correio inativas devem ser retornadas nos resultados. Não é preciso especificar um valor com essa opção.

Uma caixa de correio inativa é uma caixa de correio colocada em Suspensão de Litigação ou Suspensão no Local antes de uma exclusão reversível. O conteúdo de uma caixa de correio inativa é preservado até que a retenção seja removida.

Para retornar caixas de correio ativas e inativas nos resultados, não use essa opção. Em vez disso, use o comutador IncludeInactiveMailbox.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-IncludeInactiveMailbox

Aplicável: Exchange Online

A opção IncludeInactiveMailbox especifica se é necessário incluir caixas de correio inativas nos resultados. Não é preciso especificar um valor com essa opção.

Uma caixa de correio inativa é uma caixa de correio colocada em Suspensão de Litigação ou Suspensão no Local antes de uma exclusão reversível. O conteúdo de uma caixa de correio inativa é preservado até que a retenção seja removida.

Para retornar apenas caixas de correio inativas nos resultados, não use essa opção. Em vez disso, use o comutador InactiveMailboxOnly.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-MailboxPlan

Aplicável: Exchange Online

O parâmetro MailboxPlan filtra os resultados por plano de caixa de correio. Quando você usa esse parâmetro, apenas as caixas de correio que são atribuídas ao plano de caixa de correio são retornadas nos resultados. É possível usar qualquer valor que identifique o plano de caixa de correio com exclusividade. Por exemplo:

  • Nome
  • Alias
  • Nome para exibição
  • DN (nome diferenciado)
  • GUID

Um plano de caixa de correio especifica as permissões e os recursos disponíveis para um usuário de caixa de correio em organizações baseadas em nuvem. Você pode ver os planos de caixa de correio disponíveis usando o cmdlet Get-MailboxPlan.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-Migration

Aplicável: Exchange Online

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-OrganizationalUnit

Aplicável: Exchange Online

O parâmetro OrganizationalUnit filtra os resultados com base na localização do objeto no Active Directory. Somente objetos que existem na localização especificada são retornados. A entrada válida para esse parâmetro é uma UO (unidade organizacional) ou um domínio que fique visível na utilização do cmdlet Get-OrganizationalUnit. É possível usar qualquer valor que identifique a UO ou o domínio com exclusividade. Por exemplo:

  • Nome
  • Nome
  • Nome diferenciado (DN)
  • GUID

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PrimarySmtpAddress

Aplicável: Exchange Online

O PrimarySmtpAddress identifica a caixa de correio que você deseja exibir pelo endereço de email SMTP primário (por exemplo, navin@contoso.com).

Não é possível usar esse parâmetro com os parâmetros Anr, ExternalDirectoryObjectId, Identity ou UserPrincipalName.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Identity
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

-Properties

Aplicável: Exchange Online

O parâmetro Properties especifica as propriedades retornadas na saída desse cmdlet. Vários valores, separados por vírgulas, podem ser especificados.

Para obter mais informações sobre as propriedades disponíveis, consulte Conjuntos de propriedades Get-EXOMailbox.

Propriedades do parâmetro

Tipo:

String[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PropertySets

Aplicável: Exchange Online

O parâmetro PropertySets especifica um agrupamento lógico de propriedades que são retornadas na saída desse cmdlet. Os valores válidos são:

  • Todos
  • Mínimo (este é o valor padrão)
  • AddressList
  • Arquivar
  • Auditoria
  • Personalizado
  • Entrega
  • Retenção
  • Moderação
  • Mover
  • Política
  • PublicFolder
  • Cota
  • Recurso
  • Retenção
  • SCL
  • SoftDelete
  • StatisticsSeed

Vários valores, separados por vírgulas, podem ser especificados.

Para obter mais informações sobre as propriedades incluídas em cada conjunto de propriedades, consulte Conjuntos de propriedades Get-EXOMailbox.

Propriedades do parâmetro

Tipo:

PropertySet[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-PublicFolder

Aplicável: Exchange Online

Esse parâmetro está reservado para uso interno da Microsoft.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-RecipientTypeDetails

Aplicável: Exchange Online

O parâmetro RecipientTypeDetails filtra os resultados pelo subtipo de caixa de correio especificado. Os valores válidos são:

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

Vários valores, separados por vírgulas, podem ser especificados.

Propriedades do parâmetro

Tipo:

String[]

Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-ResultSize

Aplicável: Exchange Online

O parâmetro ResultSize especifica o número máximo de resultados a serem retornados. Caso pretenda retornar todas as solicitações correspondentes à consulta, use unlimited como valor desse parâmetro. O valor padrão é 1000.

Propriedades do parâmetro

Tipo:Unlimited
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-SoftDeletedMailbox

Aplicável: Exchange Online

A opção SoftDeletedMailbox é necessária para retornar caixas de correio excluídas temporariamente nos resultados. Não é preciso especificar um valor com essa opção.

Caixas de correio excluídas de forma flexível são caixas de correio excluídas e que ainda podem ser recuperadas.

Propriedades do parâmetro

Tipo:SwitchParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

(All)
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:False
Valor dos argumentos restantes:False

-UserPrincipalName

Aplicável: Exchange Online

O parâmetro UserPrincipalName identifica a caixa de correio que você deseja exibir por UPN (por exemplo, navin@contoso.onmicrosoft.com).

Não é possível usar esse parâmetro com os parâmetros Anr, ExternalDirectoryObjectId, Identity ou PrimarySmtpAddress.

Propriedades do parâmetro

Tipo:String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

Identity
Cargo:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline pelo nome da propriedade:True
Valor dos argumentos restantes:False

CommonParameters

Este cmdlet dá suporte aos parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, confira about_CommonParameters.

Entradas

Input types

Os seguintes parâmetros de Get-Mailbox não estão disponíveis ou funcionais em Get-EXOMailbox:

  • Async
  • GroupMailbox
  • Migração
  • PublicFolder
  • SortBy

Saídas

Output types

As seguintes propriedades não estão incluídas na saída de Get-EXOMailbox:

  • RunspaceId
  • Nome do servidor
  • AdminDisplayVersion
  • DelayReleaseHoldApplied
  • EnforcedTimestamps
  • Descrição
  • OriginatingServer
  • IsValid
  • ObjectState