Get-EntraGroup
Obtém um grupo.
Sintaxe
GetQuery (Default)
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>]
Description
O Get-EntraGroup cmdlet obtém um grupo em Microsoft Entra ID. Especifique o ObjectId parâmetro para obter um grupo específico.
Você pode filtrar os resultados para mostrar apenas grupos com problemas usando o HasErrorsOnly parâmetro para localizar grupos com erros de provisionamento de serviço ou o HasLicenseErrorsOnly parâmetro para localizar grupos com erros de atribuição de licença. Essas opções de filtragem ajudam os administradores a identificar grupos que exigem atenção.
Exemplos
Exemplo 1: Obter todos os grupos
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
Este exemplo demonstra como obter todos os grupos de Microsoft Entra ID.
Exemplo 2: Obter um grupo específico usando uma 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}
Este exemplo demonstra como recuperar um grupo específico fornecendo ID.
Exemplo 3: recuperar grupos de Microsoft 365 (Unificados)
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}
Este exemplo recupera grupos Microsoft 365 (Unificados). Você pode usar -Limit como um alias para -Top.
Exemplo 4: Obter um grupo por 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}
Neste exemplo, recuperamos o grupo usando o Nome de Exibição.
Exemplo 5: Obter grupos cujo DisplayName começa com uma cadeia de caracteres de pesquisa
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}
Este exemplo demonstra como recuperar grupos que incluem o novo texto em seus nomes de exibição de Microsoft Entra ID.
Exemplo 6: Listando grupos sem proprietário
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 {}
Este exemplo demonstra como recuperar grupos sem proprietários. Ao identificar grupos sem proprietários, os administradores de TI podem melhorar a governança geral e a eficiência operacional.
Exemplo 7: Listando grupos vazios
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 {}
Este exemplo demonstra como recuperar grupos sem membros. Ao identificar grupos sem membros, os administradores de TI podem identificar e limpar grupos não utilizados ou obsoletos que não servem mais a uma finalidade.
Exemplo 8: Obter grupos com propriedades específicas
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 {}
Este exemplo demonstra como retornar apenas uma propriedade específica de um grupo. Você pode usar -Select alias ou -Property.
Exemplo 9: Obter grupos com propriedades específicas e acrescentar as propriedades selecionadas
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
Este exemplo demonstra como acrescentar uma propriedade selecionada às propriedades padrão.
Exemplo 10: Obter grupos que têm erros
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=...}}
Este exemplo demonstra como recuperar apenas grupos que têm erros de provisionamento de serviço. O HasErrorsOnly parâmetro filtra os resultados para mostrar apenas grupos com problemas que precisam de atenção.
Exemplo 11: Obter grupos que têm erros de licença
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 {}
Este exemplo demonstra como recuperar apenas grupos que têm membros com erros de licença. Isso é útil para identificar grupos em que a atribuição de licença falhou e precisa de atenção administrativa.
Exemplo 12: Combinar filtragem de erros com pesquisa
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=...}}
Este exemplo demonstra como combinar a funcionalidade de pesquisa com a filtragem de erros para localizar grupos específicos que têm um padrão de nome específico e erros de provisionamento de serviço.
Parâmetros
-All
Listar todas as páginas.
Propriedades do parâmetro
| Tipo: | System.Management.Automation.SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-AppendSelected
Especifica se as propriedades selecionadas devem ser acrescentadas.
Propriedades do parâmetro
| Tipo: | System.Management.Automation.SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
Append
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Filter
Especifica uma instrução de filtro OData v4.0. Esse parâmetro controla quais objetos são retornados.
Propriedades do parâmetro
| Tipo: | System.String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
GetQuery
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
Append
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-GroupId
O identificador exclusivo de um grupo em Microsoft Entra ID (GroupId)
Propriedades do parâmetro
| Tipo: | System.String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | IdentificadorDeObjeto |
Conjuntos de parâmetros
GetById
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
Append
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-HasErrorsOnly
Retorna apenas grupos que têm erros de provisionamento de serviço.
Propriedades do parâmetro
| Tipo: | System.Management.Automation.SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
GetQuery
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
GetVague
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
Append
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-HasLicenseErrorsOnly
Retorna apenas grupos que têm membros com erros de licença.
Propriedades do parâmetro
| Tipo: | System.Management.Automation.SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
GetQuery
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
GetVague
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
Append
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Property
Especifica as propriedades a serem retornadas
Propriedades do parâmetro
| Tipo: | System.String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | Select |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-SearchString
Especifica uma cadeia de caracteres de pesquisa.
Propriedades do parâmetro
| Tipo: | System.String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
GetValue
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
Append
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-Top
Especifica o número máximo de registros a serem retornados.
Propriedades do parâmetro
| Tipo: | System.Int32 |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | Limit |
Conjuntos de parâmetros
GetQuery
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
Append
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | 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.