Compartilhar via

Get-CASMailbox

Módulo:
Exchange PowerShell

Este cmdlet está disponível no Exchange local e no serviço baseado na nuvem. Alguns parâmetros e definições podem ser exclusivos de um ambiente ou outro.

Utilize o cmdlet Get-CASMailbox para ver as definições de Acesso de Cliente configuradas nas caixas de correio.

Nota: no Exchange Online PowerShell, recomendamos que utilize o cmdlet Get-EXOCASMailbox em vez deste cmdlet. Para saber mais, confira Conectar-se ao Exchange Online usando o PowerShell Remoto.

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

Sintaxe

AnrSet 

Get-CASMailbox
    [-Anr <String>]
    [-ActiveSyncDebugLogging]
    [-ActiveSyncSuppressReadReceipt]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-Monitoring]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-ProtocolSettings]
    [-ReadFromDomainController]
    [-ResultSize <Unlimited>]
    [-SortBy <String>]
    [-ReadIsOptimizedForAccessibility]
    [-RecalculateHasActiveSyncDevicePartnership]
    [-RecipientTypeDetails <RecipientTypeDetails[]>]
    [<CommonParameters>]

Identity 

Get-CASMailbox
    [[-Identity] <MailboxIdParameter>]
    [-ActiveSyncDebugLogging]
    [-ActiveSyncSuppressReadReceipt]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-Monitoring]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-ProtocolSettings]
    [-ReadFromDomainController]
    [-ResultSize <Unlimited>]
    [-SortBy <String>]
    [-ReadIsOptimizedForAccessibility]
    [-RecalculateHasActiveSyncDevicePartnership]
    [-RecipientTypeDetails <RecipientTypeDetails[]>]
    [<CommonParameters>]

Description

Esse cmdlet retorna diversas configurações de acesso de cliente para uma ou mais caixas de correio. Estas definições incluem opções para Outlook na Web, Exchange ActiveSync, POP3 e IMAP4.

Para executar esse cmdlet, você precisa ter permissões. Embora este artigo liste todos os parâmetros do cmdlet, poderá não ter acesso a alguns parâmetros se não estiverem incluídos nas permissões que lhe foram atribuídas. Para localizar as permissões necessárias para executar qualquer cmdlet ou parâmetro em sua organização, confira Find the permissions required to run any Exchange cmdlet.

Exemplos

Exemplo 1

Get-CASMailbox "Jeff Hay"

Este exemplo retorna os valores das seguintes configurações de acesso de cliente para o usuário chamado Jeff Hay.

  • ActiveSyncEnabled
  • OWAEnabled
  • PopEnabled
  • ImapEnabled
  • MapiEnabled

Exemplo 2

Get-CASMailbox tony@contoso.com | Format-List Imap*

Este exemplo devolve todas as definições de IMAP4 para o utilizador tony@contoso.com.

Exemplo 3

Get-CASMailbox chris@contoso.com | Format-List Ews*

Este exemplo devolve todas as definições de Serviços Web do Exchange para o utilizador chris@contoso.com.

Exemplo 4

Get-CASMailbox -RecipientTypeDetails SharedMailbox | Select *

No Exchange Online, este exemplo filtra a saída do cmdlet para incluir apenas caixas de correio partilhadas.

Parâmetros

-ActiveSyncDebugLogging

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

A opção ActiveSyncDebugLogging exibe o valor real da propriedade ActiveSyncDebugLogging para a caixa de correio. Não é preciso especificar um valor com essa opção.

Se você não usar essa opção, o valor sempre aparecerá como $false.

Para ver esse valor, você precisa usar um cmdlet de formatação. Por exemplo, Get-CasMailbox laura@contoso.com -ActiveSyncDebugLogging | Format-List.

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

-ActiveSyncSuppressReadReceipt

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, 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

-Anr

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, 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

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-Credential

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O parâmetro Credential especifica o nome de utilizador e a palavra-passe utilizados para executar este comando. Normalmente, você usa esse parâmetro em scripts ou quando você precisa fornecer credenciais diferentes que têm as permissões necessárias.

Esse parâmetro exige a criação e a passagem de um objeto de credencial. Esse objeto de credencial é criado com o cmdlet Get-Credential. Para saber mais, confira Obter credencial.

Propriedades do parâmetro

Tipo:PSCredential
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

-DomainController

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Este parâmetro está disponível somente no Exchange local.

O parâmetro DomainController especifica o controlador de domínio que é usado por esse cmdlet para ler dados ou gravar dados no Active Directory. Você identifica o controlador de domínio por seu FQDN (nome de domínio totalmente qualificado). Por exemplo, dc01.contoso.com.

Propriedades do parâmetro

Tipo:Fqdn
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

-Filter

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, 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 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 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

