Get-EntraGroup
Возвращает группу.
Синтаксис
GetQuery (По умолчанию)
Get-EntraGroup
[-Top <Int32>]
[-All]
[-Filter <String>]
[-Property <String[]>]
[-HasErrorsOnly]
[-HasLicenseErrorsOnly]
[<CommonParameters>]
GetVague
Get-EntraGroup
[-SearchString <String>]
[-All]
[-Property <String[]>]
[-HasErrorsOnly]
[-HasLicenseErrorsOnly]
[<CommonParameters>]
GetById
Get-EntraGroup
-GroupId <String>
[-All]
[-Property <String[]>]
[<CommonParameters>]
Append
Get-EntraGroup
-Property <String[]>
-AppendSelected
[-GroupId <String>]
[-Top <Int32>]
[-All]
[-Filter <String>]
[-SearchString <String>]
[-HasErrorsOnly]
[-HasLicenseErrorsOnly]
[<CommonParameters>]
Описание
Командлет Get-EntraGroup получает группу в Microsoft Entra ID. Укажите параметр для ObjectId получения определенной группы.
Результаты можно отфильтровать, чтобы отобразить только группы с проблемами с помощью HasErrorsOnly параметра для поиска групп с ошибками подготовки служб или HasLicenseErrorsOnly для поиска групп с ошибками назначения лицензий. Эти параметры фильтрации помогают администраторам определять группы, требующие внимания.
Примеры
Пример 1. Получение всех групп
Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup
DisplayName Id MailNickname Description
----------- -- ------------ -----------
SimpleTestGrp aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb NickName
SimpleGroup bbbbbbbb-1111-2222-3333-cccccccccccc NickName
testGroupInAU10 cccccccc-2222-3333-4444-dddddddddddd testGroupInAU10 testGroupInAU10
My new group dddddddd-3333-4444-5555-eeeeeeeeeeee NotSet New created group
SimpleGroup eeeeeeee-4444-5555-6666-ffffffffffff NickName
В этом примере показано, как получить все группы из Microsoft Entra ID.
Пример 2. Получение определенной группы с помощью GroupId
Connect-Entra -Scopes 'GroupMember.Read.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'Azure Panda'"
Get-EntraGroup -GroupId $group.Id
DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
Crimson Eagle pppppppp-4444-0000-8888-yyyyyyyyyyyy crimsoneaglegroup Crimson Eagle Group {Unified}
В этом примере показано, как получить определенную группу, предоставив идентификатор.
Пример 3. Получение групп Microsoft 365 (унифицированных)
Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -Filter "groupTypes/any(g:g eq 'Unified')" -Top 4
DisplayName Id MailNickname GroupTypes
----------- -- ------------ ----------
Contoso Group hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq contosogroup {Unified}
Crimson Eagle pppppppp-4444-0000-8888-yyyyyyyyyyyy crimsoneagle {Unified}
Bold Falcon tttttttt-0000-3333-9999-mmmmmmmmmmmm boldfalcon {Unified}
Misty Fox qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh mistyfox {Unified}
В этом примере извлекаются группы Microsoft 365 (unified). Вы можете использовать -Limit в качестве псевдонима для -Top.
Пример 4. Получение группы по DisplayName
Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -Filter "DisplayName eq 'Azure Panda'"
DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
Azure Panda qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh azurepanda Azure Panda {Unified}
В этом примере мы извлекаем группу с помощью отображаемого имени.
Пример 5. Получение групп, отображаемое имя которого начинается со строки поиска
Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -SearchString 'New'
DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
New Sparkling Deer bbbbbbbb-5555-5555-0000-qqqqqqqqqqqq newsparklingdeer New Sparkling Deer Group {Unified}
New Golden Fox xxxxxxxx-8888-5555-9999-bbbbbbbbbbbb newgoldenfox New Golden Fox {DynamicMembership}
В этом примере показано, как получить группы, включающие текст в их отображаемые имена из Microsoft Entra ID.
Пример 6. Перечисление бесхозяйных групп
Connect-Entra -Scopes 'GroupMember.Read.All'
$allGroups = Get-EntraGroup -All
$groupsWithoutOwners = foreach ($group in $allGroups) {
$owners = Get-EntraGroupOwner -ObjectId $group.Id
if ($owners.Count -eq 0) {
$group
}
}
$groupsWithoutOwners | Format-Table DisplayName, Id, GroupTypes
DisplayName Id GroupTypes
----------- -- ----------
My new group aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb {}
HelpDesk admin group eeeeeeee-4444-5555-6666-ffffffffffff {}
В этом примере показано, как получить группы без владельцев. Определив бесхозяйные группы, ИТ-администраторы могут повысить общую эффективность управления и операционной деятельности.
Пример 7. Перечисление пустых групп
Connect-Entra -Scopes 'GroupMember.Read.All'
$allGroups = Get-EntraGroup -All
$groupsWithoutMembers = foreach ($group in $allGroups) {
$members = Get-EntraGroupMember -ObjectId $group.Id
if ($members.Count -eq 0) {
$group
}
}
$groupsWithoutMembers | Format-Table DisplayName, Id, GroupTypes
DisplayName Id GroupTypes
----------- -- ----------
My new group aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb {}
HelpDesk admin group eeeeeeee-4444-5555-6666-ffffffffffff {}
В этом примере показано, как получить группы без членов. Определяя группы без участников, ИТ-администраторы могут определять и очищать неиспользуемые или устаревшие группы, которые больше не служат цели.
Пример 8. Получение групп с определенными свойствами
Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -Property Id,DisplayName, SecurityEnabled,Visibility,GroupTypes | Select-Object Id,DisplayName, SecurityEnabled,Visibility,GroupTypes | Format-Table -AutoSize
Id DisplayName SecurityEnabled Visibility GroupTypes
-- ----------- --------------- ---------- ----------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb SimpleGroup False Public {Unified}
eeeeeeee-4444-5555-6666-ffffffffffff My new group False Private {Unified}
bbbbbbbb-5555-5555-0000-qqqqqqqqqqqq HelpDesk admin group True {}
В этом примере показано, как возвращать только определенное свойство группы. Псевдоним можно использовать -Select или -Property.
Пример 9. Получение групп с определенными свойствами и добавление выбранных свойств
Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -GroupId 'aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb' -Property IsSubscribedByMail -AppendSelected | Select-Object Id, DisplayName, MailEnabled, Visibility, IsSubscribedByMail | Format-Table -AutoSize
Id DisplayName MailEnabled Visibility IsSubscribedByMail
-- ----------- --------------- ---------- ----------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb SimpleGroup False Public False
В этом примере показано, как добавить выбранное свойство к свойствам по умолчанию.
Пример 10. Получение групп с ошибками
Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -HasErrorsOnly
DisplayName Id MailNickname Description GroupTypes ServiceProvisioningErrors
----------- -- ------------ ----------- ---------- -------------------------
Problem Group aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb problemgroup Group with errors {Unified} {@{ErrorDetail=...}}
Error Test Group bbbbbbbb-1111-2222-3333-cccccccccccc errortestgroup Another problem group {} {@{ErrorDetail=...}}
В этом примере показано, как получить только группы с ошибками подготовки служб. Параметр HasErrorsOnly фильтрует результаты, чтобы отобразить только группы с проблемами, которым требуется внимание.
Пример 11. Получение групп с ошибками лицензии
Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -HasLicenseErrorsOnly
DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
License Issue Group cccccccc-2222-3333-4444-dddddddddddd licenseissuegroup Group with license errors {Unified}
Failed License Group dddddddd-3333-4444-5555-eeeeeeeeeeee failedlicensegroup License assignment failed {}
В этом примере показано, как получить только группы, у которых есть члены с ошибками лицензии. Это полезно для идентификации групп, где назначение лицензий завершилось сбоем и нуждается в административном внимания.
Пример 12. Объединение фильтрации ошибок с поиском
Connect-Entra -Scopes 'GroupMember.Read.All'
Get-EntraGroup -SearchString 'Test' -HasErrorsOnly
DisplayName Id MailNickname Description GroupTypes ServiceProvisioningErrors
----------- -- ------------ ----------- ---------- -------------------------
Test Error Group bbbbbbbb-1111-2222-3333-cccccccccccc testerrorgroup Test group with errors {} {@{ErrorDetail=...}}
В этом примере показано, как объединить функции поиска с фильтрацией ошибок для поиска определенных групп с определенным шаблоном имен и ошибками подготовки служб.
Параметры
-All
Вывод списка всех страниц.
Свойства параметров
| Тип: | System.Management.Automation.SwitchParameter |
| Значение по умолчанию: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-AppendSelected
Указывает, следует ли добавлять выбранные свойства.
Свойства параметров
| Тип: | System.Management.Automation.SwitchParameter |
| Значение по умолчанию: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
Append
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Filter
Указывает инструкцию фильтра OData версии 4.0. Этот параметр определяет, какие объекты возвращаются.
Свойства параметров
| Тип: | System.String |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
GetQuery
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
Append
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-GroupId
Уникальный идентификатор группы в Microsoft Entra ID (GroupId)
Свойства параметров
| Тип: | System.String |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | ObjectId (идентификатор объекта) |
Наборы параметров
GetById
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
Append
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-HasErrorsOnly
Возвращает только группы, имеющие ошибки подготовки служб.
Свойства параметров
| Тип: | System.Management.Automation.SwitchParameter |
| Значение по умолчанию: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
GetQuery
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
GetVague
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
Append
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-HasLicenseErrorsOnly
Возвращает только группы, у которых есть члены с ошибками лицензии.
Свойства параметров
| Тип: | System.Management.Automation.SwitchParameter |
| Значение по умолчанию: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
GetQuery
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
GetVague
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
Append
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Property
Указывает свойства, возвращаемые
Свойства параметров
| Тип: | System.String[] |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | Select |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-SearchString
Указывает строку поиска.
Свойства параметров
| Тип: | System.String |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
GetValue
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
Append
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-Top
Указывает максимальное количество возвращаемых записей.
Свойства параметров
| Тип: | System.Int32 |
| Значение по умолчанию: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | Ограничение |
Наборы параметров
GetQuery
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
Append
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.