administrativeUnit : delta

Article
10/25/2024

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Obtenez les nouvelles administrativeUnits créées , mises à jour ou supprimées sans avoir à effectuer une lecture complète de l’ensemble de la collection de ressources. Pour plus d’informations, 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

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)	AdministrativeUnit.Read.All	AdministrativeUnit.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	AdministrativeUnit.Read.All	AdministrativeUnit.ReadWrite.All, Directory.Read.All, Directory.ReadWrite.All

Importante

Dans les scénarios délégués avec des comptes professionnels ou scolaires, l’utilisateur connecté doit être un utilisateur membre ou se voir attribuer un rôle Microsoft Entra pris en charge ou un rôle personnalisé avec une autorisation de rôle prise en charge. Les rôles les moins privilégiés suivants sont pris en charge pour cette opération.

Lecteurs d’annuaire : lire les propriétés de base et les membres des unités administratives
Lecteur global : lire toutes les propriétés des unités administratives, y compris les membres
Administrateur de rôle privilégié : gérez entièrement les unités administratives, y compris les membres, mais à l’exclusion des unités administratives restreintes. Pour plus d’informations, consultez Unités administratives de gestion restreintes dans Microsoft Entra ID

Requête HTTP

Pour commencer le suivi des modifications, vous effectuez une requête qui inclut la fonction delta sur la ressource administrativeUnit .

GET /administrativeUnits/delta

Paramètres de requête

Le suivi des modifications 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. Vous n’avez besoin de spécifier des paramètres de requête qu’une fois à l’avance. Dans les requêtes suivantes, copiez et appliquez l’URL @odata.nextLink ou @odata.deltaLink de la réponse précédente. Cette URL inclut déjà les paramètres encodé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 ressources, 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 retourné dans l’URL `@odata.nextLink` de l’appel de fonction delta précédent, indiquant que d’autres modifications doivent être suivies dans la même collection de ressources.

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de requête OData suivants 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.
Pour $filter, la prise en charge est limitée :
- La seule expression prise en charge $filter est pour le suivi des modifications pour des ressources spécifiques, par leur ID : $filter=id+eq+{value} ou $filter=id+eq+{value1}+or+id+eq+{value2}. Le nombre d’ID que vous pouvez spécifier est limité par la longueur maximale de l’URL.

En-têtes de demande

Nom	Description
Autorisation	Porteur {token}. Obligatoire. En savoir plus sur l’authentification et l’autorisation.

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 un objet de collection administrativeUnit dans le corps de la réponse. La réponse inclut également une URL @odata.nextLink ou une URL @odata.deltaLink.

Si une URL @odata.nextLink est renvoyée, d’autres pages de données peuvent être récupérées dans la session. L’administrativeUnit 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.
Si une URL @odata.deltaLink est renvoyée, il n’existe aucune autre donnée sur l’état de la ressource à renvoyer. Conserver et utiliser l’URL @odata.deltaLink pour en savoir plus sur les modifications apportées à la ressource à l’avenir.

Pour plus d’informations et un exemple, consultez Utilisation de la requête delta et Obtenir des modifications incrémentielles pour les utilisateurs.

Exemple

Demande

GET https://graph.microsoft.com/beta/administrativeUnits/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.AdministrativeUnits.Delta.GetAsDeltaGetResponseAsync();

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).



mgc-beta administrative-units delta get

Importante



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

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-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.AdministrativeUnits().Delta().GetAsDeltaGetResponse(context.Background(), nil)

Importante


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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

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

Importante


const options = {
	authProvider,
};

const client = Client.init(options);

let delta = await client.api('/administrativeUnits/delta')
	.version('beta')
	.get();

Importante


<?php
use Microsoft\Graph\Beta\GraphServiceClient;


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


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

Importante


Import-Module Microsoft.Graph.Beta.Identity.DirectoryManagement

Get-MgBetaAdministrativeUnitDelta

Importante


# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta 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.administrative_units.delta.get()

Importante

Réponse

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/beta/$metadata#administrativeunits",
  "@odata.nextLink":"https://graph.microsoft.com/beta/administrativeunits/delta?$skiptoken=pqwSUjGYvb3jQpbwVAwEL7yuI3dU1LecfkkfLPtnIjsXoYQp_dpA3cNJWc",
  "value": [
    {
      "displayName": "Management Fast Track",
      "visibility": null,
      "extension_fe2174665583431c953114ff7268b7b3_Education_ObjectType": "School",
      "extension_fe2174665583431c953114ff7268b7b3_Education_StateId": "WA",
      "extension_fe2174665583431c953114ff7268b7b3_Education_Address": "2 Microsoft Way",
      "extension_fe2174665583431c953114ff7268b7b3_Education_City": "Redmond",
      "extension_fe2174665583431c953114ff7268b7b3_Education_State": "WA",
      "extension_fe2174665583431c953114ff7268b7b3_Education_Country": "US",
      "extension_fe2174665583431c953114ff7268b7b3_Education_Zip": "98052",
      "extension_fe2174665583431c953114ff7268b7b3_Education_Phone": "555-123-4567",
      "extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource": "SIS",
      "extension_fe2174665583431c953114ff7268b7b3_Education_SyncSource_SchoolId": "10002",
      "extension_fe2174665583431c953114ff7268b7b3_Education_SchoolPrincipalSyncSourceId": "14008",
      "extension_fe2174665583431c953114ff7268b7b3_Education_SchoolPrincipalName": "Amy Roebuck",
      "extension_fe2174665583431c953114ff7268b7b3_Education_SchoolPrincipalEmail": "aroebuck@principal.edu",
      "extension_fe2174665583431c953114ff7268b7b3_Education_SchoolZone": "1",
      "id": "8a07f5a8-edc9-4847-bbf2-dde106594bf4",
      "members@delta": [
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "b66ecf79-a093-4d51-86e0-efcc4531f37a"
        },
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "5bde3e51-d13b-4db1-9948-fe4b109d11a7"
        },
        {
            "@odata.type": "#microsoft.graph.group",
            "id": "801f2093-de7e-4883-a786-8a5f30874ff4"
        },
        {
            "@odata.type": "#microsoft.graph.group",
            "id": "7e4ec76c-8276-43ef-ba10-9aaa197cb212"
        },
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "f5289423-7233-4d60-831a-fe107a8551cc"
        },
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "48d31887-5fad-4d73-a9f5-3c356e68a038"
        },
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd"
        },
        {
            "@odata.type": "#microsoft.graph.user",
            "id": "c03e6eaa-b6ab-46d7-905b-73ec7ea1f755"
        }
      ]
  }
  ]
}

Partager via

administrativeUnit : delta

Autorisations

Requête HTTP

Paramètres de requête

Paramètres facultatifs de la requête

En-têtes de demande

Corps de la demande

Réponse

Exemple

Demande

Réponse

Commentaires

Ressources supplémentaires