Get-RemoteMailbox
Este cmdlet está disponível somente no Exchange local.
Utilize o cmdlet Get-RemoteMailbox para obter os atributos relacionados com o correio dos utilizadores na organização no local que têm caixas de correio associadas no serviço baseado na nuvem.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Sintaxe
AnrSet
Get-RemoteMailbox
[-Anr <String>]
[-Archive]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>]
Identity
Get-RemoteMailbox
[[-Identity] <RemoteMailboxIdParameter>]
[-Archive]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>]
Description
O cmdlet Get-RemoteMailbox obtém os atributos relacionados com o correio de um utilizador de correio no Active Directory local. Ela não recupera os atributos de caixa de correio baseada em nuvem associada. A maior parte dos atributos relacionados a email do usuário de email local e da caixa de correio baseada em nuvem associada devem ser os mesmos. Contudo, a caixa de correio baseada na nuvem tem atributos adicionais que você não pode visualizar usando esse cmdlet. Para ver os atributos da caixa de correio baseada na nuvem, tem de utilizar o centro de administração do Exchange no serviço baseado na nuvem ou ligar à sua organização baseada na nuvem e executar o cmdlet Get-Mailbox.
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-RemoteMailbox
Este exemplo retorna uma lista resumida de todas as caixas de correio remotas em sua organização.
Exemplo 2
Get-RemoteMailbox -Identity laura@contoso.com | Format-List
Este exemplo devolve uma informação detalhada para a caixa de correio remota para o utilizador laura@contoso.com.
Exemplo 3
$Credentials = Get-Credential
Get-RemoteMailbox -Credential $Credentials
Este exemplo usa credenciais alternativos para recuperar uma lista de um ou vários usuários habilitados para email com caixas de correio no serviço. Isto é útil se a conta que você usa normalmente não tiver permissões administrativas. As credenciais são utilizadas para aceder aos controladores de domínio Active Directory local.
Primeiro, execute o seguinte comando para lhe pedir as suas credenciais e, em seguida, armazene-as numa variável. Em seguida, obtenha uma lista de caixas de correio remotas com as credenciais que forneceu com o segundo comando.
Parâmetros
-Anr
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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 |
-Archive
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
O parâmetro Arquivo é necessário para devolver a caixa de correio de arquivo do utilizador nos resultados. 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 |
-Credential
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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.
Um valor para esse parâmetro requer o cmdlet Get-Credential. Para pausar o comando e receber uma solicitação de credenciais, use o valor (Get-Credential). Ou, antes de executar esse comando, armazene as credenciais em uma variável (por exemplo, $cred = Get-Credential) e, em seguida, use o nome da variável ($cred) para esse parâmetro. 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
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
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 no servidor Exchange e Exchange Online, veja Propriedades filtráveis para o parâmetro Filter.
- ComparisonOperator é um operador de comparação OPATH (por exemplo
-eq, para igual e-likepara 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, utilize500,$true,$falseou$nullem 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
O parâmetro Identity especifica a caixa de correio que você deseja exibir. É possível usar qualquer valor que identifique a caixa de correio remota com exclusividade. 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: | RemoteMailboxIdParameter |
| 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
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 |
-OnPremisesOrganizationalUnit
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
O parâmetro OnPremisesOrganizationalUnit filtra os resultados pela localização do objeto no Active Directory.
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 |
-ReadFromDomainController
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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 |
-ResultSize
Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE
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.
Nota: as limitações dos controladores de domínio podem afetar o número de resultados devolvidos para o valor ilimitado. Para obter mais informações, consulte este artigo.
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
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
- Alias
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.