Type de ressource Abonnement

Espace de noms : microsoft.graph

Un abonnement permet à une application cliente de recevoir des notifications de modification concernant les modifications apportées aux données dans Microsoft Graph. Actuellement, les abonnements sont activés pour les ressources suivantes :

  • Une [alerte][] de l’API Microsoft Graph Security.
  • Un [enregistrement d’appel][] généré après un appel ou une réunion dans Microsoft Teams.
  • Un canal dans Microsoft Teams
  • Explorer les conversations dans Microsoft Teams
  • Un [Messagechat][] envoyé par le biais de Teams ou de canaux dans Microsoft Teams.
  • Une conversation dans un groupe Microsoft 365.
  • Une ConversationMember dans une équipe ou un canal dans Microsoft Teams
  • Contenu dans la hiérarchie d’un dossier racine driveItem dans OneDrive Entreprise ou d’un dossier racine ou sous-dossier driveItem dans OneDrive personnel d’un utilisateur.
  • Un groupe dans Azure Active Directory.
  • Une [liste][] sous un site SharePoint.
  • Unmessage, [événement][], ou contact dans Outlook.
  • Une imprimante (lorsqu’un travail d’impression pour l’imprimante atteint l’état JobFetchable, prêt à être extrait pour impression) et un printTaskDefinition dans Impression universelle. Pour plus d’informations, consultez Souscrire pour modifier les notifications à partir des API d’impression cloud.
  • Une équipe dans Microsoft Teams
  • TodoTask d’un utilisateur dans Tâches à faire Microsoft.*
  • Un utilisateur dans Azure Active Directory.

Pour les valeurs de chemin d’accès aux ressources possibles pour chaque ressource prise en charge, consultez Utiliser l’API Microsoft Graph pour obtenir des notifications de modification. Pour savoir comment utiliser les notifications de cycle de vie, consultez Réduire les abonnements manquants et les notifications de modification.

Méthodes

Méthode Type renvoyé Description
Créer un abonnement abonnement S’abonne à une application de lecture pour recevoir des notifications de modification lorsque les données Microsoft Graph changent.
Mettre à jour un abonnement abonnement Renouvelle un abonnement en mettant à jour son heure d’expiration.
Obtenir des abonnements abonnement Répertorie les abonnements actifs.
Obtenir un abonnement abonnement Lit les propriétés et les relations d’un objet subscription.
Supprimer un abonnement Aucun Supprime un objet subscription.

Propriétés

Propriété Type Description Ressources prises en charge
applicationId Chaîne Facultatif. Identificateur de l’application utilisée pour créer l’abonnement. Lecture seule. Tous
changeType Chaîne Obligatoire. Indique le type de modification dans la ressource abonnée qui déclenchera une notification de modification. Les valeurs prises en charge sont : created, updated, deleted. Plusieurs valeurs peuvent être combinées à l’aide d’une liste séparée par des virgules.

