Enumerar suscripciones

Espacio de nombres: microsoft.graph

Importante

Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.

Recupere una lista de suscripciones de 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 nacionales de nube.

Servicio global	Gobierno de EE. UU. L4	Us Government L5 (DOD)	China operada por 21Vianet
✅	✅	✅	✅

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.

Nota:

Algunos recursos admiten notificaciones de cambio en varios escenarios, cada uno de los cuales puede requerir permisos diferentes. En esos casos, use la ruta de acceso del recurso para diferenciar los escenarios.

Recurso admitido	Delegado (cuenta profesional o educativa)	Delegado (cuenta de Microsoft personal)	Aplicación
callRecord	No admitida.	No admitida.	CallRecords.Read.All
callRecording communications/onlineMeetings/getAllRecordings Cualquier grabación estará disponible en el inquilino.	No admitida.	No admitida.	OnlineMeetingRecording.Read.All
callRecording communications/onlineMeetings/{onlineMeetingId}/recordings Cualquier grabación estará disponible para una reunión específica.	OnlineMeetingRecording.Read.All	No admitida.	OnlineMeetingRecording.Read.All
callRecording users/{userId}/onlineMeetings/getAllRecordings Grabación de llamadas que está disponible en una reunión organizada por un usuario específico.	OnlineMeetingRecording.Read.All	No admitida.	OnlineMeetingRecording.Read.All
callRecording appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllRecordings Grabación de llamadas que está disponible en una reunión en la que se instala una aplicación de Teams determinada.	No admitida.	No admitida.	OnlineMeetingRecording.Read.All, OnlineMeetingRecording.Read.Chat
callTranscript communications/onlineMeetings/getAllTranscripts Cualquier transcripción estará disponible en el inquilino.	No admitida.	No admitida.	OnlineMeetingTranscript.Read.All
callTranscript communications/onlineMeetings/{onlineMeetingId}/transcripts Cualquier transcripción estará disponible para una reunión específica.	OnlineMeetingTranscript.Read.All	No admitida.	OnlineMeetingTranscript.Read.All
callTranscript users/{userId}/onlineMeetings/getAllTranscripts Transcripción de llamadas que está disponible en una reunión organizada por un usuario específico.	OnlineMeetingTranscript.Read.All	No admitida.	OnlineMeetingTranscript.Read.All
callTranscript appCatalogs/teamsApps/{id}/installedToOnlineMeetings/getAllTranscripts Transcripción de llamadas que está disponible en una reunión en la que se instala una aplicación de Teams determinada.	No admitida.	No admitida.	OnlineMeetingTranscript.Read.All, OnlineMeetingTranscript.Read.Chat
channel /teams/getAllChannels Todos los canales de una organización.	No admitida.	No admitida.	Channel.ReadBasic.All, ChannelSettings.Read.All
channel /teams/{id}/channels Todos los canales de un equipo determinado de una organización.	Channel.ReadBasic.All, ChannelSettings.Read.All, Subscription.Read.All	No admitida.	Channel.ReadBasic.All, ChannelSettings.Read.All
chat /chats Todos los chats de una organización.	No admitida.	No admitida.	Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat /chats/{id} Un chat en particular.	Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All	No admitida.	ChatSettings.Read.Chat, ChatSettings.ReadWrite.Chat, Chat.Manage.Chat, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chat /appCatalogs/teamsApps/{id}/installedToChats Todos los chats de una organización donde está instalada una aplicación de Teams determinada.	No admitida.	No admitida.	Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
chat /users/{id}/chats Todos los chats de los que forma parte un usuario determinado.	Chat.ReadBasic, Chat.Read, Chat.ReadWrite	No admitida.	Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
chatMessage /teams/{id}/channels/{id}/messages Todos los mensajes y respuestas de un canal determinado.	ChannelMessage.Read.All, Group.Read.All, Group.ReadWrite.All, Subscription.Read.All	No admitida.	ChannelMessage.Read.Group, ChannelMessage.Read.All
chatMessage /teams/getAllMessages Todos los mensajes de canal de la organización.	No admitida.	No admitida.	ChannelMessage.Read.All
chatMessage /chats/{id}/messages Todos los mensajes de un chat.	Chat.Read, Chat.ReadWrite, Subscription.Read.All	No admitida.	Chat.Read.All
chatMessage /chats/getAllMessages Todos los mensajes de chat de una organización.	No admitida.	No admitida.	Chat.Read.All
chatMessage /users/{id}/chats/getAllMessages Mensajes de chat para todos los chats de los que forma parte un usuario determinado.	Chat.Read, Chat.ReadWrite, Subscription.Read.All	No admitida.	Chat.Read.All, Chat.ReadWrite.All
chatMessage /appCatalogs/teamsApps/{id}/installedToChats/getAllMessages Mensajes de chat para todos los chats de una organización donde está instalada una aplicación de Teams determinada.	No admitida.	No admitida.	Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
contact	Contacts.Read, Subscription.Read.All	Contacts.Read, Subscription.Read.All	Contacts.Read
conversationMember /chats/getAllMembers Miembros de todos los chats de una organización.	No admitida.	No admitida.	ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All.
conversationMember /chats/{id}/members Miembros de un chat determinado.	ChatMember.Read, ChatMember.ReadWrite, Chat.ReadBasic, Chat.Read, Chat.ReadWrite, Subscription.Read.All	No admitida.	ChatMember.Read.Chat, Chat.Manage.Chat, ChatMember.Read.All, ChatMember.ReadWrite.All, Chat.ReadBasic.All, Chat.Read.All, Chat.ReadWrite.All
conversationMember appCatalogs/teamsApps/{id}/installedToChats/getAllMembers Miembros de chat para todos los chats de una organización en la que está instalada una aplicación de Teams determinada.	No admitida.	No admitida.	ChatMember.Read.WhereInstalled, ChatMember.ReadWrite.WhereInstalled, Chat.ReadBasic.WhereInstalled, Chat.Read.WhereInstalled, Chat.ReadWrite.WhereInstalled
conversationMember /teams/getAllMembers Miembros de todos los equipos de una organización.	No admitida.	No admitida.	TeamMember.Read.All, TeamMember.ReadWrite.All
conversationMember /teams/{id}/members Miembros de un equipo determinado.	TeamMember.Read.All, Subscription.Read.All	No admitida.	TeamMember.Read.All
conversationMember /teams/{id}/channels/getAllMembers Miembros de todos los canales privados de un equipo determinado.	No admitida.	No admitida.	ChannelMember.Read.All
conversationMember /teams/getAllChannels/getAllMembers	No admitida.	No admitida.	ChannelMember.Read.All
driveItem OneDrive personal del usuario.	No admitida.	Files.ReadWrite, Subscription.Read.All	No admitida.
driveItem OneDrive para la Empresa.	Files.ReadWrite.All, Subscription.Read.All	No admitida.	Files.ReadWrite.All
evento	Calendars.Read, Subscription.Read.All	Calendars.Read, Subscription.Read.All	Calendars.Read
grupo	Group.Read.All, Subscription.Read.All	No admitida.	Group.Read.All
conversación de grupo	Group.Read.All, Subscription.Read.All	No admitida.	No admitida.
lista	Sites.ReadWrite.All, Subscription.Read.All	No admitida.	Sites.ReadWrite.All
message	Mail.ReadBasic, Mail.Read, Subscription.Read.All	Mail.ReadBasic, Mail.Read, Subscription.Read.All	Mail.Read
offerShiftRequest /teams/{id}/schedule/offerShiftRequests Cambios en cualquier solicitud de turno de oferta en un equipo.	Schedule.Read.All, Schedule.ReadWrite.All	No admitida.	Schedule.Read.All, Schedule.ReadWrite.All
reunión en línea	No admitida.	No admitida.	OnlineMeetings.Read.All, OnlineMeetings.ReadWrite.All*
openShiftChangeRequest /teams/{id}/schedule/openShiftChangeRequests Cambios en cualquier solicitud de turno abierta en un equipo.	Schedule.Read.All, Schedule.ReadWrite.All	No admitida.	Schedule.Read.All, Schedule.ReadWrite.All
presencia	Presence.Read.All, Subscription.Read.All	No admitida.	No admitida.
printer	No admitida.	No admitida.	Printer.Read.All, Printer.ReadWrite.All
printTaskDefinition	No admitida.	No admitida.	PrintTaskDefinition.ReadWrite.All
alerta de seguridad	SecurityEvents.ReadWrite.All, Subscription.Read.All	No admitida.	SecurityEvents.ReadWrite.All
shift /teams/{id}/schedule/shifts Cambios en cualquier turno de un equipo.	Schedule.Read.All, Schedule.ReadWrite.All	No admitida.	Schedule.Read.All, Schedule.ReadWrite.All
swapShiftsChangeRequest /teams/{id}/schedule/swapShiftsChangeRequests Cambios en cualquier solicitud de cambio de turno en un equipo.	Schedule.Read.All, Schedule.ReadWrite.All	No admitida.	Schedule.Read.All, Schedule.ReadWrite.All
team /teams Todos los equipos de una organización.	No admitida.	No admitida.	Team.ReadBasic.All, TeamSettings.Read.All
team /teams/{id} Un equipo determinado.	Team.ReadBasic.All, TeamSettings.Read.All, Subscription.Read.All	No admitida.	Team.ReadBasic.All, TeamSettings.Read.All
timeOffRequest /teams/{id}/schedule/timeOffRequests Cambios en cualquier solicitud de tiempo de descuento en un equipo.	Schedule.Read.All, Schedule.ReadWrite.All	No admitida.	Schedule.Read.All, Schedule.ReadWrite.All
todoTask	Tasks.ReadWrite, Subscription.Read.All	Tasks.ReadWrite, Subscription.Read.All	No admitida.
user	User.Read.All, Subscription.Read.All	User.Read.All	User.Read.All
baseTask (en desuso)	Tasks.ReadWrite, Subscription.Read.All	Tasks.ReadWrite, Subscription.Read.All	No admitida.

