Partilhar via

Get-AzADUser

Módulo:
Az.Resources Module

Lista entidades de usuários ou obter entidade de usuários por chave

Sintaxe

List (Predefinição) 

Get-AzADUser
    [-Count]
    [-Expand <String[]>]
    [-Select <String[]>]
    [-First <UInt64>]
    [-Skip <UInt64>]
    [-AppendSelected]
    [-Filter <String>]
    [-Orderby <String[]>]
    [-Search <String>]
    [-ConsistencyLevel <String>]
    [-DefaultProfile <PSObject>]
    [-CountVariable <String>]
    [<CommonParameters>]

MailParameterSet 

Get-AzADUser
    -Mail <String>
    [-Expand <String[]>]
    [-Select <String[]>]
    [-First <UInt64>]
    [-Skip <UInt64>]
    [-AppendSelected]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

DisplayNameParameterSet 

Get-AzADUser
    -DisplayName <String>
    [-Expand <String[]>]
    [-Select <String[]>]
    [-First <UInt64>]
    [-Skip <UInt64>]
    [-AppendSelected]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

StartsWithParameterSet 

Get-AzADUser
    -StartsWith <String>
    [-Expand <String[]>]
    [-Select <String[]>]
    [-First <UInt64>]
    [-Skip <UInt64>]
    [-AppendSelected]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

ObjectIdParameterSet 

Get-AzADUser
    -ObjectId <String>
    [-Expand <String[]>]
    [-Select <String[]>]
    [-AppendSelected]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

UPNParameterSet 

Get-AzADUser
    -UserPrincipalName <String>
    [-Expand <String[]>]
    [-Select <String[]>]
    [-AppendSelected]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

SignedInUser 

Get-AzADUser
    [-Expand <String[]>]
    [-Select <String[]>]
    [-AppendSelected]
    [-DefaultProfile <PSObject>]
    [-SignedIn]
    [<CommonParameters>]

Description

Lista entidades de usuários ou obter entidade de usuários por chave

Exemplos

Exemplo 1: Obter utilizador de início de sessão

Get-AzADUser -SignedIn

Obter utilizador de início de sessão

Exemplo 2: Listar usuários

Get-AzADUser -First 10 -Select 'City' -AppendSelected

Liste os primeiros 10 usuários e acrescente a propriedade 'City' após as propriedades padrão: 'DisplayName', 'Id', 'DeletedDateTime', 'UserPrincipalName', 'UsageLocation', 'GivenName', 'SurName', 'AccountEnabled', 'MailNickName', 'Mail'

Exemplo 3: Obter usuário por nome de exibição

Get-AzADUser -DisplayName $name

Obter usuário por nome de exibição

Exemplo 4: Obter usuário com filtro

Get-AzADUser -Filter "startsWith(DisplayName,'some-name')"

Obter usuário com filtro

Exemplo 5: Atribuir OdataCount a uma variável

Get-AzADUser -First 10 -ConsistencyLevel eventual -Count -CountVariable 'result'
$result

Atribuir OdataCount a uma variável

Parâmetros

-AppendSelected

Acrescentar propriedades selecionadas com propriedades padrão quando essa opção estiver ativada, só funciona com o parâmetro '-Select'.

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ConsistencyLevel

Indica o nível de consistência solicitado. URL da documentação: https://developer.microsoft.com/en-us/office/blogs/microsoft-graph-advanced-queries-for-directory-objects-are-now-generally-available/

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

List
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Count

Incluir contagem de itens

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

List
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-CountVariable

Especifica uma contagem do número total de itens em uma coleção. Por padrão, essa variável será definida no escopo global.

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

List
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DefaultProfile

As credenciais, a conta, o locatário e a assinatura usados para comunicação com o Azure.

Propriedades dos parâmetros

Tipo:PSObject
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:AzContext, AzureRmContext, AzureCredential

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-DisplayName

nome de exibição do usuário

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

DisplayNameParameterSet
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Expand

Expandir entidades relacionadas

Propriedades dos parâmetros

Tipo:

String[]

Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Filter

Filtrar itens por valores de propriedade, para obter mais detalhes sobre a consulta de filtro, consulte: https://learn.microsoft.com/en-us/graph/filter-query-parameter

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

List
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-First

Obtém apenas os primeiros 'n' objetos.

Propriedades dos parâmetros

Tipo:UInt64
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

List
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
MailParameterSet
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
DisplayNameParameterSet
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
StartsWithParameterSet
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Mail

endereço de e-mail do usuário

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

MailParameterSet
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-ObjectId

Chave: ID do usuário

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

ObjectIdParameterSet
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Orderby

Ordenar itens por valores de propriedade

Propriedades dos parâmetros

Tipo:

String[]

Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

List
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Search

Pesquisar itens por frases de pesquisa

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

List
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Select

Selecionar propriedades a serem retornadas

Propriedades dos parâmetros

Tipo:

String[]

Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-SignedIn

endereço de e-mail do usuário

Propriedades dos parâmetros

Tipo:SwitchParameter
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

SignedInUser
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Skip

Ignora os primeiros 'n' objetos e, em seguida, obtém os objetos restantes.

Propriedades dos parâmetros

Tipo:UInt64
Default value:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

List
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
MailParameterSet
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
DisplayNameParameterSet
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False
StartsWithParameterSet
Position:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-StartsWith

nome de exibição do usuário começa com

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:SearchString

Conjuntos de parâmetros

StartsWithParameterSet
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-UserPrincipalName

nome principal de utilizador

Propriedades dos parâmetros

Tipo:String
Default value:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:UPN

Conjuntos de parâmetros

UPNParameterSet
Position:Named
Obrigatório:True
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos: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, consulte about_CommonParameters.

Saídas

IMicrosoftGraphUser