Obtenir un abonnement

Espace de noms: microsoft.graph

Récupérer les propriétés et les relations d’un abonnement.

Consultez le tableau dans la section Autorisations pour la liste des ressources qui prennent en change l’abonnement aux notifications de modification.

Cette API est disponible dans les déploiements cloud nationaux suivants.

Autorisations

En fonction du type de ressource et d’autorisation(délégué ou application) demandé, l’autorisation spécifiée dans le tableau suivant est la moins requise privilégiée pour appeler cette API. Pour en savoir plus, notamment sur les Mesures de prudence avant de choisir des autorisations plus privilégiées, recherchez ces autorisations dans Autorisations.

chatMessage

chatMessage peuvent être spécifiés pour inclure les données de ressource (includeResourceData défini sur true). Dans ce cas, le chiffrement est requis et la création de l’abonnement échoue si un encryptionCertificate n’est pas spécifié pour ces abonnements.

Utilisez l’en-tête de Prefer: include-unknown-enum-members requête pour obtenir les valeurs suivantes dans chatMessagemessageTypeénumération évolutive : systemEventMessage pour /teams/{id}/channels/{id}/messages et /chats/{id}/messages ressource.

conversationMember

Les abonnements conversationMember peuvent être spécifiés pour inclure les données de ressources (includeResourceData défini sur true). Dans ce cas, le chiffrement est requis et la création de l’abonnement échoue si un encryptionCertificate n’est pas spécifié pour ces abonnements.

Équipe, canal et conversation

Les abonnements d’équipe, de canal et de conversation peuvent être spécifiés pour inclure les données de ressources (includeResourceData défini sur true). Dans ce cas, le chiffrement est requis et la création de l’abonnement échoue si un encryptionCertificate n’est pas spécifié pour ces abonnements.

Vous pouvez utiliser le paramètre de chaîne de requête notifyOnUserSpecificProperties lorsque vous vous abonnez aux modifications apportées à une conversation particulière ou au niveau de l’utilisateur. Lorsque vous définissez le paramètre de chaîne de requête notifyOnUserSpecificProperties sur true lors de la création de l’abonnement, deux types de charges utiles sont envoyés à l’abonné. L’un contient des propriétés spécifiques à l’utilisateur, tandis que l’autre est envoyé sans celles-ci. Pour plus d’informations, consultez Obtenir des notifications de modification pour les conversations à l’aide de Microsoft Graph.

aiInsights

Les abonnements à Copilot AI Insights nécessitent une licence Copilot valide qui inclut le plan de service Copilot suivant :

• Microsoft 365 Copilot Chat : 3f30311c-6b1e-48a4-ab79-725b469da960

aiInteraction

Les abonnements aux interactions Copilot AI nécessitent une licence Copilot valide qui inclut le plan de service Copilot suivant :

• Microsoft 365 Copilot Chat : 3f30311c-6b1e-48a4-ab79-725b469da960

Pour les abonnements qui ciblent les interactions Copilot AI dont un utilisateur particulier fait partie, l’utilisateur dans le chemin de ressource doit avoir les plans de service précédents qui lui sont attribués dans un état valide.

Pour les abonnements qui ciblent les interactions Copilot AI pour l’ensemble du client, le locataire doit disposer de licences valides approvisionnées qui incluent tous les plans de service Copilot précédents.

driveItem

D’autres limitations s’appliquent aux abonnements sur des éléments OneDrive. Les limitations s’appliquent à la création, ainsi que de la gestion des abonnements (prise, la mise à jour et suppression d’abonnements).

Sur un OneDrive personnel, vous pouvez vous abonner au dossier racine ou à tout sous-dossier de ce lecteur. Sur OneDrive professionnel ou scolaire, vous pouvez vous abonner uniquement au dossier racine. Des notifications de modification sont envoyées pour les types de modifications demandés sur le dossier abonné ou sur tout fichier, dossier ou autre instance de driveItem dans sa hiérarchie. Vous ne pouvez pas vous abonner à des instances de lecteur ou de driveItem qui ne sont pas des dossiers, comme des fichiers individuels.

contact, événement et message

