group: delta

Article
03/15/2024

Espace de noms: microsoft.graph

Obtenez des groupes nouvellement créés, mis à jour ou supprimés, y compris les modifications d’appartenance aux groupes, sans avoir à effectuer une lecture complète de l’ensemble de la collection de groupes. Pour plus d’informations, consultez Utilisation d’une requête Delta .

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

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	GroupMember.Read.All	Directory.Read.All, Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	GroupMember.Read.All	Directory.Read.All, Directory.ReadWrite.All, Group.Read.All, Group.ReadWrite.All

Requête HTTP

Pour commencer le suivi des modifications, vous effectuez une requête et incluez la fonction delta sur la ressource groups.

GET /groups/delta

Paramètres de requête

Le suivi des modifications dans les groupes entraîne une série d’appels de fonction delta . Si vous utilisez un paramètre de requête (autre que $deltatoken et $skiptoken), vous devez le spécifier dans la requête delta initiale. Microsoft Graph code automatiquement les paramètres spécifiés dans la partie jeton du @odata.nextLink ou de l’URL @odata.deltaLink fournie dans la réponse.

Il vous suffit de spécifier les paramètres de requête de votre choix la première fois.

Dans les requêtes suivantes, copiez et appliquez le @odata.nextLink ou l’URL @odata.deltaLink à partir de la réponse précédente, car cette URL inclut déjà les paramètres codés souhaités.

Paramètre de requête	Type	Description
$deltatoken	string	Jeton d’état retourné dans l’URL `@odata.deltaLink` de l’appel de fonction delta précédent pour la même collection de groupes, indiquant la fin de cette série de suivi des modifications. Enregistrez et appliquez l’ensemble de l’URL `@odata.deltaLink`, y compris ce jeton dans la première requête de la série suivante de suivi des modifications pour cette collection.
$skiptoken	string	Jeton d’état renvoyé dans l’URL `@odata.nextLink` de l’appel de fonction delta précédent, indiquant que des modifications supplémentaires doivent être suivies dans la même collection de groupes.

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.
Vous pouvez utiliser $select=members pour obtenir des modifications d’appartenance. Vous pouvez également suivre d’autres modifications telles que la propriété et bien plus encore en sélectionnant n’importe quelle relation de groupe de type directoryObject collection.
La prise en charge $filterde :
- La seule expression $filter prise en charge concerne le suivi des modifications sur un objet spécifique : $filter=id+eq+{value}. Vous pouvez filtrer plusieurs objets. Par exemple, https://graph.microsoft.com/v1.0/groups/delta/?$filter= id eq '477e9fc6-5de7-4406-bb2a-7e5c83c9ffff' or id eq '004d6a07-fe70-4b92-add5-e6e37b8affff'. Une limite est fixée à 50 objets filtrés.

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. Spécifiant cet en-tête avec une demande utilisant un `@odata.deltaLink` retourne uniquement les propriétés d’objet qui ont été modifiées depuis la dernière passe. 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 un code de réponse 200 OK et un objet de collection group 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 que la réponse contienne une URL @odata.deltaLink.
- 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.
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.

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.

En alternative : retourner uniquement les propriétés modifiées

Ajout d’un en-tête de la demande facultatif ( prefer:return=minimal ) engendre 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. (Différent du comportement par défaut).

Exemple

Demande 1

L’exemple suivant illustre une demande. 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/groups/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.Groups.Delta.GetAsDeltaGetResponseAsync();


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc groups delta get



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)



delta, err := graphClient.Groups().Delta().GetAsDeltaGetResponse(context.Background(), nil)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

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


const options = {
	authProvider,
};

const client = Client.init(options);

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


<?php
use Microsoft\Graph\GraphServiceClient;


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


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


Import-Module Microsoft.Graph.Groups

Get-MgGroupDelta


from msgraph import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


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

Réponse 1

Voici un exemple de réponse lors de l’utilisation @odata.deltaLink obtenue à partir de l’initialisation de la requête.

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#groups","@odata.nextLink":"https://graph.microsoft.com/v1.0/groups/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjvY1FSSc_",
  "value":[
    {
      "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",
      "members@delta": [
        {
          "@odata.type": "#microsoft.graph.user",
          "id": "693acd06-2877-4339-8ade-b704261fe7a0"
        },
        {
          "@odata.type": "#microsoft.graph.user",
          "id": "49320844-be99-4164-8167-87ff5d047ace"
        }
      ]
    }
  ]
}

Demande 2

L’exemple suivant montre la requête initiale sélectionnant trois propriétés pour le suivi des modifications, avec le comportement de réponse par défaut :

GET https://graph.microsoft.com/v1.0/groups/delta?$select=displayName,description,mailNickname


// 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.Groups.Delta.GetAsDeltaGetResponseAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Select = new string []{ "displayName","description","mailNickname" };
});


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc groups delta get --select "displayName,description,mailNickname"



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestParameters := &graphgroups.GroupsDelta()RequestBuilderGetQueryParameters{
	Select: [] string {"displayName","description","mailNickname"},
}
configuration := &graphgroups.GroupsDelta()RequestBuilderGetRequestConfiguration{
	QueryParameters: requestParameters,
}

delta, err := graphClient.Groups().Delta().GetAsDeltaGetResponse(context.Background(), configuration)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.groups().delta().get(requestConfiguration -> {
	requestConfiguration.queryParameters.select = new String []{"displayName", "description", "mailNickname"};
});


const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/groups/delta')
	.select('displayName,description,mailNickname')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Groups\Delta\DeltaRequestBuilderGetRequestConfiguration;


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

$requestConfiguration = new DeltaRequestBuilderGetRequestConfiguration();
$queryParameters = DeltaRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->select = ["displayName","description","mailNickname"];
$requestConfiguration->queryParameters = $queryParameters;


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


