你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Get-AzADUser

按键列出用户中的实体或从用户获取实体

语法

List (默认值)

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>]

说明

按键列出用户中的实体或从用户获取实体

示例

示例 1:获取登录用户

Get-AzADUser -SignedIn

获取登录用户

示例 2:列出用户

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

列出前 10 个用户,并在默认属性后追加属性“City”:“DisplayName”、“Id”、“DeletedDateTime”、“UserPrincipalName”、“UsageLocation”、“GivenName”、“SurName”、“AccountEnabled”、“MailNickName”、“Mail”

示例 3:按显示名称获取用户

Get-AzADUser -DisplayName $name

按显示名称获取用户

示例 4:获取具有筛选器的用户

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

获取具有筛选器的用户

示例 5:将 OdataCount 分配到变量

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

将 OdataCount 分配到变量

参数

-AppendSelected

当此开关处于打开状态时,使用默认属性选择的追加属性,仅适用于参数“-Select”。

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ConsistencyLevel

指示请求的一致性级别。 文档 URL: https://developer.microsoft.com/en-us/office/blogs/microsoft-graph-advanced-queries-for-directory-objects-are-now-generally-available/

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

List
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Count

包括项计数

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

List
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-CountVariable

指定集合中项总数的计数。 默认情况下,此变量将在全局范围内设置。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

List
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DefaultProfile

用于与 Azure 通信的凭据、帐户、租户和订阅。

参数属性

类型:PSObject
默认值:None
支持通配符:False
不显示:False
别名:AzContext, AzureRmContext, AzureCredential

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-DisplayName

用户显示名称

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

DisplayNameParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Expand

展开相关实体

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Filter

按属性值筛选项,有关筛选查询的更多详细信息,请参阅: https://learn.microsoft.com/en-us/graph/filter-query-parameter

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

List
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-First

仅获取第一个“n”对象。

参数属性

类型:UInt64
默认值:None
支持通配符:False
不显示:False

参数集

List
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
MailParameterSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
DisplayNameParameterSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
StartsWithParameterSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Mail

用户电子邮件地址

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

MailParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-ObjectId

键:用户的 ID

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

ObjectIdParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Orderby

按属性值对项进行排序

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

List
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

按搜索短语搜索项目

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

List
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Select

选择要返回的属性

参数属性

类型:

String[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-SignedIn

用户电子邮件地址

参数属性

类型:SwitchParameter
默认值:None
支持通配符:False
不显示:False

参数集

SignedInUser
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-Skip

忽略第一个“n”对象,然后获取剩余的对象。

参数属性

类型:UInt64
默认值:None
支持通配符:False
不显示:False

参数集

List
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
MailParameterSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
DisplayNameParameterSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False
StartsWithParameterSet
Position:Named
必需:False
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-StartsWith

用户显示名称以 开头

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:SearchString

参数集

StartsWithParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

-UserPrincipalName

用户主体名称

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False
别名:UPN

参数集

UPNParameterSet
Position:Named
必需:True
来自管道的值:False
来自管道的值(按属性名称):False
来自剩余参数的值:False

CommonParameters

此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters

输出

IMicrosoftGraphUser