Compartilhar via

Get-User

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.

Use o cmdlet Get-User para ver os objetos de usuário existentes em sua organização. Este cmdlet retorna todos os objetos que têm contas de usuário (por exemplo, caixas de correio de usuários, usuários de email e contas de usuário).

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

Sintaxe

AnrSet 

Get-User
    [-Anr <String>]
    [-Arbitration]
    [-AuditLog]
    [-AuxAuditLog]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-IncludeDirectReportsWithDisplayNames]
    [-IncludeManagerWithDisplayName]
    [-IsVIP]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-PublicFolder]
    [-ReadFromDomainController]
    [-RecipientTypeDetails <RecipientTypeDetails[]>]
    [-ResultSize <Unlimited>]
    [-Sortby <String>]
    [-SupervisoryReviewPolicy]
    [<CommonParameters>]

Identity 

Get-User
    [[-Identity] <UserIdParameter>]
    [-Arbitration]
    [-AuditLog]
    [-AuxAuditLog]
    [-Credential <PSCredential>]
    [-DomainController <Fqdn>]
    [-Filter <String>]
    [-IgnoreDefaultScope]
    [-IncludeDirectReportsWithDisplayNames]
    [-IncludeManagerWithDisplayName]
    [-IsVIP]
    [-OrganizationalUnit <OrganizationalUnitIdParameter>]
    [-PublicFolder]
    [-ReadFromDomainController]
    [-RecipientTypeDetails <RecipientTypeDetails[]>]
    [-ResultSize <Unlimited>]
    [-Sortby <String>]
    [-SupervisoryReviewPolicy]
    [<CommonParameters>]

Description

O cmdlet Get-User retorna propriedades não relacionadas ao email para caixas de correio ou usuários de email. Para ver as propriedades relacionadas ao email de um usuário, é necessário usar o cmdlet correspondente baseado no tipo de objeto (por exemplo, Get-Mailbox ou Get-MailUser).

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-User -ResultSize unlimited

Este exemplo retorna uma lista de resumo de todos os usuários em sua organização.

Exemplo 2

Get-User -Identity "Coy Damon" | Format-List

Este exemplo devolve informações detalhadas para o utilizador com o nome Coy Damon.

Exemplo 3

Get-User -OrganizationalUnit "Marketing"

Este exemplo obtém informações sobre os usuários na Unidade Organizacional de Marketing.

Exemplo 4

Get-User -Filter "Title -like 'Manager*'"

Este exemplo usa o parâmetro Filter para recuperar informações sobre todos os usuários com a palavra Manager ao fim de seus títulos.

Parâmetros

-Anr

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Suplemento de segurança incorporado para no local caixas de correio

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

-Arbitration

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 comutador de Arbitragem é necessário para devolver caixas de correio de arbitragem nos resultados. Não é preciso especificar um valor com essa opção.

As caixas de correio de arbitragem são caixas de correio do sistema que são utilizadas para armazenar diferentes tipos de dados do sistema e para gerir o fluxo de trabalho de aprovação de mensagens.

Para devolver caixas de correio de arbitragem que são utilizadas para armazenar dados ou definições de registo de auditoria, não utilize este comutador. Em vez disso, utilize os comutadores AuditLog ou AuxAuditLog.

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

-AuditLog

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

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

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

As caixas de correio de registo de auditoria são caixas de correio de arbitragem que são utilizadas para armazenar as definições do registo de auditoria.

Para devolver outros tipos de caixas de correio de arbitragem, não utilize este comutador. Em vez disso, utilize o comutador Arbitragem.

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

-AuxAuditLog

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

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

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

As caixas de correio de registo de auditoria são caixas de correio de arbitragem que são utilizadas para armazenar as definições do registo de auditoria.

Para devolver outros tipos de caixas de correio de arbitragem, não utilize este comutador. Em vez disso, utilize o comutador Arbitragem.

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

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.

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

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, Conformidade & de Segurança, Segurança incorporada suplemento para caixas de correio no local

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 -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, Conformidade & de Segurança, Segurança incorporada suplemento para caixas de correio no local

O parâmetro Identidade especifica o utilizador que pretende ver. É possível usar qualquer valor que identifique o usuário com exclusividade. Por exemplo:

  • Nome
  • Nome principal do usuário (UPN)
  • DN (nome diferenciado)
  • Nome diferenciado (DN)
  • GUID

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:UserIdParameter
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

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.

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

-IncludeDirectReportsWithDisplayNames

Aplicável: Exchange Online, Suplemento de segurança incorporado para caixas de correio no local

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

{{ Fill IncludeDirectReportsWithDisplayNames Description }}

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-IncludeManagerWithDisplayName

Aplicável: Exchange Online, Suplemento de segurança incorporado para caixas de correio no local

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

{{ Fill IncludeManagerWithDisplayName Description }}

Propriedades do parâmetro

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

Conjuntos de parâmetros

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

-IsVIP

Aplicável: Exchange Online, Suplemento de segurança incorporado para caixas de correio no local

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

O comutador IsVIP filtra os resultados por contas prioritárias. Não é preciso especificar um valor com essa opção.

Para obter mais informações sobre contas prioritárias, veja Gerir e monitorizar contas prioritárias.

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, Suplemento de segurança incorporado para no local caixas de correio

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

-PublicFolder

Aplicável: Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Conformidade & de Segurança

O comutador PublicFolder é necessário para devolver caixas de correio de pasta públicas nos resultados. Não é preciso especificar um valor com essa opção.

As caixas de correio de pasta pública são caixas de correio desenvolvidas especialmente para armazenar a hierarquia e o conteúdo das pastas públicas.

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

-RecipientTypeDetails

Aplicável: Exchange Server 2010, Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Server SE, Exchange Online, Conformidade & de Segurança, Segurança incorporada suplemento para caixas de correio no local

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

  • DisabledUser
  • DiscoveryMailbox
  • Caixa de Correio de Equipamento
  • GuestMailUser (Exchange 2016 ou posterior e cloud)
  • GroupMailbox (apenas Exchange 2013)
  • LegacyMailbox
  • LinkedMailbox
  • LinkedRoomMailbox (Exchange 2013 ou posterior e cloud)
  • LinkedUser
  • MailUser
  • PublicFolderMailbox (Exchange 2013 ou posterior e cloud)
  • RemoteEquipmentMailbox
  • RemoteRoomMailbox
  • RemoteSharedMailbox
  • RemoteTeamMailbox (Exchange 2013 ou posterior e cloud)
  • RemoteUserMailbox
  • RoomMailbox
  • SchedulingMailbox (Exchange 2016 ou posterior e cloud)
  • SharedMailbox
  • SharedWithMailUser (apenas na cloud)
  • TeamMailbox (Exchange 2013 ou posterior e cloud)
  • Usuário
  • 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, Conformidade & de Segurança, Segurança incorporada suplemento para caixas de correio no local

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, Conformidade & de Segurança, Segurança incorporada suplemento para caixas de correio no local

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
  • Cidade
  • FirstName
  • Sobrenome
  • Office

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

-SupervisoryReviewPolicy

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

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

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

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.