Import-Module Microsoft.Graph.Groups

Get-MgGroupDelta -Property "displayName,description,mailNickname"


from msgraph import GraphServiceClient
from msgraph.generated.groups.delta.delta_request_builder import DeltaRequestBuilder

graph_client = GraphServiceClient(credentials, scopes)

query_params = DeltaRequestBuilder.DeltaRequestBuilderGetQueryParameters(
		select = ["displayName","description","mailNickname"],
)

request_configuration = DeltaRequestBuilder.DeltaRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)

result = await graph_client.groups.delta.get(request_configuration = request_configuration)

Réponse 2

Voici un exemple de réponse lors de l’utilisation @odata.deltaLink obtenue à partir de l’initialisation de la requête. Les trois propriétés sont incluses dans la réponse et on ne sait pas lesquelles ont changé depuis l’obtention @odata.deltaLink de .

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#groups",
  "@odata.nextLink":"https://graph.microsoft.com/v1.0/groups/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
  "value": [
    {
      "displayName": "All Company",
      "description": null,
      "mailNickname": "allcompany@contoso.com"
    }
  ]
}

Demande 3

L’exemple suivant montre la requête initiale sélectionnant trois propriétés pour le suivi des modifications, avec un comportement de réponse minimal alternatif :

GET https://graph.microsoft.com/v1.0/groups/delta?$select=displayName,description,mailNickname
Prefer: return=minimal


// 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.Groups.Delta.GetAsDeltaGetResponseAsync((requestConfiguration) =>
{
	requestConfiguration.QueryParameters.Select = new string []{ "displayName","description","mailNickname" };
	requestConfiguration.Headers.Add("Prefer", "return=minimal");
});


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc groups delta get --select "displayName,description,mailNickname"



import (
	  "context"
	  abstractions "github.com/microsoft/kiota-abstractions-go"
	  msgraphsdk "github.com/microsoftgraph/msgraph-sdk-go"
	  graphgroups "github.com/microsoftgraph/msgraph-sdk-go/groups"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


headers := abstractions.NewRequestHeaders()
headers.Add("Prefer", "return=minimal")

requestParameters := &graphgroups.GroupsDelta()RequestBuilderGetQueryParameters{
	Select: [] string {"displayName","description","mailNickname"},
}
configuration := &graphgroups.GroupsDelta()RequestBuilderGetRequestConfiguration{
	Headers: headers,
	QueryParameters: requestParameters,
}

delta, err := graphClient.Groups().Delta().GetAsDeltaGetResponse(context.Background(), configuration)


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

var result = graphClient.groups().delta().get(requestConfiguration -> {
	requestConfiguration.queryParameters.select = new String []{"displayName", "description", "mailNickname"};
	requestConfiguration.headers.add("Prefer", "return=minimal");
});


const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/groups/delta')
	.header('Prefer','return=minimal')
	.select('displayName,description,mailNickname')
	.get();


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Groups\Delta\DeltaRequestBuilderGetRequestConfiguration;


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

$requestConfiguration = new DeltaRequestBuilderGetRequestConfiguration();
$headers = [
		'Prefer' => 'return=minimal',
	];
$requestConfiguration->headers = $headers;

$queryParameters = DeltaRequestBuilderGetRequestConfiguration::createQueryParameters();
$queryParameters->select = ["displayName","description","mailNickname"];
$requestConfiguration->queryParameters = $queryParameters;


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


Import-Module Microsoft.Graph.Groups

Get-MgGroupDelta -Property "displayName,description,mailNickname"


from msgraph import GraphServiceClient
from msgraph.generated.groups.delta.delta_request_builder import DeltaRequestBuilder

graph_client = GraphServiceClient(credentials, scopes)

query_params = DeltaRequestBuilder.DeltaRequestBuilderGetQueryParameters(
		select = ["displayName","description","mailNickname"],
)

request_configuration = DeltaRequestBuilder.DeltaRequestBuilderGetRequestConfiguration(
query_parameters = query_params,
)
request_configuration.headers.add("Prefer", "return=minimal")


result = await graph_client.groups.delta.get(request_configuration = request_configuration)

Réponse 3

Voici un exemple de réponse lors de l’utilisation @odata.deltaLink obtenue à partir de l’initialisation de la requête. La mailNickname propriété n’est pas incluse, ce qui signifie qu’elle n’a pas changé depuis la dernière requête delta ; displayName et description sont incluses, ce qui signifie que leurs valeurs ont changé.

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

{
  "@odata.context":"https://graph.microsoft.com/v1.0/$metadata#groups",
  "@odata.nextLink":"https://graph.microsoft.com/v1.0/groups/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
  "value": [
    {
      "displayName": "Everyone",
      "description": null
    }
  ]
}

group: delta

Autorisations

Requête HTTP

Paramètres de requête

Paramètres de requête OData

En-têtes de demande

Corps de la demande

Réponse

Par défaut : retourne les mêmes propriétés que la requête delta initiale

En alternative : retourner uniquement les propriétés modifiées

Exemple

Demande 1

Réponse 1

Demande 2

Réponse 2

Demande 3

Réponse 3

Commentaires

Commentaires

Ressources supplémentaires

group: delta

Autorisations

Requête HTTP

Paramètres de requête

Paramètres de requête OData

En-têtes de demande

Corps de la demande

Réponse

Par défaut : retourne les mêmes propriétés que la requête delta initiale

En alternative : retourner uniquement les propriétés modifiées

Exemple

Demande 1

Réponse 1

Demande 2

Réponse 2

Demande 3

Réponse 3

Contenu connexe

Commentaires

Commentaires

Ressources supplémentaires