Compartilhar via

Get-EXOMailbox

Módulo:
Exchange PowerShell

Este cmdlet só está disponível no módulo Exchange Online PowerShell. Para obter mais informações, veja Acerca do módulo Exchange Online PowerShell.

Utilize o cmdlet Get-EXOMailbox para ver objetos e atributos da caixa de correio, preencher páginas de propriedades ou fornecer informações da caixa de correio a 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 predefinição, este cmdlet devolve uma lista de resumo (um conjunto mínimo de propriedades) de todas as caixas de correio na sua organização.

Exemplos

Exemplo 1

Get-EXOMailbox -ResultSize unlimited

Este exemplo devolve uma lista de resumo de todas as caixas de correio na organização e inclui o conjunto predefinido de propriedades de saída mínimas. Para devolver propriedades adicionais, utilize os parâmetros Propriedades e/ou PropertySets.

Exemplo 2

Get-EXOMailbox -PropertySets Archive

Este exemplo devolve as Propriedades definidas no conjunto de propriedades Arquivo. Para obter uma lista completa destas propriedades, consulte Get-EXOMailbox property sets (Conjuntos de propriedades Get-EXOMailbox).

Exemplo 3

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

Este exemplo devolve uma lista de resumo de todas as caixas de correio na 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 devolve 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:

  • CommonName (CN)
  • DisplayName
  • FirstName
  • Sobrenome
  • Alias

Não pode utilizar este 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

O comutador Arquivo filtra os resultados por caixas de correio que têm um arquivo ativado (apenas são devolvidas caixas de correio que tenham uma caixa de correio de arquivo). 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 pretende ver pelo ObjectId no Microsoft Entra ID.

Não pode utilizar este 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 utiliza a sintaxe OPATH para filtrar os resultados pelas propriedades e valores especificados. Os critérios de pesquisa utilizam a sintaxe "Property -ComparisonOperator 'Value'".

  • Coloque todo o filtro OPATH entre aspas " ". Se o filtro contiver valores de sistema (por exemplo, $true, $falseou $null), utilize aspas únicas ' ' em vez disso. Embora este parâmetro seja uma cadeia (não um bloco de sistema), também pode utilizar chavetas { }, mas apenas se o filtro não contiver variáveis.
  • A propriedade é uma propriedade filtráveis. Para obter mais informações sobre as propriedades filtráveis, veja Get-EXOMailbox property sets (Conjuntos de propriedades Get-EXOMailbox) e Filterable properties (Propriedades filtráveis) para o parâmetro Filter (Filtro).
  • ComparisonOperator é um operador de comparação OPATH (por exemplo -eq , para igual e -like para comparação de cadeias). Para obter mais informações sobre operadores de comparação, veja about_Comparison_Operators.
  • Valor é o valor da propriedade a procurar. Coloque os valores de texto e as variáveis entre plicas ('Value' ou '$Variable'). Se um valor de variável contiver aspas únicas, terá de identificar (escape) as aspas únicas para expandir a variável corretamente. Por exemplo, em vez de '$User', utilize '$($User -Replace "'","''")'. Não coloque números inteiros ou valores do sistema entre aspas (por exemplo, utilize 500, $true, $falseou $null em alternativa).

Pode encadear múltiplos critérios de pesquisa em conjunto com os operadores lógicos -and e -or. Por exemplo: "Criteria1 -and Criteria2" ou "(Criteria1 -and Criteria2) -or Criteria3".

Para obter informações detalhadas sobre filtros OPATH no Exchange, veja Informações adicionais sobre 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 Identidade especifica a caixa de correio que pretende ver. Para obter o melhor desempenho, recomendamos que utilize os seguintes valores:

  • ID de usuário ou nome UPN
  • GUID

Caso contrário, pode utilizar qualquer valor que identifique exclusivamente a caixa de correio. Por exemplo:

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

Não pode utilizar este parâmetro com os parâmetros Anr, ExternalDirectoryObjectId, PrimarySmtpAddress ou UserPrincipalName.

Atenção: o valor $null ou um valor inexistente para o parâmetro Identidade devolve todos os objetos como se tivesse executado o comando Get- sem o parâmetro Identity. Verifique se as listas de valores do parâmetro Identity estão corretas 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

O comutador InactiveMailboxOnly especifica se pretende devolver apenas 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 devolver caixas de correio ativas e caixas de correio inativas nos resultados, não utilize este comutador. Em vez disso, utilize 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 devolver apenas caixas de correio inativas nos resultados, não utilize este comutador. Em vez disso, utilize 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 pretende ver pelo endereço de e-mail SMTP principal (por exemplo, navin@contoso.com).

Não pode utilizar este 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 Propriedades especifica as propriedades que são devolvidas na saída deste cmdlet. Vários valores, separados por vírgulas, podem ser especificados.

Para obter mais informações sobre as propriedades disponíveis, consulte Get-EXOMailbox property sets (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 devolvidas na saída deste cmdlet. Os valores válidos são:

  • Todos
  • Mínimo (este é o valor predefinido)
  • 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 Get-EXOMailbox property sets (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
  • Caixa de Correio de Equipamento
  • 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

O comutador SoftDeletedMailbox é necessário para devolver caixas de correio eliminadas de forma recuperável 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 pretende ver pelo UPN (por exemplo, navin@contoso.onmicrosoft.com).

Não pode utilizar este 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 suporta os 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