NotificationSubscriptionUpdateParameters interface

Paquete:

azure-devops-extension-api

Parámetros para actualizar una suscripción existente. Una suscripción define criterios para los eventos coincidentes y cómo se debe notificar al suscriptor de la suscripción sobre esos eventos. Nota: solo se deben establecer los campos que se van a actualizar.

Propiedades

adminSettings	Configuración administrada por el administrador de la suscripción. Solo se aplica a las suscripciones en las que el suscriptor es un grupo.
channel	Canal para entregar notificaciones desencadenadas por la suscripción.
description	Descripción actualizada de la suscripción. Normalmente se describen los criterios de filtro que ayudan a identificar la suscripción.
filter	Criterios de coincidencia para la suscripción. ExpressionFilter
scope	Contenedor en el que se deben publicar eventos para que coincidan con la nueva suscripción. Si no se especifica, el valor predeterminado es el host actual (normalmente la cuenta actual o la colección de proyectos). Por ejemplo, una suscripción cuyo ámbito es el proyecto A no generará notificaciones para eventos publicados desde el proyecto B.
status	Estado actualizado de la suscripción. Normalmente se usa para habilitar o deshabilitar una suscripción.
statusMessage	Mensaje opcional que proporciona más detalles sobre el estado actualizado.
userSettings	Configuración administrada por el usuario para la suscripción. Solo se aplica a las suscripciones en las que el suscriptor es un grupo. Normalmente se usa para participar o excluir a un usuario de una suscripción de grupo.

Detalles de las propiedades

adminSettings

Configuración administrada por el administrador de la suscripción. Solo se aplica a las suscripciones en las que el suscriptor es un grupo.

adminSettings: SubscriptionAdminSettings

Valor de propiedad

SubscriptionAdminSettings

channel

Canal para entregar notificaciones desencadenadas por la suscripción.

channel: ISubscriptionChannel

Valor de propiedad

ISubscriptionChannel

description

Descripción actualizada de la suscripción. Normalmente se describen los criterios de filtro que ayudan a identificar la suscripción.

description: string

Valor de propiedad

string

filter

Criterios de coincidencia para la suscripción. ExpressionFilter

filter: ISubscriptionFilter

Valor de propiedad

ISubscriptionFilter

scope

Contenedor en el que se deben publicar eventos para que coincidan con la nueva suscripción. Si no se especifica, el valor predeterminado es el host actual (normalmente la cuenta actual o la colección de proyectos). Por ejemplo, una suscripción cuyo ámbito es el proyecto A no generará notificaciones para eventos publicados desde el proyecto B.

scope: SubscriptionScope

Valor de propiedad

SubscriptionScope

status

Estado actualizado de la suscripción. Normalmente se usa para habilitar o deshabilitar una suscripción.

status: SubscriptionStatus

Valor de propiedad

SubscriptionStatus

statusMessage

Mensaje opcional que proporciona más detalles sobre el estado actualizado.

statusMessage: string

Valor de propiedad

string

userSettings

Configuración administrada por el usuario para la suscripción. Solo se aplica a las suscripciones en las que el suscriptor es un grupo. Normalmente se usa para participar o excluir a un usuario de una suscripción de grupo.

userSettings: SubscriptionUserSettings

Valor de propiedad

SubscriptionUserSettings