-Identity

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O parâmetro Identity especifica a caixa de correio que você deseja exibir. É possível usar qualquer valor que identifique a caixa de correio exclusivamente. Por exemplo:

  • Nome
  • Alias
  • Nome diferenciado (DN)
  • Nome diferenciado (DN)
  • Domínio\Nome de Utilizador
  • Endereço de email
  • GUID
  • LegacyExchangeDN
  • SamAccountName
  • ID de usuário ou nome UPN

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:MailboxIdParameter
Valor padrão:None
Dá suporte a curingas:False
DontShow:False

Conjuntos de parâmetros

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

-IgnoreDefaultScope

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O comutador IgnoreDefaultScope indica ao comando para ignorar a definição de âmbito de destinatário predefinida para a sessão do Exchange PowerShell e utilizar toda a floresta como âmbito. Não é preciso especificar um valor com essa opção.

Este comutador permite que o comando aceda a objetos do Active Directory que não estão atualmente disponíveis no âmbito predefinido, mas também introduz as seguintes restrições:

  • Não é possível usar o parâmetro DomainController. O comando usa um servidor de catálogo global adequado automaticamente.
  • Não é possível usar o parâmetro DomainController. O comando usa um servidor de catálogo global adequado automaticamente.

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

-Monitoring

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Este parâmetro está disponível somente no Exchange local.

O comutador Monitorização é necessário para devolver caixas de correio de monitorização nos resultados. Não é preciso especificar um valor com essa opção.

As caixas de correio de monitorização estão associadas à disponibilidade gerida e ao serviço Exchange Health Manager e têm um valor de propriedade RecipientTypeDetails de MonitoringMailbox.

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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, 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 este parâmetro é uma unidade organizacional (UO) ou domínio que é devolvido pelo 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:OrganizationalUnitIdParameter
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

-ProtocolSettings

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

A opção ProtocolSettings retorna os nomes de servidor, as portas TCP e os métodos de criptografia para as seguintes configurações:

  • ExternalImapSettings
  • InternalImapSettings
  • ExternalPopSettings
  • InternalPopSettings
  • ExternalSmtpSettings
  • InternalSmtpSettings

Não é preciso especificar um valor com essa opção.

Para ver esses valores, você precisa usar um cmdlet de formatação. Por exemplo, Get-CasMailbox laura@contoso.com -ProtocolSettings | Format-List.

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

-ReadFromDomainController

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE

Este parâmetro está disponível somente no Exchange local.

A opção ReadFromDomainController especifica se as informações devem ser lidas de um controlador de domínio no domínio do usuário. Não é preciso especificar um valor com essa opção.

O comando: Set-AdServerSettings -ViewEntireForest $true para incluir todos os objetos na floresta, é necessário o comutador ReadFromDomainController. Caso contrário, o comando poderá utilizar um catálogo global que contenha informações desatualizadas. Além disso, poderá ter de executar várias iterações do comando com o comutador ReadFromDomainController para obter as informações.

Por predefinição, o âmbito do destinatário está definido como o domínio que aloja os seus servidores Exchange.

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

-ReadIsOptimizedForAccessibility

Aplicável: Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O comutador ReadIsOptimizedForAccessibility especifica se pretende ler o valor da propriedade IsOptimizedForAccessibility na caixa de correio (se a caixa de correio está configurada para utilizar a versão simplificada do Outlook na Web). 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

-RecalculateHasActiveSyncDevicePartnership

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

A opção RecalculateHasActiveSyncDevicePartnership recalcula o valor da propriedade HasActiveSyncDevicePartnership da caixa de correio. Não é preciso especificar um valor com essa opção.

O valor será atualizado automaticamente se estiver incorreto.

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, Proteção do Exchange Online

Esse parâmetro só está disponível no serviço baseado em nuvem.

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

  • DiscoveryMailbox
  • Caixa de Correio de Equipamento
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox
  • MailUser
  • RoomMailbox
  • SharedMailbox
  • TeamMailbox
  • UserMailbox

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

Propriedades do parâmetro

Tipo:

RecipientTypeDetails[]

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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, 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

-SortBy

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online

O parâmetro SortBy especifica a propriedade pela qual classificar os resultados. Você pode classificar apenas por uma propriedade de cada vez. Os resultados são classificados em ordem crescente.

Se a vista predefinida não incluir a propriedade pela qual está a ordenar, pode acrescentar o comando com | Format-Table -Auto Property1,Property2,...PropertyX. para criar uma nova vista que contenha todas as propriedades que pretende ver. Os caracteres curinga (*) nos nomes de propriedade são permitidos.

É possível classificar pelas seguintes propriedades:

  • Nome
  • DisplayName
  • ServerLegacyDN

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

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

Para ver os tipos de entrada que este cmdlet aceita, confira Tipos de entrada e saída de cmdlet. Se o campo Tipo de Entrada de um cmdlet estiver em branco, isso significa que o cmdlet não aceita dados de entrada.

Saídas

Output types

Para ver os tipos de retorno, também conhecidos como tipos de saída, que este cmdlet aceita, consulte Tipos de entrada e saída de cmdlet. Se o campo Tipo de Saída estiver em branco, o cmdlet não retorna dados.