Get-EXOMailbox
Esse cmdlet está disponível apenas no módulo Exchange Online PowerShell. Para obter mais informações, consulte Sobre o módulo Exchange Online PowerShell.
Use o cmdlet Get-EXOMailbox para exibir objetos e atributos da 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.
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
Por padrão, esse cmdlet retorna uma lista de resumo (um conjunto mínimo de propriedades) de todas as caixas de correio em sua organização.
Exemplos
Exemplo 1
Get-EXOMailbox -ResultSize unlimitedEste exemplo retorna uma lista de resumo de todas as caixas de correio da organização e inclui o conjunto padrão de propriedades de saída mínimas. Para retornar propriedades adicionais, use os parâmetros Propriedades e/ou PropertySets.
Exemplo 2
Get-EXOMailbox -PropertySets ArchiveEste exemplo retorna as Propriedades definidas no conjunto de propriedades Archive. Para obter uma lista completa dessas propriedades, consulte Conjuntos de propriedades Get-EXOMailbox.
Exemplo 3
Get-EXOMailbox -Properties Name,DistinguishedName,Guid -PropertySets Archive,AuditEste exemplo retorna uma lista de resumo de todas as caixas de correio da organização e inclui as seguintes propriedades:
- As propriedades em Conjuntos de propriedades Arquivo e Auditoria.
- As propriedades Name e DistinguishedName.
Exemplo 4
Get-EXOMailbox -Identity John@contoso.com -Properties DisplayName,EmailAddresses,AliasEste exemplo retorna as propriedades especificadas para a caixa de correio John@contoso.com.
Parâmetros
-Anr
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
Você não pode usar esse parâmetro com os parâmetros ExternalDirectoryObjectId, Identity, PrimarySmtpAddress ou UserPrincipalName.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Archive
A opção Arquivo filtra os resultados por caixas de correio que têm um arquivo habilitado (somente caixas de correio que têm uma caixa de correio de arquivo são retornadas). Não é preciso especificar um valor com essa opção.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Async
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-ExternalDirectoryObjectId
O parâmetro ExternalDirectoryObjectId identifica a caixa de correio que você deseja exibir pelo ObjectId no Azure Active Directory.
Você não pode usar esse parâmetro com os parâmetros Anr, Identity, PrimarySmtpAddress ou UserPrincipalName.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Filter
O parâmetro Filter usa a sintaxe OPATH para filtrar os resultados pelas propriedades e valores especificados. Os critérios de pesquisa usam a sintaxe "Property -ComparisonOperator 'Value'".
- Inclua todo o filtro OPATH nas aspas duplas " ". Se o filtro contiver valores do sistema (por exemplo,
$true,$falseou$null), use aspas individuais ' ' em vez disso. Embora esse parâmetro seja uma cadeia de caracteres (não um bloco do sistema), você também pode usar chaves { }, mas somente se o filtro não contiver variáveis. - A propriedade é uma propriedade filtrada. Para obter mais informações sobre as propriedades filtradas, consulte Conjuntos de propriedades Get-EXOMailbox e propriedades filtreáveis para o parâmetro Filter.
- ComparisonOperator é um operador de comparação OPATH (por exemplo
-eq, para iguais e-likepara 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. Inclua valores e variáveis de texto em aspas individuais (
'Value'ou'$Variable'). Se um valor variável contiver aspas individuais, você precisará identificar (escapar) as aspas individuais para expandir a variável corretamente. Por exemplo, em vez de'$User', use'$($User -Replace "'","''")'. Não inclua inteiros ou valores do sistema entre aspas (por exemplo, use500,$true,$falseou$nullem vez disso).
Você pode encadear vários critérios de pesquisa usando 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, consulte Informações adicionais de sintaxe OPATH.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-GroupMailbox
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Identity
O parâmetro Identity especifica a caixa de correio que você deseja exibir. Para obter o melhor desempenho, recomendamos usar os seguintes valores:
- ID de usuário ou nome UPN
- GUID
Caso contrário, você pode usar qualquer valor que identifique exclusivamente a caixa de correio. Por exemplo:
- Nome
- Alias
- Nome diferenciado (DN)
- Domain\username
- Endereço de email
- LegacyExchangeDN
- SamAccountName
Você não pode usar esse parâmetro com os parâmetros Anr, ExternalDirectoryObjectId, PrimarySmtpAddress ou UserPrincipalName.
| Type: | String |
| Position: | 0 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-InactiveMailboxOnly
A opção InactiveMailboxOnly especifica se deve retornar 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 retornar caixas de correio ativas e caixas de correio inativas nos resultados, não use essa opção. Em vez disso, use a opção IncludeInactiveMailbox.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-IncludeInactiveMailbox
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 somente caixas de correio inativas nos resultados, não use essa opção. Em vez disso, use a opção InactiveMailboxOnly.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-MailboxPlan
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.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Migration
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-OrganizationalUnit
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
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-PrimarySmtpAddress
O PrimarySmtpAddress identifica a caixa de correio que você deseja exibir por endereço de email SMTP primário (por exemplo, navin@contoso.com).
Você não pode usar esse parâmetro com os parâmetros Anr, ExternalDirectoryObjectId, Identity ou UserPrincipalName.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-Properties
O parâmetro Propriedades 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, confira Conjuntos de propriedades Get-EXOMailbox.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-PropertySets
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, confira Conjuntos de propriedades Get-EXOMailbox.
| Type: | PropertySet[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-PublicFolder
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-RecipientTypeDetails
O parâmetro RecipientTypeDetails filtra os resultados pelo subtipo de caixa de correio especificado. Os valores válidos são:
- DiscoveryMailbox
- EquipmentMailbox
- GroupMailbox
- LegacyMailbox
- LinkedMailbox
- LinkedRoomMailbox
- RoomMailbox
- SchedulingMailbox
- SharedMailbox
- TeamMailbox
- UserMailbox
Vários valores, separados por vírgulas, podem ser especificados.
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-ResultSize
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.
| Type: | Unlimited |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-SoftDeletedMailbox
A opção SoftDeletedMailbox é necessária para retornar caixas de correio excluídas suavemente 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Online |
-UserPrincipalName
O parâmetro UserPrincipalName identifica a caixa de correio que você deseja exibir por UPN (por exemplo, navin@contoso.onmicrosoft.com).
Você não pode usar esse parâmetro com os parâmetros Anr, ExternalDirectoryObjectId, Identity ou 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
Os seguintes parâmetros de Get-Mailbox não estão disponíveis ou funcionais no 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
- Servername
- AdminDisplayVersion
- DelayReleaseHoldApplied
- EnforcedTimestamps
- Descrição
- OriginatingServer
- IsValid
- ObjectState