Поделиться через

Get-AzADUser

Модуль:
Az.Resources Module

Перечисление сущностей от пользователей или получение сущностей от пользователей по ключу

Синтаксис

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", "MailNickName"

Пример 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
Default value:None
Поддерживаются подстановочные знаки:False
DontShow: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
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

List
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Count

Включение количества элементов

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

List
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-CountVariable

Указывает количество общих элементов в коллекции. По умолчанию эта переменная будет задана в глобальной области.

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

List
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для взаимодействия с Azure.

Свойства параметра

Тип:PSObject
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:AzContext, AzureRmContext, AzureCredential

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-DisplayName

отображаемое имя пользователя

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

DisplayNameParameterSet
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Expand

Разверните связанные сущности

Свойства параметра

Тип:

String[]

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Filter

Дополнительные сведения о запросе фильтра см. в разделе "Фильтрация элементов по значениям свойств" https://learn.microsoft.com/en-us/graph/filter-query-parameter

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

List
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-First

Возвращает только первые объекты n.

Свойства параметра

Тип:UInt64
Default value:None
Поддерживаются подстановочные знаки:False
DontShow: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
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

MailParameterSet
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-ObjectId

ключ: идентификатор пользователя

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

ObjectIdParameterSet
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Orderby

Упорядочивание элементов по значениям свойств

Свойства параметра

Тип:

String[]

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

List
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Search

Поиск элементов по фразам поиска

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

List
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Select

Выбор свойств для возврата

Свойства параметра

Тип:

String[]

Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

(All)
Position:Named
Обязательно:False
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-SignedIn

адрес электронной почты пользователя

Свойства параметра

Тип:SwitchParameter
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False

Наборы параметров

SignedInUser
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-Skip

Игнорирует первые объекты n, а затем получает оставшиеся объекты.

Свойства параметра

Тип:UInt64
Default value:None
Поддерживаются подстановочные знаки:False
DontShow: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
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:SearchString

Наборы параметров

StartsWithParameterSet
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

-UserPrincipalName

имя участника-пользователя

Свойства параметра

Тип:String
Default value:None
Поддерживаются подстановочные знаки:False
DontShow:False
Aliases:UPN

Наборы параметров

UPNParameterSet
Position:Named
Обязательно:True
Значение из конвейера:False
Значение из конвейера по имени свойства:False
Значение из оставшихся аргументов:False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Выходные данные

IMicrosoftGraphUser