Get-EntraDirectoryRoleDefinition

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

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

Sintaxe

GetQuery (Predefinição) 

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

Descrição

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

Em cenários delegados com contas de trabalho ou escola, o utilizador iniciado deve ter uma função Microsoft Entra suportada 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

Os papéis menos privilegiados para esta operação, do menos ao mais privilegiado, são:

  • Leitores de Diretório
  • Leitor Global
  • Administrador de Função Privilegiada

Exemplos

Exemplo 1: Obtenha todas as definições de funções

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 devolve todas as definições de papéis presentes.

Exemplo 2: Obtenha uma definição de papel pelo 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 devolve uma definição de função especificada.

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

Exemplo 3: Filtrar definições de papéis 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.

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

Exemplo 4: Obtenha a definição dos dois principais papéis

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 devolve as duas primeiras definições de funções no Microsoft Entra ID. Você pode usar -Limit como um alias para -Top.

Exemplo 5: Filtrar definições de papéis 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

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

Parâmetros

-All

Liste todas as páginas.

Propriedades dos parâmetros

Tipo:System.Management.Automation.SwitchParameter
Valor predefinido:False
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-Filter

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

Propriedades dos parâmetros

Tipo:System.String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

GetQuery
Posto:Named
Obrigatório:False
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Property

Especifica propriedades a serem devolvidas

Propriedades dos parâmetros

Tipo:

System.String[]

Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Select

Conjuntos de parâmetros

(All)
Posto:Named
Obrigatório:False
Valor do pipeline:False
Valor do pipeline por nome de propriedade:False
Valor dos restantes argumentos:False

-SearchString

Especifica uma cadeia de pesquisa.

Propriedades dos parâmetros

Tipo:System.String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False

Conjuntos de parâmetros

GetVague
Posto:Named
Obrigatório:False
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-Top

Especifica o número máximo de registos que este cmdlet recebe. O valor padrão é 100.

Propriedades dos parâmetros

Tipo:System.Int32
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Limit

Conjuntos de parâmetros

GetQuery
Posto:Named
Obrigatório:False
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos:False

-UnifiedRoleDefinitionId

Especifica o UnifiedRoleDefinitionId da definição do papel.

Propriedades dos parâmetros

Tipo:System.String
Valor predefinido:None
Suporta carateres universais:False
NãoMostrar:False
Aliases:Id

Conjuntos de parâmetros

GetById
Posto:Named
Obrigatório:True
Valor do pipeline:True
Valor do pipeline por nome de propriedade:True
Valor dos restantes argumentos: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

Notas

Get-EntraRoleDefinition é um alias para Get-EntraDirectoryRoleDefintion.