directoryRole: delta

Artículo
10/26/2024

Espacio de nombres: microsoft.graph

Obtenga roles de directorio recién creados, actualizados o eliminados sin tener que realizar una lectura completa de toda la colección de recursos. Para obtener más información, consulte Uso de la consulta delta para realizar un seguimiento de los cambios en los datos de Microsoft Graph para obtener más información.

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	✅	✅	✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso	Permisos con privilegios mínimos	Permisos con privilegios más altos
Delegado (cuenta profesional o educativa)	RoleManagement.Read.Directory	Directory.Read.All, Directory.ReadWrite.All, RoleManagement.ReadWrite.Directory
Delegado (cuenta personal de Microsoft)	No admitida.	No admitida.
Aplicación	RoleManagement.Read.Directory	Directory.Read.All, Directory.ReadWrite.All, RoleManagement.ReadWrite.Directory

Importante

En escenarios delegados con cuentas profesionales o educativas, al usuario que ha iniciado sesión se le debe asignar un rol de Microsoft Entra compatible o un rol personalizado con un permiso de rol admitido. Se admiten los siguientes roles con privilegios mínimos para esta operación.

Administrador de usuarios
Administrador del servicio de asistencia
Administrador de soporte técnico de servicio
Administrador de facturación
Usuario
Administrador de buzones
Lectores de directorio
Escritores de directorios
Administrador de la aplicación
Lector de seguridad
Administrador de seguridad
Administrador de roles con privilegios
Administrador de aplicaciones en la nube
Aprobador de acceso de caja de seguridad del cliente
Administrador de Dynamics 365
Administrador de Power BI
Administrador de Azure Information Protection
Administrador de Análisis de escritorio
Administrador de licencias
Administrador de Escritorio administrado de Microsoft
Administrador de autenticación
Administrador de autenticación con privilegios
Administrador de comunicaciones de Teams
Ingeniero de soporte en comunicaciones de Teams
Especialista de soporte en comunicaciones de Teams
Administrador de Teams
Administrador de Insights
Administrador de datos de cumplimiento
Operador de seguridad
Administrador de Kaizala
Lector global
Usuario del Centro de negocios de licencias por volumen
Usuario del Centro de servicios de licencias por volumen
Administrador de comercio moderno
Microsoft Store para Empresas usuario
Revisor de directorios

Solicitud HTTP

Para comenzar a realizar el seguimiento de los cambios, realice una solicitud que incluya la función delta en el recurso directoryRole .

GET /directoryRoles/delta

Parámetros de consulta

El seguimiento de los cambios genera una ronda de una o varias llamadas de función delta . Si usa cualquier parámetro de consulta (distinto de $deltatoken y $skiptoken), debe especificarlo en la solicitud delta inicial. Microsoft Graph codifica automáticamente cualquier parámetro especificado en la parte del token de la URL @odata.nextLink o @odata.deltaLink proporcionada en la respuesta. Solo debe especificar una vez por adelantado los parámetros de consulta deseados. En solicitudes posteriores, copie y aplique la dirección URL @odata.nextLink o @odata.deltaLink de la respuesta anterior, dado que la dirección URL ya incluye los parámetros codificados deseados.

Parámetro de consulta	Tipo	Descripción
$deltatoken	string	Un token de estado devuelto en la `@odata.deltaLink` dirección URL de la llamada de función delta anterior para la misma colección de recursos, que indica la finalización de esa ronda de seguimiento de cambios. Guarde y aplique toda la dirección URL `@odata.deltaLink`, incluido este token, en la primera solicitud de la siguiente ronda de seguimiento de cambios de la colección.
$skiptoken	string	Token de estado devuelto en la `@odata.nextLink` dirección URL de la llamada a la función delta anterior, lo que indica que hay más cambios de los que realizar un seguimiento en la misma colección de recursos.

Parámetros de consulta de OData

Este método admite parámetros de consulta de OData a modo de ayuda para personalizar la respuesta.

