Enumerar suscripciones

Espacio de nombres: microsoft.graph

Recuperar una lista de suscripciones a webhook.

El contenido de la respuesta depende del contexto en el que la aplicación está llamando; para obtener más información, consulte los escenarios en la sección Permisos.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Permisos

Según el recurso y el tipo de permisos (delegado o de aplicación) solicitado, el permiso especificado en la tabla siguiente es el menos privilegiado necesario para llamar a esta API. Para más información, incluida la toma de precauciones antes de elegir permisos con más privilegios, busque los siguientes permisos en Permisos.

Los resultados de la respuesta se basan en el contexto de la aplicación que realiza la llamada. En las secciones siguientes se describen los escenarios comunes.

aiInsights

Las suscripciones a Copilot AI Insights requieren una licencia válida de Copilot que incluya el siguiente plan de servicio de Copilot:

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

aiInteracción

Las suscripciones en interacciones de IA de Copilot requieren una licencia válida de Copilot que incluya el siguiente plan de servicio de Copilot:

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

En el caso de las suscripciones que se centran en las interacciones de IA de Copilot de las que forma parte un usuario determinado, el usuario de la ruta de acceso del recurso debe tener asignados los planes de servicio anteriores en un estado válido.

En el caso de las suscripciones que se dirigen a las interacciones de IA de Copilot para todo el inquilino, el inquilino debe tener licencias válidas aprovisionadas que incluyan todos los planes de servicio anteriores de Copilot.

Escenarios básicos

Lo más habitual es que una aplicación quiera recuperar las suscripciones que creó originalmente para el usuario que ha iniciado sesión actualmente o para todos los usuarios del directorio (cuentas profesionales o educativas). Estos escenarios no requieren ningún permiso especial más allá de aquellos que la aplicación usó originalmente para crear sus suscripciones.

Escenarios avanzados

En algunos casos, una aplicación quiere recuperar suscripciones creadas por otras aplicaciones. Por ejemplo, un usuario quiere ver todas las suscripciones creadas por cualquier aplicación en su nombre. O bien, un administrador global que quiere ver todas las suscripciones de todas las aplicaciones en su directorio. Para estos escenarios, se requiere un permiso delegado Subscription.Read.All.

Solicitud HTTP

GET /subscriptions

Parámetros de consulta opcionales

Este método no admite los parámetros de consulta OData para ayudar a personalizar la respuesta.

Encabezados de solicitud

Cuerpo de la solicitud

No proporcione un cuerpo de solicitud para este método.

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 200 OK y una lista de objetos subscription en el cuerpo de la respuesta.

Ejemplo

Solicitud

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()

Respuesta

En el ejemplo siguiente se muestra la respuesta.

Nota: La respuesta que se muestra aquí puede acortarse para mejorar la legibilidad.

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"
    }
  ]
}

Nota: el valor de la propiedad clientState no se devuelve por motivos de seguridad.

Cuando una solicitud devuelve varias páginas de datos, la respuesta incluye una propiedad @odata.nextLink para ayudarle a administrar los resultados. Para obtener más información, vea Paginación de los datos de Microsoft Graph en su aplicación.