Remarque :
  • Les notifications de modification d’élément racine de lecteur et de liste prennent en charge uniquement updated le changeType.
  • Les notifications de modification d’utilisateurs et de groupes prennent en charge le changeType updated et deleted.
  • Tous
    clientState String Optionnel. Spécifie la valeur de la propriété clientState envoyée par le service dans chaque notification de modification. La longueur maximale est de 128 caractères. Le client peut vérifier que la notification de modification provient du service en comparant la valeur de la propriété clientState envoyée avec l’abonnement avec la valeur de la propriété clientState reçue avec chaque notification de modification. Tous
    creatorId String Facultatif. Identificateur de l’utilisateur ou le principal de service qui a créé l’abonnement. Si l’application utilisée déléguée des autorisations nécessaires pour créer l’abonnement, ce champ contient l’id de l’utilisateur connecté dans de que l’application appelle part. Si l’application utilisée autorisations d’application, ce champ contient l’id du principal de service correspondant à l’application. En lecture seule. Tous
    encryptionCertificate Chaîne Facultatif. Représentation encodée en base64 d’un certificat avec une clé publique utilisée pour chiffrer les données de ressource dans les notifications de modification. Facultatif mais obligatoire quand includeResourceData est true. Tous
    encryptionCertificateId String Facultatif. Un identificateur fourni par une application personnalisée pour vous aider à identifier le certificat nécessaire au déchiffrement des données de ressource. Tous
    expirationDateTime DateTimeOffset Obligatoire. Spécifie la date et l’heure d’expiration de l’abonnement webhook. L’heure est au format UTC et peut être une durée de création d’abonnement qui varie en fonction de la ressource abonnée. Consultez le tableau ci-dessous pour connaître la durée maximale d’abonnement prise en charge. Tous
    id Chaîne Facultatif. Identificateur unique pour l’abonnement. En lecture seule. Tous
    includeResourceData Boolean Facultatif. Lorsque la valeur est true, les notifications de modification incluent les données de ressources (telles que le contenu d’un message de conversation). Tous
    latestSupportedTlsVersion Chaîne Facultatif. Indique la dernière version de TLS (Transport Layer Security) que le point de terminaison de notification, spécifié par notificationUrl, prend en charge. Les valeurs possibles sont : v1_0, v1_1, v1_2, v1_3.
    Pour les abonnés dont le point de terminaison de notification prend en charge une version inférieure à la version actuellement recommandée (TLS 1.2), la spécification de cette propriété par un ensemble chronologique leur permet d’utiliser temporairement leur version déconseillée de TLS avant d’effectuer leur mise à niveau vers TLS 1.2. Pour ces abonnés, ne pas définir cette propriété selon la chronologie entraînerait l’échec des opérations d’abonnement.

    Pour les abonnés dont le point de terminaison de la notification prend déjà en charge TLS 1.2, la définition de cette propriété est facultative. Dans ce cas, Microsoft Graph par défaut, la propriété est v1_2.
    Tous
    lifecycleNotificationUrl String Facultatif. L’URL du point de terminaison qui reçoit les notifications de cycle de vie, y compris les notifications subscriptionRemoved et missed. Cette URL doit utiliser le protocole HTTPS. Tous
    notificationQueryOptions String Facultatif. Options de requête OData pour spécifier la valeur de la ressource cible Les clients reçoivent des notifications lorsque la ressource atteint l’état correspondant aux options de requête fournies ici. Avec cette nouvelle propriété dans la charge utile de création d’abonnement, ainsi que toutes les propriétés existantes, les webhooks viennent fournir des notifications chaque fois qu’une ressource atteint l’état souhaité mentionné dans la propriété notificationQueryOptions. Par exemple, lorsque le travail d’impression est terminé ou lorsqu’une valeur de propriété de ressource de travail isFetchable d’impression true devient, etc. Service d’impression universelle
    notificationUrl Chaîne Obligatoire. URL du point de terminaison qui recevra les notifications de modification. Cette URL doit utiliser le protocole HTTPS. Tous
    notificationUrlAppId String Facultatif. ID d’application que le service d’abonnement peut utiliser pour générer le jeton de validation. Cela permet au client de valider l’authenticité de la notification reçue. Tous
    ressource Chaîne Obligatoire. Spécifie la ressource qui sera analysée pour les modifications. N’incluez pas l’URL de base (https://graph.microsoft.com/v1.0/). Voir les valeurs possibles de chemin d’accès ressource pour chaque ressource prise en charge. Tous

    Durée maximale d’abonnement par type de ressource

    Resource Délai d’expiration maximal
    Alerte de sécurité 43 200 minutes (sous 30 jours)
    Teams callRecord 4 230 minutes (sous 3 jours)
    Canal Teams 60 minutes (1 heure)
    Conversation Teams 60 minutes (1 heure)
    Teams chatMessage 60 minutes (1 heure)
    conversationMember Teams 60 minutes (1 heure)
    Équipe Teams 60 minutes (1 heure)
    Conversation de groupe 4 230 minutes (sous 3 jours)
    OneDrive driveItem 42 300 minutes (sous 30 jours)
    Liste SharePoint 42 300 minutes (sous 30 jours)
    Message Outlook, événement, contact 4 230 minutes (sous 3 jours)
    Ressources d’utilisateur, de groupe et d’annuaire 41760 minutes (sous 29 jours)
    présence 60 minutes (1 heure)
    Imprimer imprimante 4 230 minutes (sous 3 jours)
    Imprimer printTaskDefinition 4 230 minutes (sous 3 jours)
    todoTask 4 230 minutes (sous 3 jours)

    Note: les applications existantes et nouvelles ne doivent pas dépasser la valeur prise en charge. À l’avenir, les demandes pour créer ou renouveler un abonnement au-delà de la valeur maximale peut échouer.

    Relations

    Aucun

    Représentation JSON

    Voici une représentation JSON de la ressource.

    {
      "@odata.type": "#microsoft.graph.subscription",
      "id": "String (identifier)",
      "resource": "String",
      "changeType": "String",
      "clientState": "String",
      "notificationUrl": "String",
      "expirationDateTime": "String (timestamp)",
      "applicationId": "String",
      "creatorId": "String",
      "includeResourceData": "Boolean",
      "lifecycleNotificationUrl": "String",
      "encryptionCertificate": "String",
      "encryptionCertificateId": "String",
      "latestSupportedTlsVersion": "String",
      "notificationQueryOptions": "String",
      "notificationUrlAppId": "String"
    }