Actualizar suscripción

Espacio de nombres: microsoft.graph

Renueva una suscripción ampliando su tiempo de expiración.

En la tabla de la sección Permisos se enumeran los recursos que admiten la suscripción a notificaciones de cambios.

Las suscripciones expiran después de un período de tiempo que varía según el tipo de recurso. Para evitar que falten las notificaciones de cambio, una aplicación debe renovar sus suscripciones con suficiente antelación a su fecha de caducidad. Consulte suscripción para conocer la duración máxima de una suscripción para cada tipo de recurso.

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.

chatMessage

Se puede especificar que las suscripciones a chatMessage incluyan 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 encryptionCertificate para dichas suscripciones.

Use el encabezado de Prefer: include-unknown-enum-members solicitud para obtener los siguientes valores en chatMessagemessageTypeevolvable enum: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 encryptionCertificate 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 encryptionCertificate 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 notifyOnUserSpecificProperties durante true 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 Obtener notificaciones de cambios para chats con Microsoft Graph.

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.

driveItem

Se aplican más limitaciones a las suscripciones de 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. Se envían notificaciones de cambios para los cambios solicitados en la carpeta suscrita o en cualquier archivo, carpeta u otras instancias de driveItem en su jerarquía. No puede suscribirse a instancias de unidad o elemento de unidad que no sean carpetas, como archivos individuales.

contactos, eventos y mensajes

Puede suscribirse a los cambios en los recursos de contactos, eventos o mensajes de Outlook y, opcionalmente, especificar en la carga de solicitud POST si se incluirán 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 del 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 para cambiar las notificaciones de los elementos de las carpetas compartidas o delegadas.

onlineMeetings, presence

Las suscripciones de presencia y reuniones en línea 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 se desean datos de recursos en las notificaciones. Para más información, vea:

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

virtualEventWebinar

Las suscripciones a eventos virtuales solo admiten notificaciones básicas y se limitan a unas pocas entidades de un evento virtual. Para obtener más información sobre los tipos de suscripción admitidos, consulte Obtener notificaciones de cambios para las actualizaciones de eventos virtuales de Microsoft Teams.

Solicitud HTTP

PATCH /subscriptions/{id}

Encabezados de solicitud

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione solo los valores de las propiedades que se van a actualizar. Las propiedades existentes que no están incluidas en el cuerpo de la solicitud mantienen sus valores anteriores o se recalculan en función de los cambios realizados en otros valores de propiedad.

En la tabla siguiente se especifican las propiedades que se pueden actualizar.

El cuerpo de la solicitud debe contener la expirationDateTime propiedad or notificationUrl y su valor.

Respuesta

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

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.

PATCH https://graph.microsoft.com/beta/subscriptions/{id}
Content-type: application/json

{
   "expirationDateTime":"2016-11-22T18:23:45.9356913Z"
}

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

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new Subscription
{
	ExpirationDateTime = DateTimeOffset.Parse("2016-11-22T18:23:45.9356913Z"),
};

// 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}"].PatchAsync(requestBody);

// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  "time"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewSubscription()
expirationDateTime , err := time.Parse(time.RFC3339, "2016-11-22T18:23:45.9356913Z")
requestBody.SetExpirationDateTime(&expirationDateTime) 

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

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

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

Subscription subscription = new Subscription();
OffsetDateTime expirationDateTime = OffsetDateTime.parse("2016-11-22T18:23:45.9356913Z");
subscription.setExpirationDateTime(expirationDateTime);
Subscription result = graphClient.subscriptions().bySubscriptionId("{subscription-id}").patch(subscription);

const options = {
	authProvider,
};

const client = Client.init(options);

const subscription = {
   expirationDateTime: '2016-11-22T18:23:45.9356913Z'
};

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

<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\Subscription;


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

$requestBody = new Subscription();
$requestBody->setExpirationDateTime(new \DateTime('2016-11-22T18:23:45.9356913Z'));

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

Import-Module Microsoft.Graph.Beta.ChangeNotifications

$params = @{
	expirationDateTime = [System.DateTime]::Parse("2016-11-22T18:23:45.9356913Z")
}

Update-MgBetaSubscription -SubscriptionId $subscriptionId -BodyParameter $params

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.subscription import Subscription
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = Subscription(
	expiration_date_time = "2016-11-22T18:23:45.9356913Z",
)

result = await graph_client.subscriptions.by_subscription_id('subscription-id').patch(request_body)

Respuesta

En el ejemplo siguiente se muestra la respuesta.

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

{
  "id":"7f105c7d-2dc5-4530-97cd-4e7ae6534c07",
  "resource":"me/messages",
  "applicationId": "24d3b144-21ae-4080-943f-7067b395b913",
  "changeType":"created,updated",
  "clientState":"secretClientValue",
  "notificationUrl":"https://webhook.azurewebsites.net/api/send/myNotifyClient",
  "lifecycleNotificationUrl":"https://webhook.azurewebsites.net/api/send/lifecycleNotifications",
  "expirationDateTime":"2016-11-22T18:23:45.9356913Z",
  "creatorId": "8ee44408-0679-472c-bc2a-692812af3437",
  "latestSupportedTlsVersion": "v1_2",
  "encryptionCertificate": "",
  "encryptionCertificateId": "",
  "includeResourceData": false,
  "notificationContentType": "application/json"
}