tipo de recurso directoryRoledirectoryRole resource type

Representa uma função do diretório do Azure AD.Represents an Azure AD directory role. As funções de diretório do AD do Azure também são conhecidas como funções de administrador.Azure AD directory roles are also known as administrator roles. Para obter mais informações sobre funções de diretório (administrador), confira Atribuindo funções de administrador no Azure AD.For more information about directory (administrator) roles, see Assigning administrator roles in Azure AD. Com o Microsoft Graph, você pode atribuir usuários a funções de diretório para conceder a eles as permissões da função de destino.With the Microsoft Graph, you can assign users to directory roles to grant them the permissions of the target role. Para ler uma função de diretório ou atualizar seus membros, primeiro ela deve ser ativada no locatário.To read a directory role or update its members, it must first be activated in the tenant. Apenas a função de diretório Administradores de Empresa é ativada por padrão.Only the Company Administrators directory role is activated by default. Para ativar outras funções de diretório disponíveis, você envia uma solicitação POST com a ID do directoryRoleTemplate no qual a função directory se baseia.To activate other available directory roles you send a POST request with the ID of the directoryRoleTemplate on which the directory role is based. Liste modelos de função de diretório para ter todas as outras funções de diretório disponíveis.List directory role templates to get all the other available directory roles. Herda de directoryObject.Inherits from directoryObject.

Esse recurso permite:This resource supports:

  • Usar a consulta delta para controlar adições, exclusões e atualizações incrementais oferecendo uma função delta.Using delta query to track incremental additions, deletions, and updates, by providing a delta function.

MétodosMethods

MétodoMethod Tipo de retornoReturn Type DescriçãoDescription
Obter directoryRoleGet directoryRole directoryRoledirectoryRole Leia as propriedades e os relacionamentos do objeto directoryRole.Read properties and relationships of directoryRole object.
Listar directoryRolesList directoryRoles Coleção directoryRoledirectoryRole collection Lista as funções de diretório ativadas no locatário.List the directory roles that are activated in the tenant.
Adicionar membroAdd member directoryObjectdirectoryObject Adicione um usuário à função de diretório postando na propriedade de navegação de membros.Add a user to the directory role by posting to the members navigation property.
Listar membrosList members Coleção directoryObjectdirectoryObject collection Obtenha os usuários que são membros da função directory da propriedade de navegação members.Get the users that are members of the directory role from the members navigation property.
Remover um membroRemove a member directoryObjectdirectoryObject Remova um usuário da função de diretório.Remove a user from the directory role.
Ativar directoryRoleActivate directoryRole directoryRoledirectoryRole Ative uma função de diretório.Activate a directory role.
deltadelta Coleção directoryRoledirectoryRole collection Obtenha alterações incrementais para as funções de diretório.Get incremental changes for directory roles.

PropriedadesProperties

PropriedadeProperty TipoType DescriçãoDescription
descriptiondescription StringString A descrição da função de diretório. Somente leitura.The description for the directory role. Read-only.
displayNamedisplayName StringString O nome de exibição da função de diretório. Somente leitura.The display name for the directory role. Read-only.
idid StringString O identificador exclusivo da função de diretório. Herdado de directoryObject. Chave, Não Anulável, Somente Leitura.The unique identifier for the directory role. Inherited from directoryObject. Key, Not nullable, Read-only.
roleTemplateIdroleTemplateId StringString A id do directoryRoleTemplate em que esta função se baseia. A propriedade deve ser especificada ao ativar uma função de diretório em um locatário com uma operação POST. Depois que a função directory tiver sido ativada, a propriedade será somente leitura.The id of the directoryRoleTemplate that this role is based on. The property must be specified when activating a directory role in a tenant with a POST operation. After the directory role has been activated, the property is read only.

RelaçõesRelationships

RelaçãoRelationship TipoType DescriçãoDescription
membrosmembers Coleção directoryObjectdirectoryObject collection Usuários que são membros desta função de diretório. Métodos HTTP: GET, POST, DELETE. Somente leitura. Anulável.Users that are members of this directory role. HTTP Methods: GET, POST, DELETE. Read-only. Nullable.

Representação JSONJSON representation

Veja a seguir uma representação JSON do recursoHere is a JSON representation of the resource

{
  "description": "string",
  "displayName": "string",
  "id": "string (identifier)",
  "roleTemplateId": "string"
}