Nota:

Los permisos siguientes usan el consentimiento específico del recurso:

• OnlineMeetingRecording.Read.Chat
• OnlineMeetingTranscript.Read.Chat
• ChatSettings.Read.Chat
• ChatSettings.ReadWrite.Chat
• Chat.Manage.Chat
• ChannelMessage.Read.Group
• ChatMember.Read.Chat

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.

Escenarios básicos

Normalmente, una aplicación quiere recuperar las suscripciones que creó originalmente para el usuario que inició sesión actualmente o para todos los usuarios del directorio (cuentas profesionales o educativas). Estos escenarios no requieren permisos especiales más allá de los que la aplicación usó originalmente para crear sus suscripciones.

Contexto de la aplicación que realiza la llamada	La respuesta contiene
La aplicación llama en nombre del usuario que haya iniciado sesión (permiso delegado). -y- La aplicación tiene los permisos originales necesarios para crear la suscripción. Nota: Este escenario se aplica tanto a cuentas personales de Microsoft como a cuentas profesionales o educativas.	Suscripciones creadas por la aplicación solo para el usuario que ha iniciado sesión.
La aplicación llama en nombre propio (permiso de aplicación). -y- La aplicación tiene los permisos originales necesarios para crear la suscripción. Nota: Este escenario solo se aplica a cuentas profesionales o educativas.	Suscripciones creadas por la aplicación para sí misma o cualquier usuario del directorio.

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 quiera ver todas las suscripciones de todas las aplicaciones de su directorio. Para estos escenarios, se requiere un permiso delegado Subscription.Read.All.

