directoryObject : delta
Espace de noms: microsoft.graph
Obtenez les objets de répertoire nouvellement créés, mis à jour ou supprimés sans effectuer une lecture complète de l’ensemble de la collection directoryObject. Pour plus d’informations sur la fonction delta, consultez Utiliser une requête delta pour suivre les modifications apportées aux données Microsoft Graph pour plus d’informations.
Cette API est disponible dans les déploiements de cloud national suivants.
Service global | Gouvernement des États-Unis L4 | Us Government L5 (DOD) | Chine gérée par 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ✅ |
Autorisations
Le tableau suivant montre l’autorisation la moins privilégiée requise par chaque type de ressource lors de l’appel de cette API. Pour plus d’informations, notamment sur la façon de choisir les autorisations, voir Autorisations.
Ressource prise en charge | Déléguée (compte professionnel ou scolaire) | Application | Déléguée (compte Microsoft personnel) |
---|---|---|---|
application | Application.Read.All | Application.Read.All | Non pris en charge |
administrativeUnit | AdministrativeUnit.Read.All | AdministrativeUnit.Read.All | Non pris en charge |
appRoleAssignment | User.Read.All | User.Read.All | Non pris en charge |
appareil | Device.Read.All | Device.Read.All | Non pris en charge |
directoryRole | RoleManagement.Read.Directory | RoleManagement.Read.Directory | Non pris en charge |
groupe | Group.Read.All | Group.Read.All | Non pris en charge |
orgContact | OrgContact.Read.All | OrgContact.Read.All | Non pris en charge |
servicePrincipal | Application.Read.All | Application.Read.All | Non pris en charge |
utilisateur | User.Read.All | User.Read.All | Non pris en charge |
Requête HTTP
Suivez les modifications d’une collection d’un type d’objet répertoire.
GET /directoryObjects/delta?$filter=isof('microsoft.graph.application')
GET /directoryObjects/delta?$filter=isof('microsoft.graph.administrativeUnit')
GET /directoryObjects/delta?$filter=isof('microsoft.graph.appRoleAssignment') or isof('microsoft.graph.user')
GET /directoryObjects/delta?$filter=isof('microsoft.graph.device')
GET /directoryObjects/delta?$filter=isof('microsoft.graph.directoryRole')
GET /directoryObjects/delta?$filter=isof('microsoft.graph.group')
GET /directoryObjects/delta?$filter=isof('microsoft.graph.orgContact')
GET /directoryObjects/delta?$filter=isof('microsoft.graph.servicePrincipal')
GET /directoryObjects/delta?$filter=isof('microsoft.graph.user')
Suivez les modifications d’un objet répertoire. Cette requête n’est pas prise en charge sur la appRoleAssignment
ressource.
GET /directoryObjects/delta?$filter=id eq '{id}'
Paramètres de requête OData
Cette méthode prend en charge les paramètres de requête OData facultatifs pour vous aider à personnaliser la réponse.
- Vous pouvez utiliser un paramètre de requête
$select
comme dans toute requête GET pour spécifier uniquement les propriétés dont vous avez besoin pour de meilleures performances. La propriété id est toujours renvoyée. - Lors du filtrage de plusieurs objets, par exemple,
/directoryObjects/delta/?$filter= id eq '477e9fc6-5de7-4406-bb2a-7e5c83c9ffff' or id eq '004d6a07-fe70-4b92-add5-e6e37b8affff'
, il existe une limite de 50 expressions de filtre. - Vous pouvez combiner les
$filter
syntaxes. Par exemple :$filter=isof('{resource type}') or id eq '{id}'
. Cela fournit une intersection des objets spécifiés par la correspondance{resource type}
et le type de ressource de{id}
.
En-têtes de demande
Nom | Description |
---|---|
Autorisation | Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation. |
Content-Type | application/json |
Préférence | return=minimal. La spécification de cet en-tête avec une requête qui utilise un @odata.deltaLink retourne uniquement les propriétés de l’objet qui ont changé depuis la dernière ronde. Facultatif. |
Corps de la demande
N’indiquez pas le corps de la demande pour cette méthode.
Réponse
Si elle réussit, cette méthode renvoie 200 OK
le code de réponse et l’objet de collection directoryObject dans le corps de la réponse. La réponse inclut également un jeton d’état qui est une @odata.nextLink
URL ou une @odata.deltaLink
URL.
Si une URL
@odata.nextLink
est renvoyée :- Cela indique qu’il y a plus de pages de données à récupérer dans la session. L’application continue d’effectuer des requêtes à l’aide de l’URL
@odata.nextLink
jusqu’à ce qu’une@odata.deltaLink
URL soit incluse dans la réponse. - La réponse inclut le même ensemble de propriétés que dans la demande de requête delta initiale. Cela vous permet de capturer l’état actuel complet des objets lors du lancement de l’exécution du cycle delta.
- Cela indique qu’il y a plus de pages de données à récupérer dans la session. L’application continue d’effectuer des requêtes à l’aide de l’URL
Si une URL
@odata.deltaLink
est renvoyée :- Cela indique qu’il n’y a plus de données sur l’état existant de la ressource à retourner. Enregistrez et utilisez l’URL
@odata.deltaLink
pour étudier comment changer la ressource dans la passe suivante. - Pour avez le choix de pouvoir spécifier l’en-tête
Prefer:return=minimal
à inclure dans les valeurs de réponse uniquement pour les propriétés qui ont été modifiées depuis que le@odata.deltaLink
a été émis.
- Cela indique qu’il n’y a plus de données sur l’état existant de la ressource à retourner. Enregistrez et utilisez l’URL
Par défaut : retourne les mêmes propriétés que la requête delta initiale
Par défaut, les requêtes utilisant un @odata.deltaLink
ou @odata.nextLink
renvoient les mêmes propriétés sélectionnées dans la requête delta initiale comme suit :
- Si la propriété a changé, la nouvelle valeur est incluse dans la réponse. Cela inclut les propriétés définies pour la valeur null.
- Si la propriété n’a pas changé, l’ancienne valeur est incluse dans la réponse.
- Si la propriété n’a jamais été configurée auparavant, elle ne sera pas du tout incluse dans la réponse.
Remarque : avec ce comportement, en examinant la réponse il n’est pas possible d’indiquer si une propriété change ou non. En outre, les réponses delta ont tendance à être volumineuses, car elles contiennent toutes les valeurs de propriété, comme illustré dans l’exemple 3.
En alternative : retourner uniquement les propriétés modifiées
L’ajout d’un en-tête de requête facultatif prefer:return=minimal
entraîne le comportement suivant :
- Si la propriété a changé, la nouvelle valeur est incluse dans la réponse. Cela inclut les propriétés définies pour la valeur null.
- Si la propriété n’a pas changé, la propriété n’est pas incluse dans la réponse. Cela est différent du comportement par défaut.
Remarque : l’en-tête peut être ajouté à une
@odata.deltaLink
requête à tout moment lors du cycle delta. L’en-tête n’affecte que l’ensemble des propriétés incluses dans la réponse et n’affecte pas comment la requête delta est exécutée. Consultez l’exemple 4.
Exemples
Exemple 1 : Récupérer les modifications d’une collection d’utilisateurs et de groupes
Demande
L’exemple suivant montre une requête utilisant le $filter=isof('{resource type}')
paramètre sur les utilisateurs et les groupes. Comme il n’existe aucun $select
paramètre, un ensemble de propriétés par défaut est suivi et retourné.
GET https://graph.microsoft.com/v1.0/directoryObjects/delta?filter=isof('microsoft.graph.user') or isof('microsoft.graph.group')
Réponse
Voici un exemple de réponse lors de l’utilisation @odata.deltaLink
obtenue à partir de l’initialisation de la requête avec $filter=isof('{resource type}')
. Notez la présence de la propriété members@delta qui inclut les ID des objets membres dans le groupe.
Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#directoryObjects","@odata.nextLink":"https://graph.microsoft.com/v1.0/directoryObjects/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjvY1FSSc_",
"value":[
{
"@odata.type": "#microsoft.graph.user",
"displayName": "Adele Vance",
"givenName": "Adele",
"jobTitle": "Retail Manager",
"surname": "Vance",
"userPrincipalName": "AdeleV@contoso.com",
"id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd"
},
{
"@odata.type": "#microsoft.graph.group",
"createdDateTime":"2021-03-12T10:36:14Z",
"description":"This is the default group for everyone in the network",
"displayName":"All Company",
"groupTypes": [
"Unified"
],
"mail": "allcompany@contoso.com",
"id": "72052a9a-c466-4995-8210-95a1c1221995",
"members@delta": [
{
"@odata.type": "#microsoft.graph.user",
"id": "693acd06-2877-4339-8ade-b704261fe7a0"
},
{
"@odata.type": "#microsoft.graph.user",
"id": "49320844-be99-4164-8167-87ff5d047ace"
}
]
}
]
}
Exemple 2 : Récupérer une collection de modifications pour un objet répertoire
Demande
Voici un exemple montrant la requête à l’aide du $filter=id eq '{id}'
paramètre . Comme il n’existe aucun $select
paramètre, un ensemble de propriétés par défaut est suivi et retourné.
GET https://graph.microsoft.com/v1.0/directoryObjects/delta?$filter=id eq '87d349ed-44d7-43e1-9a83-5f2406dee5bd'
Réponse
Voici un exemple de réponse lors de l’utilisation @odata.deltaLink
obtenue à partir de l’initialisation de la requête avec $filter=id eq '{id}'
.
Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
"@odata.nextLink":"https://graph.microsoft.com/v1.0/directoryObjects/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
"value": [
{
"@odata.type": "#microsoft.graph.group",
"createdDateTime":"2021-03-12T10:36:14Z",
"description":"This is the default group for everyone in the network",
"displayName":"All Company",
"groupTypes": [
"Unified"
],
"mail": "allcompany@contoso.com",
"id": "72052a9a-c466-4995-8210-95a1c1221995",
"members@delta": [
{
"@odata.type": "#microsoft.graph.user",
"id": "693acd06-2877-4339-8ade-b704261fe7a0"
},
{
"@odata.type": "#microsoft.graph.user",
"id": "49320844-be99-4164-8167-87ff5d047ace"
}
]
}
]
}
Exemple 3 : Récupérer les modifications apportées à des propriétés spécifiques pour une collection d’utilisateurs et de groupes
Demande
L’exemple suivant montre la requête initiale sélectionnant une propriété à partir d’un utilisateur et d’un groupe pour le suivi des modifications, avec le comportement de réponse par défaut :
GET https://graph.microsoft.com/v1.0/directoryObjects/delta?$filter=isof('microsoft.graph.user') or isof('microsoft.graph.group')&$select=microsoft.graph.user/surname,microsoft.graph.group/displayName
Réponse
Voici un exemple de réponse lors de l’utilisation @odata.deltaLink
obtenue à partir de l’initialisation de la requête. Les deux propriétés sont incluses dans la réponse et il n’est pas connu celles qui ont changé depuis que le @odata.deltaLink
a été obtenu.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
"@odata.nextLink":"https://graph.microsoft.com/v1.0/directoryObjects/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
"value": [
{
"@odata.type": "#microsoft.graph.user",
"surname": "Vance",
"id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd"
},
{
"@odata.type": "#microsoft.graph.group",
"displayName":"All Company",
"id": "72052a9a-c466-4995-8210-95a1c1221995",
}
]
}
Exemple 4 : Récupérer des propriétés spécifiques uniquement si elles ont été modifiées pour une collection d’utilisateurs et de groupes
Demande
L’exemple suivant montre la requête initiale sélectionnant une propriété à partir d’un utilisateur et d’un groupe pour le suivi des modifications, avec un comportement de réponse minimal alternatif :
GET https://graph.microsoft.com/v1.0/directoryObjects/delta?$filter=isof('microsoft.graph.user') or isof('microsoft.graph.group')&$select=microsoft.graph.user/surname,microsoft.graph.group/displayName
Prefer: return=minimal
Réponse
Voici un exemple de réponse lors de l’utilisation @odata.deltaLink
obtenue à partir de l’initialisation de la requête. La microsoft.graph.user/surname
propriété n’est pas incluse, ce qui signifie qu’elle n’a pas changé depuis la dernière requête delta ; microsoft.graph.group/displayName
est incluse, ce qui signifie que sa valeur a changé.
HTTP/1.1 200 OK
Content-type: application/json
{
"@odata.context":"https://graph.microsoft.com/v1.0/$metadata#directoryObjects",
"@odata.nextLink":"https://graph.microsoft.com/v1.0/directoryObjects/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
"value": [
{
"@odata.type": "#microsoft.graph.group",
"displayName":"Everyone",
"id": "72052a9a-c466-4995-8210-95a1c1221995",
}
]
}
Contenu connexe
Commentaires
https://aka.ms/ContentUserFeedback.
Bientôt disponible : Tout au long de 2024, nous allons supprimer progressivement GitHub Issues comme mécanisme de commentaires pour le contenu et le remplacer par un nouveau système de commentaires. Pour plus d’informations, consultezEnvoyer et afficher des commentaires pour