Liste des abonnements

Espace de noms: microsoft.graph

Récupérez une liste d’abonnements de webhook.

Le contenu de la réponse dépend du contexte dans lequel l’application émet l’appel ; Pour plus d’informations, consultez les scénarios dans la section Autorisations.

Cette API est disponible dans les déploiements de cloud national 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.

Les résultats de réponse sont basés sur le contexte de l’application de l’appel. Les sections suivantes décrivent les scénarios courants.

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 d’accès aux ressources 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 locataire, le locataire doit disposer de licences valides approvisionnées qui incluent tous les plans de service Copilot précédents.

Scénario de base

Le plus souvent, une application souhaite récupérer les abonnements qu’elle a créés à l’origine pour l’utilisateur actuellement connecté ou tous les utilisateurs de l’annuaire (comptes professionnels/scolaires). Ces scénarios ne nécessitent pas d’autorisations spéciales au-delà de celles utilisées à l’origine par l’application pour créer ses abonnements.

Scénarios d’enregistrement avancés

Dans certains cas, une application souhaite récupérer des abonnements créés par les autres applications. Par exemple, un utilisateur souhaite voir tous les abonnements créés par n’importe quelle application en leur nom. Ou un administrateur général qui souhaite voir tous les abonnements de toutes les applications dans son annuaire. Pour ces scénarios, une autorisation déléguée Subscription.Read.All est requise.

Requête HTTP

GET /subscriptions

Paramètres facultatifs de la requête

Cette méthode ne prend pas 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 un200 OKcode de réponse et une liste d’objets d’abonnement dans le corps de la réponse.

Exemple

Demande

GET https://graph.microsoft.com/beta/subscriptions

// 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.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().Get(context.Background(), nil)

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

SubscriptionCollectionResponse result = graphClient.subscriptions().get();

const options = {
	authProvider,
};

const client = Client.init(options);

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

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


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


$result = $graphServiceClient->subscriptions()->get()->wait();

Import-Module Microsoft.Graph.Beta.ChangeNotifications

Get-MgBetaSubscription

# 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.get()

Réponse

L’exemple suivant illustre la réponse.

Remarque : La réponse présentée ici peut être raccourcie pour des raisons de lisibilité.

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

{
  "@odata.context": "https://graph.microsoft.com/beta/$metadata#subscriptions",
  "value": [
    {
      "id": "0fc0d6db-0073-42e5-a186-853da75fb308",
      "resource": "Users",
      "applicationId": "24d3b144-21ae-4080-943f-7067b395b913",
      "changeType": "updated,deleted",
      "clientState": null,
      "notificationUrl": "https://webhookappexample.azurewebsites.net/api/notifications",
      "lifecycleNotificationUrl":"https://webhook.azurewebsites.net/api/send/lifecycleNotifications",
      "expirationDateTime": "2018-03-12T05:00:00Z",
      "creatorId": "8ee44408-0679-472c-bc2a-692812af3437",
      "latestSupportedTlsVersion": "v1_2",
      "encryptionCertificate": "",
      "encryptionCertificateId": "",
      "includeResourceData": false,
      "notificationContentType": "application/json"
    }
  ]
}

Remarque : les valeurs de propriété clientState ne sont pas renvoyées pour des raisons de sécurité.

Lorsqu’une requête renvoie plusieurs pages de données, la réponse inclut une @odata.nextLink propriété pour vous aider à gérer les résultats. Pour plus d’informations, voir Pagination des données Microsoft Graph dans votre application.