Type de ressource Abonnementsubscription resource type

Un abonnement permet à une application cliente de recevoir des notifications concernant les données sur Microsoft Graph.A subscription allows a client app to receive notifications about changes to data in Microsoft Graph. Actuellement, les abonnements sont activés pour les jeux de données suivants :Currently, subscriptions are enabled for the following resources:

  • Unmessage, [événement][], ou [contacter][] dans OutlookA message, event, or contact in Outlook
  • Uneconversation d’un groupe Office 365A conversation of an Office 365 group
  • Contenu de 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 utilisateurContent in the hierarchy of a root folder driveItem in OneDrive for Business, or of a root folder or subfolder driveItem in a user's personal OneDrive
  • Unutilisateurou ungroupedans Azure Active Directory.A user or group in Azure Active Directory
  • Une [alerte][] de l’API de sécurité Microsoft GraphAn alert from the Microsoft Graph Security API

Représentation JSONJSON representation

Voici une représentation JSON de la ressource.Here is a JSON representation of the resource.

{
  "changeType": "string",
  "notificationUrl": "string",
  "resource": "string",
  "applicationId" : "string",
  "expirationDateTime": "String (timestamp)",
  "id": "string (identifier)",
  "clientState": "string",
  "creatorId": "string"
}

PropriétésProperties

PropriétéProperty TypeType DescriptionDescription
changeTypechangeType stringstring Obligatoire.Required. Indique le type de modification de la ressource abonnée qui déclenchera une notification.Indicates the type of change in the subscribed resource that will raise a notification. Les valeurs prises en charge sont : created, updated, deleted.The supported values are: created, updated, deleted. Plusieurs valeurs peuvent être combinées à l’aide d’une liste délimitée par des virgules.Multiple values can be combined using a comma-separated list.

Remarque : Les notifications d’élément racine lecteur prennent uniquement en charge la updated changeType.Note: Drive root item notifications support only the updated changeType. Les notifications d’utilisateur et de groupe prennent pas en charge le changeType updated et deleted.User and group notifications support updated and deleted changeType.
notificationUrlnotificationUrl stringstring Obligatoire.Required. L’URL du point de terminaison qui recevra les notifications.The URL of the endpoint that will receive the notifications. Cette URL doit utiliser le protocole HTTPS.This URL must make use of the HTTPS protocol.
ressourceresource stringstring Obligatoire.Required. Spécifie la ressource qui sera analysée pour les modifications.Specifies the resource that will be monitored for changes. N’incluez pas l’URL de base (https://graph.microsoft.com/v1.0/).Do not include the base URL (https://graph.microsoft.com/v1.0/).
expirationDateTimeexpirationDateTime dateTimedateTime Obligatoire.Required. Spécifie la date et l’heure d’expiration de l’abonnement webhook.Specifies the date and time when the webhook subscription expires. L’heure est au format UTC et peut être une durée depuis la création d’un abonnement, qui varie pour la ressource à laquelle l’utilisateur est abonné.The time is in UTC, and can be an amount of time from subscription creation that varies for the resource subscribed to. Consultez le tableau ci-dessous pour connaître la durée maximale d’abonnement prise en charge.See the table below for maximum supported subscription length of time.
clientStateclientState chaînestring Facultatif.Optional. Spécifie la valeur de la propriété clientState envoyée par le service dans chaque notification.Specifies the value of the clientState property sent by the service in each notification. La longueur maximale est de 128 caractères.The maximum length is 128 characters. Le client peut vérifier que la notification provient du service en comparant la valeur de la propriété clientState envoyée avec l’abonnement et la valeur de la propriété clientState reçue avec chaque notification.The client can check that the notification came from the service by comparing the value of the clientState property sent with the subscription with the value of the clientState property received with each notification.
idid stringstring Identificateur unique pour l’abonnement. En lecture seule.Unique identifier for the subscription. Read-only.
applicationIdapplicationId stringstring Identificateur de l’application utilisée pour créer l’abonnement.Identifier of the application used to create the subscription. En lecture seule.Read-only.
creatorIdcreatorId stringstring Identificateur de l’utilisateur ou le principal de service qui a créé l’abonnement.Identifier of the user or service principal that created the subscription. 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.If the app used delegated permissions to create the subscription, this field contains the id of the signed-in user the app called on behalf of. Si l’application utilisée autorisations d’application, ce champ contient l’id du principal de service correspondant à l’application.If the app used application permissions, this field contains the id of the service principal corresponding to the app. En lecture seule.Read-only.

Durée maximale d’abonnement par type de ressourceMaximum length of subscription per resource type

RessourceResource Délai d’expiration maximalMaximum Expiration Time
CourrierMail 4230 minutes (sous 3 jours)4230 minutes (under 3 days)
CalendrierCalendar 4230 minutes (sous 3 jours)4230 minutes (under 3 days)
ContactsContacts 4230 minutes (sous 3 jours)4230 minutes (under 3 days)
Conversations de groupeGroup conversations 4230 minutes (sous 3 jours)4230 minutes (under 3 days)
Éléments racine de lecteurDrive root items 4230 minutes (sous 3 jours)4230 minutes (under 3 days)
Alertes de sécuritéSecurity alerts 43200 minutes (sous 30 jours)43200 minutes (under 30 days)

Note: les applications existantes et nouvelles ne doivent pas dépasser la valeur prise en charge.Note: Existing applications and new applications should not exceed the supported value. À l’avenir, les demandes pour créer ou renouveler un abonnement au-delà de la valeur maximale peut échouer.In the future, any requests to create or renew a subscription beyond the maximum value will fail.

RelationsRelationships

AucunNone

MéthodesMethods

MéthodeMethod Type renvoyéReturn Type DescriptionDescription
Créer un abonnementCreate subscription abonnementsubscription S’abonne à une application de détecteur pour recevoir des notifications lorsque les données Microsoft Graph changent.Subscribes a listener application to receive notifications when Microsoft Graph data changes.
Mettre à jour un abonnementUpdate subscription abonnementsubscription Renouvelle un abonnement en mettant à jour son heure d’expiration.Renews a subscription by updating its expiration time.
Obtenir des abonnementsList subscriptions abonnementsubscription Répertorie les abonnements actifs.Lists active subscriptions.
Obtenir un abonnementGet subscription abonnementsubscription Lit les propriétés et les relations d’un objet subscription.Reads properties and relationships of subscription object.
Supprimer un abonnementDelete subscription AucunNone Supprime un objet subscription.Deletes a subscription object.