Get-EntraDirectoryRoleDefinition

Moduł:
Microsoft.Entra.Governance Module v1.3

Pobiera informacje o definicjach ról w Microsoft Entra ID.

Składnia

GetQuery (domyślnie) 

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>]

Opis

Polecenie Get-EntraDirectoryRoleDefinition cmdlet pobiera informacje o definicjach ról w Microsoft Entra ID. Aby uzyskać definicję roli, określ UnifiedRoleDefinitionId parametr . Określ parametr orFilter, SearchString aby znaleźć określoną definicję roli.

W scenariuszach delegowanych z kontami służbowymi zalogowany użytkownik musi mieć obsługiwaną rolę Microsoft Entra lub rolę niestandardową z jednym z następujących uprawnień:

  • microsoft.directory/roleAssignments/standard/read (najmniej uprzywilejowany)
  • microsoft.directory/roleAssignments/allProperties/read
  • microsoft.directory/roleAssignments/allProperties/allTasks

Najmniej uprzywilejowane role dla tej operacji, od najmniej do najbardziej uprzywilejowanych, to:

  • Czytelnicy katalogów
  • Globalny czytnik
  • Administrator ról uprzywilejowanych

Przykłady

Przykład 1. Pobieranie wszystkich definicji ról

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.

To polecenie zwraca wszystkie obecne definicje ról.

Przykład 2. Pobieranie definicji roli według identyfikatora 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.

To polecenie zwraca określoną definicję roli.

  • -UnifiedRoleDefinitionId parametr określa identyfikator obiektu roleDefinition.

Przykład 3. Filtrowanie definicji ról według nazwy wyświetlanej

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.

To polecenie zwraca wszystkie definicje ról zawierające określoną nazwę wyświetlaną.

Przykład 4. Uzyskiwanie dwóch pierwszych definicji roli

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

To polecenie zwraca dwie pierwsze definicje ról w Microsoft Entra ID. Możesz użyć -Limit jako aliasu dla -Top.

Przykład 5. Filtrowanie definicji ról według nazwy wyświetlanej

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

To polecenie zwraca wszystkie definicje ról zawierające określoną nazwę wyświetlaną.

Parametry

-All

Wyświetl listę wszystkich stron.

Właściwości parametru

Typ:System.Management.Automation.SwitchParameter
Domyślna wartość:False
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-Filter

Określa ciąg filtru OData w wersji 4.0 zgodny z zestawem definicji ról.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

GetQuery
Position:Named
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-Property

Określa właściwości, które mają być zwracane

Właściwości parametru

Typ:

System.String[]

Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Select

Zestawy parametrów

(All)
Position:Named
Obowiązkowe:False
Wartość z potoku:False
Wartość z potoku według nazwy właściwości:False
Wartość z pozostałych argumentów:False

-SearchString

Określa ciąg wyszukiwania.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False

Zestawy parametrów

GetVague
Position:Named
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-Top

Określa maksymalną liczbę rekordów pobieranych przez to polecenie cmdlet. Wartość domyślna to 100.

Właściwości parametru

Typ:System.Int32
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Ograniczenie

Zestawy parametrów

GetQuery
Position:Named
Obowiązkowe:False
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

-UnifiedRoleDefinitionId

Określa UnifiedRoleDefinitionId definicji roli.

Właściwości parametru

Typ:System.String
Domyślna wartość:None
Obsługuje symbole wieloznaczne:False
DontShow:False
Aliasy:Id

Zestawy parametrów

GetById
Position:Named
Obowiązkowe:True
Wartość z potoku:True
Wartość z potoku według nazwy właściwości:True
Wartość z pozostałych argumentów:False

CommonParameters

To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.

Dane wejściowe

String

Notatki

Get-EntraRoleDefinition to alias dla elementu Get-EntraDirectoryRoleDefintion.