Get-EntraDirectoryRoleDefinition

Módulo:
Microsoft.Entra.Governance Module v1.3

Obtém informações sobre definições de função no Microsoft Entra ID.

Sintaxe

GetQuery (Default) 

Get-EntraDirectoryRoleDefinition

    [-All]
    [-Top <Int32>]
    [-Filter <String>]
    [-Property <String[]>]
    [<CommonParameters>]

GetVague 

Get-EntraDirectoryRoleDefinition

    [-SearchString <String>]
    [-All]
    [-Property <String[]>]
    [<CommonParameters>]

GetById 

Get-EntraDirectoryRoleDefinition

    -UnifiedRoleDefinitionId <String>
    [-All]
    [-Property <String[]>]
    [<CommonParameters>]

Description

O Get-EntraDirectoryRoleDefinition cmdlet obtém informações sobre definições de função no Microsoft Entra ID. Para obter uma definição de função, especifique o UnifiedRoleDefinitionId parâmetro. Especifique o SearchString parâmetro ou Filter a definição de função específica.

Em cenários delegados com contas corporativas ou de estudante, o usuário conectado deve ter uma função de Microsoft Entra com suporte ou uma função personalizada com uma das seguintes permissões:

  • microsoft.directory/roleAssignments/standard/read (menos privilegiado)
  • microsoft.directory/roleAssignments/allProperties/read
  • microsoft.directory/roleAssignments/allProperties/allTasks

As funções menos privilegiadas para esta operação, do mínimo para a mais privilegiada, são:

  • Leitores de diretório
  • Leitor Global
  • Administrador de Função Privilégiada

Exemplos

Exemplo 1: Obter todas as definições de função

Connect-Entra -Scopes 'RoleManagement.Read.Directory', 'EntitlementManagement.Read.All'
Get-EntraDirectoryRoleDefinition

DisplayName                                   Id                                   TemplateId                           Description
-----------                                   --                                   ----------                           -----------
Guest User                                    10dae51f-b6af-4016-8d66-8c2a99b929b3 10dae51f-b6af-4016-8d66-8c2a99b929b3 Default role for guest users. Can read a limited set of directory information.
Restricted Guest User                         2af84b1e-32c8-42b7-82bc-daa82404023b 2af84b1e-32c8-42b7-82bc-daa82404023b Restricted role for guest users. Can read a limited set of directory information.

Esse comando retorna todas as definições de função presentes.

Exemplo 2: Obter uma definição de função por UnifiedRoleDefinitionId

Connect-Entra -Scopes 'RoleManagement.Read.Directory', 'EntitlementManagement.Read.All'
$role = Get-EntraDirectoryRoleDefinition -Filter "DisplayName eq 'Helpdesk Administrator'"
Get-EntraDirectoryRoleDefinition -UnifiedRoleDefinitionId $role.Id

DisplayName                                   Id                                   TemplateId                           Description
-----------                                   --                                   ----------                           -----------
Restricted Guest User                         2af84b1e-32c8-42b7-82bc-daa82404023b 2af84b1e-32c8-42b7-82bc-daa82404023b Restricted role for guest users. Can read a limited set of directory information.

Esse comando retorna uma definição de função especificada.

  • -UnifiedRoleDefinitionId o parâmetro especifica a ID do objeto roleDefinition.

Exemplo 3: filtrar definições de função por nome de exibição

Connect-Entra -Scopes 'RoleManagement.Read.Directory', 'EntitlementManagement.Read.All'
Get-EntraDirectoryRoleDefinition -Filter "startsWith(displayName, 'Restricted')"

DisplayName                                   Id                                   TemplateId                           Description
-----------                                   --                                   ----------                           -----------
Restricted Guest User                         2af84b1e-32c8-42b7-82bc-daa82404023b 2af84b1e-32c8-42b7-82bc-daa82404023b Restricted role for guest users. Can read a limited set of directory information.

Esse comando retorna todas as definições de função que contêm o nome de exibição especificado.

Exemplo 4: Obter a definição das duas principais funções

Connect-Entra -Scopes 'RoleManagement.Read.Directory', 'EntitlementManagement.Read.All'
Get-EntraDirectoryRoleDefinition -Top 2

DisplayName           Id                                   TemplateId                           Description                                                                       IsBuiltIn IsEnabled
-----------           --                                   ----------                           -----------                                                                       --------- ---------
Restricted Guest User 00aa00aa-bb11-cc22-dd33-44ee44ee44ee 2af84b1e-32c8-42b7-82bc-daa82404023b Restricted role for guest users. Can read a limited set of directory information. True      True

Esse comando retorna as duas principais definições de função em Microsoft Entra ID. Você pode usar -Limit como um alias para -Top.

Exemplo 5: Filtrar definições de função por nome de exibição

Connect-Entra -Scopes 'RoleManagement.Read.Directory', 'EntitlementManagement.Read.All'
Get-EntraDirectoryRoleDefinition -SearchString 'Global'

DisplayName                        Id                                   TemplateId                           Description                                                                                                                                                           IsBu
                                                                                                                                                                                                                                                                                   iltI
                                                                                                                                                                                                                                                                                   n
-----------                        --                                   ----------                           -----------                                                                                                                                                           ----
Global Administrator               62e90394-69f5-4237-9190-012177145e10 62e90394-69f5-4237-9190-012177145e10 Can manage all aspects of Microsoft Entra ID and Microsoft services that use Microsoft Entra identities.                                                              True
Global Reader                      f2ef992c-3afb-46b9-b7cf-a126ee74c451 f2ef992c-3afb-46b9-b7cf-a126ee74c451 Can read everything that a Global Administrator can, but not update anything.                                                                                         True

Esse comando retorna todas as definições de função que contêm o nome de exibição especificado.

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

-Filter

Especifica uma cadeia de caracteres de filtro OData v4.0 para corresponder a um conjunto de definições de função.

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

-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

GetVague
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 que esse cmdlet obtém. O valor padrão é 100.

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

-UnifiedRoleDefinitionId

Especifica a UnifiedRoleDefinitionId da definição de função.

Propriedades do parâmetro

Tipo:System.String
Valor padrão:None
Dá suporte a curingas:False
DontShow:False
Aliases:ID

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

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.

Entradas

String

Observações

Get-EntraRoleDefinition é um alias para Get-EntraDirectoryRoleDefintion.