Get-EntraUserGroup
Recupera a lista de grupos aos quais um usuário pertence.
Sintaxe
GetQuery (Default)
Get-EntraUserGroup
-UserId <String>
[-All]
[-Filter <String>]
[-Top <Int32>]
[-Property <String[]>]
[<CommonParameters>]
GetById
Get-EntraUserGroup
-UserId <String>
-GroupId <String>
[<CommonParameters>]
Append
Get-EntraUserGroup
-UserId <String>
-Property <String[]>
-AppendSelected
[-All]
[-Filter <String>]
[-Top <Int32>]
[<CommonParameters>]
Description
O Get-EntraUserGroup cmdlet recupera uma lista de grupos aos quais um usuário pertence.
Exemplos
Exemplo 1: obter uma lista de grupos aos quais um usuário específico pertence
Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com'
DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
Contoso Marketing hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing Contoso Marketing {Unified}
Mark 8 Project Team pppppppp-4444-0000-8888-yyyyyyyyyyyy Mark8ProjectTeam Mark 8 Project Team {Unified}
Leadership tttttttt-0000-3333-9999-mmmmmmmmmmmm Leadership Leadership {Unified}
Sales and Marketing qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh SalesAndMarketing Sales and Marketing {Unified}
Retail aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Retail Retail {Unified}
Esse cmdlet recupera uma lista de grupos aos quais um usuário específico pertence.
Exemplo 2: obter uma lista de grupos aos quais um usuário específico pertence usando o parâmetro All
Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -All
DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
Contoso Marketing hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing Contoso Marketing {Unified}
Mark 8 Project Team pppppppp-4444-0000-8888-yyyyyyyyyyyy Mark8ProjectTeam Mark 8 Project Team {Unified}
Leadership tttttttt-0000-3333-9999-mmmmmmmmmmmm Leadership Leadership {Unified}
Sales and Marketing qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh SalesAndMarketing Sales and Marketing {Unified}
Retail aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Retail Retail {Unified}
Esse cmdlet recupera uma lista de grupos aos quais um usuário específico pertence usando o parâmetro All.
Exemplo 3: obter um grupo ao qual um usuário específico pertence
Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -Top 1
DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
Contoso Marketing hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing Contoso Marketing {Unified}
Esse cmdlet recupera um grupo ao qual um usuário específico pertence. Você pode usar -Limit como um alias para -Top.
Exemplo 4: obter uma lista de grupos aos quais um usuário específico pertence usando o parâmetro de ID do grupo
Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
$group = Get-EntraGroup -Filter "DisplayName eq 'Contoso Marketing'"
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -GroupId $group.Id
DisplayName Id MailNickname Description GroupTypes
----------- -- ------------ ----------- ----------
Contoso Marketing hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing Contoso Marketing {Unified}
Esse cmdlet recupera uma lista de grupos aos quais um usuário específico pertence usando o parâmetro de ID do grupo.
-
-GroupIdO parâmetro especifica a ID do grupo.
Exemplo 5: obtenha uma lista de grupos aos quais um usuário específico pertence e selecione propriedades específicas.
Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -Property id,displayName,mailNickName -Debug | Select-Object displayName,id,mailNickName
DisplayName Id MailNickname
----------- -- ------------
Contoso Marketing hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq ContosoMarketing
Contoso Sales qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh ContosoSales
Contoso Digital aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb ContosoDigital
Esse cmdlet retorna propriedades específicas na lista de grupos aos quais um usuário específico pertence.
Exemplo 6: Obter uma lista de grupos aos quais um usuário específico pertence e acrescentar as propriedades selecionadas
Connect-Entra -Scopes 'GroupMember.Read.All', 'Group.Read.All', 'Directory.Read.All'
Get-EntraUserGroup -UserId 'SawyerM@contoso.com' -Property AssignedLabels -AppendSelected | Select-Object id,displayName,createdDateTime,deletedDateTime,groupTypes,mailEnabled,mailNickname,securityEnabled,visibility,description,AssignedLabels
Id : hhhhhhhh-3333-5555-3333-qqqqqqqqqqqq
DisplayName : Contoso Marketing
CreatedDateTime : 22/08/2024 03:02:41
DeletedDateTime :
GroupTypes : {Unified}
MailEnabled : True
MailNickname : ContosoMarketing
SecurityEnabled : False
Visibility : Public
Description :
AssignedLabels : {TagA,TagB}
Id : qqqqqqqq-5555-0000-1111-hhhhhhhhhhhh
DisplayName : Contoso Sales
CreatedDateTime : 22/08/2024 06:18:23
DeletedDateTime :
GroupTypes : {Unified}
MailEnabled : True
MailNickname : ContosoSales
SecurityEnabled : False
Visibility : Public
Description : Description of Contoso Sales
AssignedLabels : {TagA,TagB}
Id : aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb
DisplayName : Contoso Digital
CreatedDateTime : 22/08/2024 06:20:00
DeletedDateTime :
GroupTypes : {Unified}
MailEnabled : True
MailNickname : ContosoDigital
SecurityEnabled : False
Visibility : Public
Description : Description of Contoso Digital
AssignedLabels : {TagA,TagB}
Selecionamos apenas uma propriedade usando o Property parâmetro, mas a resposta tem mais propriedades desde AppendSelected que o parâmetro anexou propriedades padrão às propriedades selecionadas.
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 |
-GroupId
A ID exclusiva do grupo.
Propriedades do parâmetro
| Tipo: | System.String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | DirectoryObjectId |
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 |
-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
GetQuery
| 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 |
-Top
O número máximo de grupos aos quais um usuário pertence.
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 |
-UserId
Especifica a ID de UserPrincipalName ou UserId de um usuário no Microsoft Entra ID.
Propriedades do parâmetro
| Tipo: | System.String |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | IdentificadorDeObjeto, UPN, Identidade, Nome Principal do Usuário |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | True |
| 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.