Tipo de recurso subscription

Espacio de nombres: microsoft.graph

Una suscripción permite que una aplicación cliente reciba notificaciones de cambios sobre cambios en los datos en Microsoft Graph.

Para obtener más información sobre las suscripciones y las notificaciones de cambio, incluidos los recursos que admiten notificaciones de cambio, consulte Configuración de notificaciones para cambios en los datos de recursos.

Métodos

Método	Tipo de valor devuelto	Descripción
Crear suscripción	subscripción	Suscripción a una aplicación de escucha para recibir notificaciones de cambio cuando cambian los datos de Microsoft Graph.
Actualizar suscripción	subscription	Renueva una suscripción al actualizar su tiempo de expiración.
Enumerar suscripciones	subscription	Enumera las suscripciones activas.
Obtener suscripción	subscription	Lee las propiedades y relaciones del objeto subscription.
Eliminar suscripción	Ninguno	Elimina un objeto subscription.
reautorizar	Ninguno	Vuelva a autorizar una suscripción cuando reciba un desafío reauthorizationRequired .

Propiedades

Propiedad	Tipo	Descripción
applicationId	Cadena	Opcional. Identificador de la aplicación usado para crear la suscripción. Solo lectura.
changeType	Cadena	Necesario. Indica el tipo de cambio en el recurso suscrito que generará una notificación de cambio. Los valores admitidos son: created, updated, deleted. Se pueden combinar varios valores mediante una lista separada por comas. Nota: Las notificaciones de cambio de lista y elemento raíz de unidad solo admitenupdated changeType. Los cambios de notificaciones de usuario y de grupo admiten updated y deleted changeType. Use updated para recibir notificaciones cuando el usuario o grupo se cree, actualice o elimine temporalmente. Use deleted para recibir notificaciones cuando el usuario o el grupo se eliminen permanentemente.
clientState	Cadena	Opcional. Especifica el valor de la propiedad clientState enviado por el servicio en cada notificación de cambio. Se permite una longitud máxima de 128 caracteres. El cliente puede comprobar que la notificación de cambio viene del servicio si compara el valor de la propiedad clientState enviado con la suscripción con el valor de la propiedad clientState recibido con cada notificación de cambio.
creatorId	Cadena	Opcional. Identificador de usuario o entidad de servicio que creó la suscripción. Si la aplicación usó permisos delegados para crear la suscripción, este campo contiene el identificador del usuario conectado en nombre del que la aplicación realizó la llamada. Si la aplicación usó permisos de aplicación, este campo contiene el identificador de la entidad de servicio correspondiente a la aplicación. Solo lectura.
encryptionCertificate	Cadena	Opcional. Representación codificada en Base64 de un certificado con una clave pública que se usa para cifrar los datos de los recursos en las notificaciones de cambios. Opcional pero necesario cuando includeResourceData estrue.
encryptionCertificateId	Cadena	Opcional. Un identificador personalizado proporcionado por la aplicación que le ayude a identificar el certificado necesario para descifrar los datos del recurso.
expirationDateTime	DateTimeOffset	Necesario. Especifica la fecha y hora en que expira la suscripción de webhook. La hora está en UTC y puede ser un periodo de tiempo desde la creación de la suscripción que varía para el recurso al que se está suscrito. Para obtener la duración máxima de la suscripción admitida, consulte la tabla siguiente.
id	Cadena	Opcional. Identificador único de la suscripción. Solo lectura.
includeResourceData	Booleano	Opcional. Cuando se establece en true, las notificaciones de cambios incluyen datos del recurso (como el contenido de un mensaje de chat).
latestSupportedTlsVersion	Cadena	Opcional. Especifica la versión más reciente de Seguridad de la capa de transporte (TLS) que es compatible con el punto de conexión de notificación, especificado por notificationUrl. Los valores posibles son: v1_0, v1_1, v1_2, v1_3. Para los suscriptores cuyo punto de conexión de notificación admite una versión inferior a la versión recomendada actualmente (TLS 1.2), especificar esta propiedad mediante una escala de tiempo establecida les permite usar temporalmente su versión en desuso de TLS antes de completar su actualización a TLS 1.2. Para estos suscriptores, no establecer esta propiedad por la escala de tiempo produciría un error en las operaciones de suscripción. Para los suscriptores cuyo punto de conexión de notificación ya admite TLS 1.2, establecer esta propiedad es opcional. En estos casos, Microsoft Graph establece de forma predeterminada la propiedad en v1_2.
lifecycleNotificationUrl	Cadena	Es necesario para los recursos de Teams si el expirationDateTime valor es de más de 1 hora a partir de ahora; opcional en caso contrario. Dirección URL del punto de conexión que recibe notificaciones de ciclo de vida, incluidas subscriptionRemovedlas notificaciones , reauthorizationRequiredy missed . Esta dirección URL debe usar el protocolo HTTPS. Para obtener más información, consulte Reducción de las suscripciones que faltan y notificaciones de cambio.
notificationQueryOptions	Cadena	Opcional. Opciones de consulta de OData para especificar un valor para el recurso de destino. Los clientes reciben notificaciones cuando el recurso llega al estado que coincide con las opciones de consulta proporcionadas aquí. Con esta nueva propiedad en la carga de creación de suscripción junto con todas las propiedades existentes, los webhooks entregarán notificaciones siempre que un recurso alcance el estado deseado mencionado en la propiedad notificationQueryOptions. Por ejemplo, cuando se completa el trabajo de impresión o cuando el valor de propiedad de un recurso de trabajo de impresión isFetchable se convierte en true etc. Solo se admite para el servicio de impresión universal. Para obtener más información, consulte Suscribirse para cambiar las notificaciones de las API de impresión en la nube mediante Microsoft Graph.
notificationUrl	Cadena	Necesario. La dirección URL del punto de conexión que recibirá las notificaciones de cambio. Esta dirección URL debe usar el protocolo HTTPS. Cualquier parámetro de cadena de consulta incluido en la propiedad notificationUrl se incluirá en la solicitud HTTP POST cuando Microsoft Graph envíe las notificaciones de cambio.
notificationUrlAppId	Cadena	Opcional. El identificador de aplicación que el servicio de suscripción puede usar para generar el token de validación. Esto permite al cliente validar la autenticidad de la notificación recibida.
resource	Cadena	Necesario. Especifica el recurso al que se le supervisarán los cambios. No incluya la dirección URL base (https://graph.microsoft.com/v1.0/). Vea los posibles valores de ruta de acceso para cada recurso compatible.

Duración máxima de la suscripción por tipo de recurso

Resource	Tiempo de expiración máximo
Alerta de seguridad	43 200 minutos (menos de 30 días)
callRecord de Teams	4.230 minutos (menos de 3 días)
Llamada de TeamsRegistro	4.320 minutos (3 días)
Llamada de TeamsTranscript	4.320 minutos (3 días)
Canal de Teams	4.320 minutos (3 días)
Chat de Teams	4.320 minutos (3 días)
chatmessage de Teams	4.320 minutos (3 días)
conversationMember de Teams	4.320 minutos (3 días)
onlineMeeting de Teams	4.320 minutos (3 días)
Equipo de Teams	4.320 minutos (3 días)
Conversación de grupo	4.230 minutos (menos de 3 días)
driveItem de OneDrive	42 300 minutos (menos de 30 días)
lista de SharePoint	42 300 minutos (menos de 30 días)
Mensaje, evento, contacto de Outlook	4.230 minutos (menos de 3 días)
usuario, grupo, otros recursos del directorio	41 760 minutos (menos de 29 días)
onlineMeeting	4.230 minutos (menos de 3 días)
presencia	60 minutos (1 hora)
Imprimir printer	4.230 minutos (menos de 3 días)
Imprimir printTaskDefinition	4.230 minutos (menos de 3 días)
todoTask	4.230 minutos (menos de 3 días) Los webhooks para este recurso solo están disponibles en el punto de conexión global y no en las nubes nacionales.
baseTask (en desuso)	4.230 minutos (menos de 3 días)

Nota: Las nuevas aplicaciones y las aplicaciones existentes no deben superar el valor admitido. En el futuro, se producirá un error en las solicitudes para crear o renovar una suscripción si se supera el valor máximo.

Relaciones

Ninguno

Representación JSON

Aquí tiene una representación JSON del recurso.

{
  "@odata.type": "#microsoft.graph.subscription",
  "id": "String (identifier)",
  "resource": "String",
  "changeType": "String",
  "clientState": "String",
  "notificationUrl": "String",
  "expirationDateTime": "String (timestamp)",
  "applicationId": "String",
  "creatorId": "String",
  "includeResourceData": "Boolean",
  "lifecycleNotificationUrl": "String",
  "encryptionCertificate": "String",
  "encryptionCertificateId": "String",
  "latestSupportedTlsVersion": "String",
  "notificationQueryOptions": "String",
  "notificationUrlAppId": "String"
}