Get-User
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.
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.
Syntax
Get-User
[-Anr <String>]
[-Arbitration]
[-AuditLog]
[-AuxAuditLog]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-IsVIP]
[-OrganizationalUnit <OrganizationalUnitIdParameter>]
[-PublicFolder]
[-ReadFromDomainController]
[-RecipientTypeDetails <RecipientTypeDetails[]>]
[-ResultSize <Unlimited>]
[-Sortby <String>]
[-SupervisoryReviewPolicy]
[<CommonParameters>]Get-User
[[-Identity] <UserIdParameter>]
[-Arbitration]
[-AuditLog]
[-AuxAuditLog]
[-Credential <PSCredential>]
[-DomainController <Fqdn>]
[-Filter <String>]
[-IgnoreDefaultScope]
[-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 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-User -ResultSize unlimitedEste exemplo retorna uma lista de resumo de todos os usuários em sua organização.
Exemplo 2
Get-User -Identity "Coy Damon" | Format-ListEste exemplo retorna informações detalhadas para o usuário chamado 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
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, Exchange Online, Exchange Online Protection |
-Arbitration
Este parâmetro está disponível somente no Exchange local.
A opção Arbitragem é necessária para retornar 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 usadas para armazenar diferentes tipos de dados do sistema e para gerenciar o fluxo de trabalho de aprovação de mensagens.
Para retornar caixas de correio de arbitragem usadas para armazenar configurações de log de auditoria ou dados, não use essa opção. Em vez disso, use os comutadores AuditLog ou AuxAuditLog.
| 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 |
-AuditLog
Este parâmetro está disponível somente no Exchange local.
A opção AuditLog é necessária para retornar caixas de correio de log de auditoria nos resultados. Não é preciso especificar um valor com essa opção.
As caixas de correio de log de auditoria são caixas de correio de arbitragem usadas para armazenar configurações de log de auditoria.
Para retornar outros tipos de caixas de correio de arbitragem, não use essa opção. Em vez disso, use a opção Arbitragem.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019 |
-AuxAuditLog
Este parâmetro está disponível somente no Exchange local.
A opção AuxAuditLog é necessária para retornar caixas de correio de log de auditoria auxiliares nos resultados. Não é preciso especificar um valor com essa opção.
As caixas de correio de log de auditoria são caixas de correio de arbitragem usadas para armazenar configurações de log de auditoria.
Para retornar outros tipos de caixas de correio de arbitragem, não use essa opção. Em vez disso, use a opção Arbitragem.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2016, Exchange Server 2019 |
-Credential
Este parâmetro está disponível somente no Exchange local.
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
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.
| 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, Exchange Online, Security & Compliance, Exchange Online Protection |
-Identity
O parâmetro Identity do usuário que você deseja visualizar. É 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
| Type: | UserIdParameter |
| 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, Exchange Online, Security & Compliance, Exchange Online Protection |
-IgnoreDefaultScope
Este parâmetro está disponível somente no Exchange local.
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 |
-IsVIP
Esse parâmetro só está disponível no serviço baseado em nuvem.
A opção 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, consulte Gerenciar e monitorar contas prioritárias.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | 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 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, Exchange Online, Exchange Online Protection |
-PublicFolder
A opção PublicFolder é necessária para retornar caixas de correio de pasta pública 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.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | Exchange Server 2013, Exchange Server 2016, Exchange Server 2019, Exchange Online, Security & Compliance |
-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 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 |
-RecipientTypeDetails
O parâmetro RecipientTypeDetails filtra os resultados pelo subtipo de usuário especificado. Os valores válidos são:
- DisabledUser
- DiscoveryMailbox
- EquipmentMailbox
- GuestMailUser (Exchange 2016 ou posterior e nuvem)
- GroupMailbox (somente Exchange 2013)
- LegacyMailbox
- LinkedMailbox
- LinkedRoomMailbox (Exchange 2013 ou posterior e nuvem)
- LinkedUser
- MailUser
- PublicFolderMailbox (Exchange 2013 ou posterior e nuvem)
- RemoteEquipmentMailbox
- RemoteRoomMailbox
- RemoteSharedMailbox
- RemoteTeamMailbox (Exchange 2013 ou posterior e nuvem)
- RemoteUserMailbox
- RoomMailbox
- SchedulingMailbox (Exchange 2016 ou posterior e nuvem)
- SharedMailbox
- ShareWithMailUser (somente nuvem)
- TeamMailbox (Exchange 2013 ou posterior e nuvem)
- User
- UserMailbox
Vários valores, separados por vírgulas, podem ser especificados.
| Type: | RecipientTypeDetails[] |
| 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, Exchange Online, Security & Compliance, Exchange Online Protection |
-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.
| 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, Exchange Online, Security & Compliance, 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 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
- Cidade
- FirstName
- Sobrenome
- Office
| 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, Exchange Online, Security & Compliance, Exchange Online Protection |
-SupervisoryReviewPolicy
Este parâmetro está disponível somente no Exchange local.
Esse parâmetro está reservado para uso interno da Microsoft.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Applies to: | 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.