Vous pouvez vous abonner aux modifications apportées aux ressources de contact, d’événement ou de message Outlook et éventuellement spécifier dans la charge utile de la requête POST s’il faut inclure des données de ressource chiffrées dans les notifications.

La création et la gestion (obtention, mise à jour et suppression) d’un abonnement nécessitent une étendue de lecture de la ressource. Par exemple, pour recevoir des notifications de modification sur les messages, votre application a besoin de l’autorisation Mail Read. Les notifications de modification Outlook prennent en charge les étendues d’autorisation déléguées et d’application. Notez les limitations suivantes :

• L’autorisation déléguée permet de s'abonner à des articles dans des dossiers qui se trouvent uniquement dans la boîte aux lettres de l'utilisateur connecté. Par exemple, vous ne pouvez pas utiliser l’autorisation déléguée Calendars.Read pour vous abonner à des événements dans la boîte aux lettres d’un autre utilisateur.

• Pour vous abonner afin de modifier les notifications de contacts, d’événements ou de messages dans Outlook dans dossierspartagés ou délégués:

  • Permet de s’abonner aux modifications d’éléments dans un dossier ou une boîte aux lettres de l’autorisation d’application correspondante n’importe quel utilisateur dans le client.
  • N’utilisez pas les autorisations de partage d’Outlook (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared et leurs équivalents en lecture/écriture), car elles ne prennent pas en charge l’abonnement aux notifications de modification des éléments dans les dossiers partagés ou délégués.

onlineMeetings, présence

Les abonnements onlineMeetings et de présence nécessitent un chiffrement pour les notifications contenant des données de ressources. La création de l’abonnement échoue si encryptionCertificate et encryptionCertificateId ne sont pas spécifiés si les données de ressource sont souhaitées dans les notifications. Pour plus d’informations, reportez-vous aux rubriques suivantes :

• Configurer les notifications de modification de Microsoft Graph avec les données de ressources (notifications enrichies).
• Obtenir des notifications de modification pour les réunions en ligne.

virtualEventWebinar

Les abonnements aux événements virtuels ne prennent en charge que les notifications de base et sont limités à quelques entités d’un événement virtuel. Pour plus d’informations sur les types d’abonnement pris en charge, consultez Obtenir des notifications de modification pour les mises à jour d’événements virtuels Microsoft Teams.

Requête HTTP

GET /subscriptions/{id}

Paramètres facultatifs de la requête

Cette méthode prend en charge les paramètres de requête OData pour vous aider à personnaliser la réponse.

En-têtes de demande

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 abonnement dans le corps de la réponse.

Exemples

Demande

L’exemple suivant illustre une demande.

GET https://graph.microsoft.com/beta/subscriptions/{id}

// 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.Subscriptions["{subscription-id}"].GetAsync();

// 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
subscriptions, err := graphClient.Subscriptions().BySubscriptionId("subscription-id").Get(context.Background(), nil)

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Subscription result = graphClient.subscriptions().bySubscriptionId("{subscription-id}").get();

const options = {
	authProvider,
};

const client = Client.init(options);

let subscription = await client.api('/subscriptions/{id}')
	.version('beta')
	.get();

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


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


$result = $graphServiceClient->subscriptions()->bySubscriptionId('subscription-id')->get()->wait();

Import-Module Microsoft.Graph.Beta.ChangeNotifications

Get-MgBetaSubscription -SubscriptionId $subscriptionId

# 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.subscriptions.by_subscription_id('subscription-id').get()

Réponse

L’exemple suivant illustre la réponse.

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

{
  "id":"7f105c7d-2dc5-4530-97cd-4e7ae6534c07",
  "resource":"me/messages",
  "applicationId" : "string",
  "changeType":"created,updated",
  "clientState":"secretClientValue",
  "notificationUrl":"https://webhook.azurewebsites.net/api/send/myNotifyClient",
  "lifecycleNotificationUrl":"https://webhook.azurewebsites.net/api/send/lifecycleNotifications",
  "expirationDateTime":"2016-11-20T18:23:45.9356913Z",
  "creatorId": "string",
  "latestSupportedTlsVersion": "v1_2",
  "encryptionCertificate": "",
  "encryptionCertificateId": "",
  "includeResourceData": false,
  "notificationContentType": "application/json"
}