Get-MailUser
Este cmdlet está disponível no Exchange local e no serviço baseado na nuvem. Alguns parâmetros e configurações podem ser exclusivos de um ou outro ambiente.
Utilize o cmdlet Get-MailUser para ver utilizadores de correio e também utilizadores convidados para Grupos do Microsoft 365 em ambientes na cloud.
Para saber mais sobre os conjuntos de parâmetros na seção Sintaxe, abaixo, consulte Exchange cmdlet syntax.
Sintaxe
Get-MailUser
[-Anr <String>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-ResultSize <Unlimited>]
[-SharedWithMailUser]
[-SoftDeletedMailUser]
[-SortBy <String>]
[<CommonParameters>]
Get-MailUser
[[-Identity] <MailUserIdParameter>]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ReadFromDomainController]
[-ResultSize <Unlimited>]
[-SharedWithMailUser]
[-SoftDeletedMailUser]
[-SortBy <String>]
[<CommonParameters>]
Get-MailUser
[-LOBAppAccount]
[-Filter <String>]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ProgressAction <ActionPreference>]
[-ResultSize <Unlimited>]
[-SharedWithMailUser]
[-SoftDeletedMailUser]
[-SortBy <String>]
[<CommonParameters>]
Get-MailUser
[-HVEAccount]
[-Filter <String>]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-ResultSize <Unlimited>]
[-SharedWithMailUser]
[-SortBy <String>]
[-SoftDeletedMailUser]
[<CommonParameters>]
Description
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-MailUser
Esse exemplo retorna uma lista resumida de todos os usuários de email da organização.
Exemplo 2
Get-MailUser -Identity Ed | Format-List
Este exemplo devolve informações detalhadas para o utilizador de correio com o nome Ed.
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
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-Credential
Este parâmetro está disponível somente no Exchange local.
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.
Tipo: | PSCredential |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-DomainController
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.
Tipo: | Fqdn |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-Filter
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
,$false
ou$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-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, utilize500
,$true
,$false
ou$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.
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-HVEAccount
Esse parâmetro só está disponível no serviço baseado em nuvem.
O comutador HVEAccount especifica que esta conta de utilizador de correio é especificamente utilizada para o serviço de e-mail de volume elevado. Não é preciso especificar um valor com essa opção.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Exchange Online, Exchange Online Protection |
-Identity
O parâmetro Identidade especifica o utilizador de correio que pretende ver. É possível usar qualquer valor que identifique exclusivamente o usuário do email. Por exemplo:
- Nome
- Alias
- Nome diferenciado (DN)
- Nome diferenciado (DN)
- DN canônico
- GUID
Tipo: | MailUserIdParameter |
Cargo: | 1 |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-IgnoreDefaultScope
Este parâmetro está disponível somente no Exchange local.
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.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019 |
-LOBAppAccount
Esse parâmetro só está disponível no serviço baseado em nuvem.
{{ Fill LOBAppAccount Description }}
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Exchange Online, Exchange Online Protection |
-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 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
Tipo: | OrganizationalUnitIdParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-ReadFromDomainController
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.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | 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.
Tipo: | Unlimited |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
-SharedWithMailUser
Esse parâmetro só está disponível no serviço baseado em nuvem.
{{ Fill SharedWithMailUser Description }}
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Exchange Online, Exchange Online Protection |
-SoftDeletedMailUser
Esse parâmetro só está disponível no serviço baseado em nuvem.
O comutador SoftDeletedMailUser especifica se pretende incluir utilizadores de e-mail eliminados de forma recuperável nos resultados. Não é preciso especificar um valor com essa opção.
Os utilizadores de correio eliminados de forma recuperável são utilizadores de correio eliminados que ainda são recuperáveis.
Tipo: | SwitchParameter |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Exchange Online, Exchange Online Protection |
-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 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
Tipo: | String |
Cargo: | Named |
Valor padrão: | None |
Obrigatório: | False |
Aceitar a entrada de pipeline: | False |
Aceitar caracteres curinga: | False |
Aplica-se a: | Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Exchange Online Protection |
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.