Get-EntraDirectoryRoleDefinition

Module:
Microsoft.Entra.Governance Module v1.3

Obtient des informations sur les définitions de rôle dans Microsoft Entra ID.

Syntaxe

GetQuery (Par défaut) 

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

L’applet Get-EntraDirectoryRoleDefinition de commande obtient des informations sur les définitions de rôle dans Microsoft Entra ID. Pour obtenir une définition de rôle, spécifiez le UnifiedRoleDefinitionId paramètre. Spécifiez le ou Filter le SearchString paramètre pour rechercher une définition de rôle particulière.

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit disposer d’un rôle Microsoft Entra pris en charge ou d’un rôle personnalisé avec l’une des autorisations suivantes :

  • microsoft.directory/roleAssignments/standard/read (privilège minimum)
  • microsoft.directory/roleAssignments/allProperties/read
  • microsoft.directory/roleAssignments/allProperties/allTasks

Les rôles les moins privilégiés pour cette opération, du moins au plus privilégié, sont les suivants :

  • Lecteurs d’annuaire
  • Lecteur global
  • Administrateur de rôle privilégié

Exemples

Exemple 1 : Obtenir toutes les définitions de rôle

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.

Cette commande retourne toutes les définitions de rôle présentes.

Exemple 2 : Obtenir une définition de rôle par 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.

Cette commande retourne une définition de rôle spécifiée.

  • -UnifiedRoleDefinitionId spécifie l’ID d’objet roleDefinition.

Exemple 3 : Filtrer les définitions de rôles par nom d’affichage

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.

Cette commande retourne toutes les définitions de rôle contenant le nom complet spécifié.

Exemple 4 : Obtenir la définition de rôle supérieure à deux

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

Cette commande retourne deux principales définitions de rôle dans Microsoft Entra ID. Vous pouvez utiliser -Limit comme alias pour -Top.

Exemple 5 : Filtrer les définitions de rôles par nom d’affichage

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

Cette commande retourne toutes les définitions de rôle contenant le nom complet spécifié.

Paramètres

-All

Répertorier toutes les pages.

Propriétés du paramètre

Type:System.Management.Automation.SwitchParameter
Valeur par défaut:False
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-Filter

Spécifie une chaîne de filtre OData v4.0 pour qu’elle corresponde à un ensemble de définitions de rôles.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

GetQuery
Position:Named
Obligatoire:False
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Property

Spécifie les propriétés à retourner

Propriétés du paramètre

Type:

System.String[]

Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Sélectionnez

Jeux de paramètres

(All)
Position:Named
Obligatoire:False
Valeur du pipeline:False
Valeur du pipeline par nom de propriété:False
Valeur des arguments restants:False

-SearchString

Spécifie une chaîne de recherche.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False

Jeux de paramètres

GetVague
Position:Named
Obligatoire:False
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-Top

Spécifie le nombre maximal d’enregistrements que cette applet de commande obtient. La valeur par défaut est 100.

Propriétés du paramètre

Type:System.Int32
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Limite

Jeux de paramètres

GetQuery
Position:Named
Obligatoire:False
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

-UnifiedRoleDefinitionId

Spécifie l’UnifiedRoleDefinitionId de la définition de rôle.

Propriétés du paramètre

Type:System.String
Valeur par défaut:None
Prend en charge les caractères génériques:False
DontShow:False
Alias:Id

Jeux de paramètres

GetById
Position:Named
Obligatoire:True
Valeur du pipeline:True
Valeur du pipeline par nom de propriété:True
Valeur des arguments restants:False

CommonParameters

Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.

Entrées

String

Notes

Get-EntraRoleDefinition est un alias pour Get-EntraDirectoryRoleDefintion.