Get-EntraDirectoryRoleDefinition

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

Obtiene información sobre las definiciones de roles en Microsoft Entra ID.

Sintaxis

GetQuery (valor predeterminado) 

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

El Get-EntraDirectoryRoleDefinition cmdlet obtiene información sobre las definiciones de roles en Microsoft Entra ID. Para obtener una definición de rol, especifique el UnifiedRoleDefinitionId parámetro . Especifique el SearchString parámetro o Filter para buscar una definición de rol determinada.

En escenarios delegados con cuentas profesionales o educativas, el usuario que ha iniciado sesión debe tener un rol de Microsoft Entra compatible o un rol personalizado con uno de los permisos siguientes:

  • microsoft.directory/roleAssignments/standard/read (con privilegios mínimos)
  • microsoft.directory/roleAssignments/allProperties/read
  • microsoft.directory/roleAssignments/allProperties/allTasks

Los roles con privilegios mínimos para esta operación, de menos a más privilegios, son:

  • Lectores de directorios
  • Lector universal
  • Administrador de roles con privilegios

Ejemplos

Ejemplo 1: Obtener todas las definiciones de roles

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.

Este comando devuelve todas las definiciones de roles presentes.

Ejemplo 2: Obtención de una definición de rol 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.

Este comando devuelve una definición de rol especificada.

  • -UnifiedRoleDefinitionId parameter especifica el identificador de objeto roleDefinition.

Ejemplo 3: Filtrar definiciones de roles por nombre para mostrar

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.

Este comando devuelve todas las definiciones de roles que contienen el nombre para mostrar especificado.

Ejemplo 4: Obtención de la definición de dos roles principales

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

Este comando devuelve las dos principales definiciones de roles en Microsoft Entra ID. Puede usar -Limit como alias para -Top.

Ejemplo 5: Filtrar definiciones de roles por nombre para mostrar

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

Este comando devuelve todas las definiciones de roles que contienen el nombre para mostrar especificado.

Parámetros

-All

Enumera todas las páginas.

Propiedades de parámetro

Tipo:System.Management.Automation.SwitchParameter
Valor predeterminado:False
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-Filter

Especifica una cadena de filtro de OData v4.0 para que coincida con un conjunto de definiciones de roles.

Propiedades de parámetro

Tipo:System.String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

GetQuery
Posición:Named
Obligatorio:False
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Property

Especifica las propiedades que se van a devolver.

Propiedades de parámetro

Tipo:

System.String[]

Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:Select

Conjuntos de parámetros

(All)
Posición:Named
Obligatorio:False
Valor de la canalización:False
Valor de la canalización por nombre de propiedad:False
Valor de los argumentos restantes:False

-SearchString

Especifica una cadena de búsqueda.

Propiedades de parámetro

Tipo:System.String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False

Conjuntos de parámetros

GetVague
Posición:Named
Obligatorio:False
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-Top

Especifica el número máximo de registros que obtiene este cmdlet. El valor predeterminado es 100.

Propiedades de parámetro

Tipo:System.Int32
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:Limit

Conjuntos de parámetros

GetQuery
Posición:Named
Obligatorio:False
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

-UnifiedRoleDefinitionId

Especifica unifiedRoleDefinitionId de la definición de rol.

Propiedades de parámetro

Tipo:System.String
Valor predeterminado:None
Admite caracteres comodín:False
DontShow:False
Alias:Id

Conjuntos de parámetros

GetById
Posición:Named
Obligatorio:True
Valor de la canalización:True
Valor de la canalización por nombre de propiedad:True
Valor de los argumentos restantes:False

CommonParameters

Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.

Entradas

String

Notas

Get-EntraRoleDefinition es un alias de Get-EntraDirectoryRoleDefintion.