Contexto de la aplicación que realiza la llamada	La respuesta contiene
La aplicación llama en nombre del usuario que haya iniciado sesión (permiso delegado). El usuario no es un administrador. -y- Las aplicaciones tienen el permiso Subscription.Read.All Nota: Este escenario se aplica tanto a cuentas personales de Microsoft como a cuentas profesionales o educativas.	Suscripciones creadas por cualquier aplicación solo para el usuario que haya iniciado sesión.
La aplicación llama en nombre del usuario que haya iniciado sesión (permiso delegado). El usuario es un administrador global. -y- Las aplicaciones tienen el permiso Subscription.Read.All Nota: Este escenario solo se aplica a cuentas profesionales o educativas.	Suscripciones creadas por cualquier aplicación para cualquier usuario que haya iniciado sesión en el directorio.

Solicitud HTTP

GET /subscriptions

Parámetros de consulta opcionales

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

Encabezados de solicitud

Nombre	Tipo	Descripción
Authorization	string	{token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.

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

HTTP

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

C#

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

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

CLI

mgc-beta subscriptions list

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Ir

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

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Java

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

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

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

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

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PHP

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


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


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

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

PowerShell

Import-Module Microsoft.Graph.Beta.ChangeNotifications

Get-MgBetaSubscription

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

Python

from msgraph_beta import GraphServiceClient

graph_client = GraphServiceClient(credentials, scopes)


result = await graph_client.subscriptions.get()

Importante

Los SDK de Microsoft Graph usan la versión v1.0 de la API de manera predeterminada y no admiten todos los tipos, propiedades y API disponibles en la versión beta. Para obtener más información sobre cómo acceder a la API beta con el SDK, consulte Uso de los SDK de Microsoft Graph con la API beta.

Para obtener más información sobre cómo agregar el SDK al proyecto y crear una instancia de authProvider, consulte la documentación del SDK.

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.