Eliminar suscripción

Espacio de nombres: microsoft.graph

Elimina una suscripción.

Para obtener la lista de recursos que admiten la suscripción a notificaciones de cambio, consulte la tabla de la sección Permisos .

Esta API está disponible en las siguientes implementaciones nacionales de nube.

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.

chatMessage

Las suscripciones de chatMessage se pueden especificar para incluir datos de recursos (includeResourceData establecido en true). En ese caso, se requiere cifrado y se produce un error en la creación de la suscripción si no se especifica un cifradoCertificate para dichas suscripciones.

Use el encabezado de Prefer: include-unknown-enum-members solicitud para obtener los siguientes valores en la enumeración evolvablechatMessagemessageType: systemEventMessage for /teams/{id}/channels/{id}/messages y /chats/{id}/messages resource.

conversationMember

Las suscripciones conversationMember se pueden especificar para incluir datos de recursos (includeResourceData establecido en true). En ese caso, se requiere cifrado y se produce un error en la creación de la suscripción si no se especifica un cifradoCertificate para dichas suscripciones.

equipo, canal y chat

Se pueden especificar suscripciones de equipo, canal y chat para incluir datos de recursos (includeResourceData establecido en true). En ese caso, se requiere cifrado y se produce un error en la creación de la suscripción si no se especifica un cifradoCertificate para dichas suscripciones.

Puede usar el parámetro de cadena de consulta notifyOnUserSpecificProperties al suscribirse a cambios en un chat determinado o en el nivel de usuario. Al establecer el parámetro de cadena de consulta notifyOnUserSpecificPropertiestrue en durante la creación de la suscripción, se envían dos tipos de cargas al suscriptor. Un tipo contiene propiedades específicas del usuario y el otro se envía sin ellas. Para obtener más información, consulte Obtención de notificaciones de cambios para chats con Microsoft Graph.

Ejemplo de solicitud

Especifique el parámetro de consulta model en la propiedad del recurso en el cuerpo de la solicitud.

POST https://graph.microsoft.com/v1.0/subscriptions
Content-type: application/json

{
   "changeType": "created",
   "notificationUrl": "https://webhook.azurewebsites.net/api/send/myNotifyClient",
   "resource": "chats/getAllMessages?model=A",
   "expirationDateTime":"2016-11-20T18:23:45.9356913Z",
   "clientState": "secretClientValue",
   "latestSupportedTlsVersion": "v1_2"
}

aiInteraction

Las suscripciones en interacciones de IA de Copilot requieren una licencia de Copilot válida 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 tienen como destino 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 tienen como destino interacciones de IA de Copilot para todo el inquilino, el inquilino debe tener aprovisionadas licencias válidas que incluyan todos los planes de servicio de Copilot anteriores.

driveItem

Se aplican más limitaciones a las suscripciones en elementos de OneDrive. Estas limitaciones se aplican para crear y administrar (obtener, actualizar y eliminar) las suscripciones.

En OneDrive personal, puede suscribirse a la carpeta raíz o a cualquier subcarpeta de la unidad. En OneDrive para el trabajo o la escuela, solo puede suscribirse a la carpeta raíz. Las notificaciones de cambio se envían para los tipos de cambios solicitados en la carpeta suscrita o en cualquier archivo, carpeta u otras instancias de driveItem de su jerarquía. No puede suscribirse a instancias de drive o driveItem que no sean carpetas, como archivos individuales.

contactos, eventos y mensajes

Puede suscribirse a los cambios en los recursos de contacto, evento o mensaje de Outlook y, opcionalmente, especificar en la carga de la solicitud POST si se deben incluir datos de recursos cifrados en las notificaciones.

Crear y administrar (obtener, actualizar y eliminar) una suscripción requiere un ámbito de lectura para el recurso. Por ejemplo, para obtener notificaciones de cambio de mensajes, la aplicación necesita el permiso Mail.Read. Las notificaciones de cambio de Outlook admiten ámbitos de permisos delegados y de aplicación. Tenga en cuenta las siguientes limitaciones:

• El permiso delegado es compatible con la suscripción a los elementos en las carpetas que se encuentran solo en el buzón del usuario que ha iniciado sesión. Por ejemplo, no puede usar el permiso delegado Calendars.Read para suscribirse a eventos en el buzón de otro usuario.

• Para suscribirse y cambiar las notificaciones de eventos, contactos o mensajes de Outlook en carpetas compartidas o delegadas:

  • Use los permisos de aplicación correspondientes para suscribirse a los cambios de los elementos de una carpeta o un buzón de cualquier usuario del espacio empresarial.
  • No use los permisos de uso compartido de Outlook (Contacts.Read.Shared, Calendars.Read.Shared, Mail.Read.Shared y sus homólogos de lectura y escritura), ya que no admiten la suscripción a notificaciones de cambios en elementos de carpetas compartidas o delegadas.

onlineMeetings, presencia

Las suscripciones onlineMeetings y presence requieren cifrado para las notificaciones con datos de recursos. Se produce un error en la creación de la suscripción si no se especifican encryptionCertificate y encryptionCertificateId si los datos de recursos se desean en las notificaciones. Para más información, vea:

• Configure las notificaciones de cambio de Microsoft Graph con datos de recursos (notificaciones enriquecidas).
• Obtener notificaciones de cambio para reuniones en línea.

virtualEventWebinar

Las suscripciones en eventos virtuales solo admiten notificaciones básicas y están limitadas a algunas entidades de un evento virtual. Para obtener más información sobre los tipos de suscripción admitidos, consulte Obtención de notificaciones de cambio para las actualizaciones de eventos virtuales de Microsoft Teams.

Solicitud HTTP

DELETE /subscriptions/{subscription-id}

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 204 No Content.

Vea Respuestas de error para obtener detalles sobre la manera en que se devuelven los errores.

Ejemplo

Solicitud

En el ejemplo siguiente se muestra la solicitud.

DELETE https://graph.microsoft.com/beta/subscriptions/7f105c7d-2dc5-4530-97cd-4e7ae6534c07

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

// 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
graphClient.Subscriptions().BySubscriptionId("subscription-id").Delete(context.Background(), nil)

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

graphClient.subscriptions().bySubscriptionId("{subscription-id}").delete();

const options = {
	authProvider,
};

const client = Client.init(options);

await client.api('/subscriptions/7f105c7d-2dc5-4530-97cd-4e7ae6534c07')
	.version('beta')
	.delete();

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


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


$graphServiceClient->subscriptions()->bySubscriptionId('subscription-id')->delete()->wait();

Import-Module Microsoft.Graph.Beta.ChangeNotifications

Remove-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

await graph_client.subscriptions.by_subscription_id('subscription-id').delete()

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content