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

Get-AzADGroup

Модуль:
Az.Resources Module

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

Синтаксис

EmptyParameterSet (по умолчанию) 

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

DisplayNameParameterSet 

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

SearchStringParameterSet 

Get-AzADGroup
    -DisplayNameStartsWith <String>
    [-Expand <String[]>]
    [-Select <String[]>]
    [-ConsistencyLevel <String>]
    [-First <UInt64>]
    [-Skip <UInt64>]
    [-AppendSelected]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

ObjectIdParameterSet 

Get-AzADGroup
    -ObjectId <Guid>
    [-Expand <String[]>]
    [-Select <String[]>]
    [-ConsistencyLevel <String>]
    [-AppendSelected]
    [-DefaultProfile <PSObject>]
    [<CommonParameters>]

Описание

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

Примеры

Пример 1. Получение группы по отображаемого имени

Get-AzADGroup -DisplayName $gname

Получение группы по отображаемого имени

Пример 2. Список групп

Get-AzADGroup -First 10

Список первых 10 групп

Пример 3. Получение группы по идентификатору объекта

Get-AzADGroup -ObjectId $id -Select groupTypes -AppendSelected

Получение группы по идентификатору объекта и свойству add "groupTypes" после свойств по умолчанию: DisplayName, "Id", "DeletedDateTime", "SecurityEnabled", "MailEnabled", "MailNickname", "Description"

Пример 4. Получение группы с фильтром

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

Получение группы с фильтром

Пример 5. Назначение OdataCount переменной

Get-AzADGroup -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

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

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

-Count

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

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

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

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

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

-CountVariable

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

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

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

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

EmptyParameterSet
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

-DisplayNameStartsWith

Используется для поиска групп, начинающихся с предоставленной строки.

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

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

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

SearchStringParameterSet
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

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

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

-First

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

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

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

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

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

-ObjectId

ключ: идентификатор группы

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

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

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

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

-Orderby

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

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

Тип:

String[]

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

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

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

-Search

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

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

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

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

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

-Select

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

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

Тип:

String[]

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

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

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

-Skip

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

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

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

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

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

CommonParameters

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

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

IMicrosoftGraphGroup