Puede utilizar un parámetro de consulta $select como en cualquier solicitud GET para especificar solo las propiedades que necesita para un mejor rendimiento. Siempre se devuelve la propiedad id.
Hay compatibilidad limitada para $filter:
- La única expresión admitida $filter es para realizar el seguimiento de los cambios de recursos específicos, por su identificador: $filter=id+eq+{value} o $filter=id+eq+{value1}+or+id+eq+{value2}. El número de identificadores que puede especificar está limitado por la longitud máxima de la dirección URL.

Encabezados de solicitud

Nombre	Descripción
Authorization	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type	application/json

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta y un 200 OK objeto de colección directoryRole en el cuerpo de la respuesta. La respuesta también incluye una dirección URL @odata.nextLink o @odata.deltaLink.

Si se devuelve una dirección URL @odata.nextLink, hay más páginas de datos para recuperar en la sesión. La aplicación continúa realizando solicitudes mediante la dirección URL @odata.nextLink hasta que se incluya dirección URL @odata.deltaLink en la respuesta.
Si se devuelve dirección URL @odata.deltaLink, no hay más datos sobre el estado existente del recurso para devolver. Guarde @odata.deltaLink la dirección URL y aplíquela en la siguiente llamada delta para obtener información sobre los cambios en el recurso en el futuro.

Ejemplo

Solicitud

GET https://graph.microsoft.com/v1.0/directoryRoles/delta


// Code snippets are only available for the latest version. Current version is 5.x

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.DirectoryRoles.Delta.GetAsDeltaGetResponseAsync();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.



mgc directory-roles delta get

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.



// Code snippets are only available for the latest major version. Current major version is $v1.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  //other-imports
)


// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
delta, err := graphClient.DirectoryRoles().Delta().GetAsDeltaGetResponse(context.Background(), nil)

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.directoryRoles().delta().get();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/directoryRoles/delta')
	.get();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


<?php
use Microsoft\Graph\GraphServiceClient;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);


$result = $graphServiceClient->directoryRoles()->delta()->get()->wait();

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


Import-Module Microsoft.Graph.Identity.DirectoryManagement

Get-MgDirectoryRoleDelta

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph import GraphServiceClient
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python

result = await graph_client.directory_roles.delta.get()

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Respuesta

Nota: Se puede acortar el objeto de respuesta que se muestra aquí para mejorar la legibilidad.

HTTP/1.1 200 OK
Content-type: application/json

{
  "@odata.context": "https://graph.microsoft.com/v1.0/$metadata#directoryRoles",
  "@odata.nextLink": "https://graph.microsoft.com/v1.0/directoryRoles/delta?$skiptoken=pkXMyA5aFCIMmH1Kk1XEAnf2X-fodqXKXF03gYPQknSHRxogVsxvSq_26nhos-O2-shortened",
  "value": [
    {
      "description": "Device Administrators",
      "displayName": "Azure AD Joined Device Local Administrator",
      "roleTemplateId": "9f06204d-73c1-4d4c-880a-6edb90606fd8",
      "id": "f8e85ed8-f66f-4058-b170-3efae8b9c6e5",
      "members@delta": [
        {
          "@odata.type": "#microsoft.graph.user",
          "id": "bb165b45-151c-4cf6-9911-cd7188912848",
          "@removed": {
            "reason": "deleted"
          }
        }
      ]
    }
  ]
}

Uso de una consulta delta para realizar un seguimiento de los cambios en los datos de Microsoft Graph para obtener más detalles
Obtener los cambios incrementales de usuarios para obtener un ejemplo de solicitud.

Compartir a través de

directoryRole: delta

Permissions

Solicitud HTTP

Parámetros de consulta

Parámetros de consulta de OData

Encabezados de solicitud

Cuerpo de la solicitud

Respuesta

Ejemplo

Solicitud

Respuesta

Comentarios

Recursos adicionales

Compartir a través de

directoryRole: delta

Permissions

Solicitud HTTP

Parámetros de consulta

Parámetros de consulta de OData

Encabezados de solicitud

Cuerpo de la solicitud

Respuesta

Ejemplo

Solicitud

Respuesta

Contenido relacionado

Comentarios

Recursos adicionales