Get-RemoteMailbox
Este cmdlet está disponível somente no Exchange local.
Use o cmdlet Get-RemoteMailbox para recuperar os atributos relacionados ao email dos usuários na organização local que associaram caixas de correio no serviço baseado em nuvem.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Syntax
Get-RemoteMailbox
[-Anr <String>]
[-Archive]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OnPremisesOrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-ResultSize <Unlimited>]
[-SortBy <String>]
[<CommonParameters>] 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 recupera os atributos relacionados ao email de um usuário de email 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 exibir os atributos da caixa de correio baseada em nuvem, você precisa usar o centro de administração do Exchange no serviço baseado em nuvem ou conectar-se à sua organização baseada em nuvem e executar o cmdlet Get-Mailbox.
Para executar esse cmdlet, você precisa ter permissões. Embora este tópico liste todos os parâmetros do cmdlet, talvez você não tenha acesso a alguns parâmetros se eles não estiverem incluídos nas permissões atribuídas a você. 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-RemoteMailboxEste 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-ListEste exemplo retorna uma informação detalhada para a caixa de correio remota para o usuário laura@contoso.com.
Exemplo 3
$Credentials = Get-Credential
Get-RemoteMailbox -Credential $CredentialsEste 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 usadas para acessar os controladores de domínio Active Directory local.
Primeiro, execute o comando a seguir para solicitar suas credenciais e armazená-las em uma variável. Em seguida, recupere uma lista de caixas de correio remotas usando as credenciais fornecidas usando o segundo comando.
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
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Archive
A opção Arquivo é necessária para retornar a caixa de correio de arquivo do usuário nos resultados. 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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Credential
O parâmetro Credential especifica o nome de usuário e a senha usados para executar esse 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.
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-DomainController
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.
| Type: | Fqdn |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-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 no servidor exchange e Exchange Online, consulte 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 Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Identity
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)
- Domain\username
- Endereço de email
- GUID
- LegacyExchangeDN
- SamAccountName
- ID de usuário ou nome UPN
| Type: | RemoteMailboxIdParameter |
| Position: | 1 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-IgnoreDefaultScope
A opção IgnoreDefaultScope informa ao comando para ignorar a configuração de escopo padrão do destinatário para a sessão do Exchange PowerShell e usar toda a floresta como o escopo. Não é preciso especificar um valor com essa opção.
Essa opção permite que o comando acesse objetos do Active Directory que não estão disponíveis no momento no escopo padrão, 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-OnPremisesOrganizationalUnit
O parâmetro OnPremisesOrganizationalUnit filtra os resultados pela localização do objeto no Active Directory.
A entrada válida para esse parâmetro é uma OU (unidade organizacional) ou domínio retornado 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
| Type: | OrganizationalUnitIdParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-ReadFromDomainController
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 requer a opção ReadFromDomainController. Caso contrário, o comando pode usar um catálogo global que contém informações desatualizadas. Além disso, talvez seja necessário executar várias iterações do comando com a opção ReadFromDomainController para obter as informações.
Por padrão, o escopo do destinatário é definido como o domínio que hospeda seus servidores do Exchange.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-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.
Observação: as limitações nos controladores de domínio podem afetar o número de resultados retornados para o valor ilimitado. Para obter mais informações, consulte este artigo.
| Type: | Unlimited |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-SortBy
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 exibição padrão não incluir a propriedade pela qual você está classificando, você poderá acrescentar o comando com | Format-Table -Auto Property1,Property2,...PropertyX. para criar uma nova exibição que contenha todas as propriedades que você deseja ver. Os caracteres curinga (*) nos nomes de propriedade são permitidos.
É possível classificar pelas seguintes propriedades:
- Nome
- DisplayName
- Alias
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
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.