Get-EntraDirectoryRole

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

Obtém uma função de diretório.

Sintaxe

GetQuery (Default) 

Get-EntraDirectoryRole

    [-Filter <String>]
    [-Property <String[]>]
    [<CommonParameters>]

GetById 

Get-EntraDirectoryRole

    -DirectoryRoleId <String>
    [-Property <String[]>]
    [<CommonParameters>]

Description

O Get-EntraDirectoryRole cmdlet obtém uma função de diretório de Microsoft Entra ID. Especifique ObjectId o parâmetro para obter uma função de diretório.

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 as permissões necessárias. As seguintes funções com menos privilégios são suportadas para esta operação:

  • Administrador de usuários
  • Administrador de assistência técnica
  • Administrador de suporte a serviço
  • Administrador de cobrança
  • Leitores de diretório
  • Gravadores de diretório
  • Administrador de Aplicativos
  • Leitor de Segurança
  • Administrador de segurança
  • Administrador de Função Privilégiada
  • Administrador de Aplicativos na Nuvem

Exemplos

Exemplo 1: Obter uma função de diretório por ID

Connect-Entra -Scopes 'RoleManagement.Read.Directory'
$directoryRole = Get-EntraDirectoryRole -Filter "displayName eq 'Helpdesk Administrator'"
Get-EntraDirectoryRole -DirectoryRoleId $directoryRole.Id

ObjectId                             DisplayName                        Description
--------                             -----------                        -----------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Helpdesk Administrator              Company Administrator role has full access to perform any operation in the company scope.

Esse comando obtém a função de diretório especificada.

  • -ObjectIdO parâmetro especifica a ID de uma função de diretório em Microsoft Entra ID.

Exemplo 2: Obter todas as funções de diretório

Connect-Entra -Scopes 'RoleManagement.Read.Directory'
Get-EntraDirectoryRole

DeletedDateTime Id                                   Description
--------------- --                                   -----------
                aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Perform all migration functionality to migrate content to Microsoft 365 usin...
                aaaaaaaa-6666-7777-8888-bbbbbbbbbbbb Can manage all aspects of users and groups, including resetting passwords fo...
                bbbbbbbb-7777-8888-9999-cccccccccccc Can read basic directory information. Commonly used to grant directory read ...
                cccccccc-8888-9999-0000-dddddddddddd Can read and write basic directory information. For granting access to appli...

Esse comando obtém todas as funções de diretório.

Exemplo 3: Obter um filtro de função de diretório por Id

Connect-Entra -Scopes 'RoleManagement.Read.Directory'
Get-EntraDirectoryRole -Filter "Id eq 'c0e36062-8c80-4d72-9bc3-cbb4efe03c21'"

Id                             DisplayName                        Description
--------                             -----------                        -----------
aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Helpdesk Administrator              Company Administrator role has full access to perform any operation in the company scope.

Esse comando obtém a função de diretório por Id.

  • -IdO parâmetro especifica a ID de uma função de diretório em Microsoft Entra ID.

Exemplo 4: Obter um filtro de função de diretório por displayName

Connect-Entra -Scopes 'RoleManagement.Read.Directory'
Get-EntraDirectoryRole -Filter "displayName eq 'Helpdesk Administrator'"

DeletedDateTime Id                                   Description
--------------- --                                   -----------
                aaaaaaaa-0000-1111-2222-bbbbbbbbbbbb Can reset passwords for non-administrators and Helpdesk Administrators....

Esse comando obtém a função de diretório pelo nome de exibição.

Parâmetros

-DirectoryRoleId

Especifica a ID de uma função de diretório em Microsoft Entra ID.

Propriedades do parâmetro

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

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

-Filter

A instrução de filtro OData v4.0. Controla quais objetos são retornados.

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

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.