NotificationSubscription interface

Paquete:

azure-devops-extension-api

Una suscripción define criterios para buscar coincidencias de eventos y cómo se debe notificar al suscriptor de la suscripción sobre esos eventos.

Propiedades

adminSettings	Administración configuración administrada para la suscripción. Solo se aplica cuando el suscriptor es un grupo.
channel	Canal para entregar notificaciones desencadenadas por la suscripción.
description	Descripción de la suscripción. Normalmente se describen los criterios de filtro que ayudan a identificar la suscripción.
diagnostics	Diagnósticos para esta suscripción.
extendedProperties	Cualquier propiedad adicional, como la descripción detallada de diferentes contextos, contextos de usuario o grupo
filter	Criterios de coincidencia para la suscripción. ExpressionFilter
flags	Indicadores de solo lectura que describen aún más la suscripción.
id	Identificador de suscripción.
lastModifiedBy	Usuario que modificó por última vez (o creó) la suscripción.
modifiedDate	Fecha en la que se modificó por última vez la suscripción. Si la suscripción no se ha actualizado desde que se creó, este valor indicará cuándo se creó la suscripción.
permissions	Los permisos que tiene el usuario para estas suscripciones.
scope	Contenedor en el que se deben publicar los eventos a partir de para que la suscripción coincida. Si está vacío, el ámbito es el host actual (normalmente una cuenta o colección de proyectos). Por ejemplo, una suscripción cuyo ámbito sea el proyecto A no generará notificaciones para los eventos publicados desde el proyecto B.
status	Estado de la suscripción. Normalmente indica si la suscripción está habilitada o no.
statusMessage	Mensaje que proporciona más detalles sobre el estado de la suscripción.
subscriber	Usuario o grupo que recibirá notificaciones de eventos que coincidan con los criterios de filtro de la suscripción.
url	Dirección URL de la API REST de la suscripción.
userSettings	Configuración administrada por el usuario para la suscripción. Solo se aplica cuando el suscriptor es un grupo. Normalmente se usa para indicar si el usuario que realiza la llamada participa o no de una suscripción de grupo.

Detalles de las propiedades

adminSettings

Administración configuración administrada para la suscripción. Solo se aplica cuando 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 de la suscripción. Normalmente se describen los criterios de filtro que ayudan a identificar la suscripción.

description: string

Valor de propiedad

string

diagnostics

Diagnósticos para esta suscripción.

diagnostics: SubscriptionDiagnostics

Valor de propiedad

SubscriptionDiagnostics

extendedProperties

Cualquier propiedad adicional, como la descripción detallada de diferentes contextos, contextos de usuario o grupo

extendedProperties: {[key: string]: string}

Valor de propiedad

{[key: string]: string}

filter

Criterios de coincidencia para la suscripción. ExpressionFilter

filter: ISubscriptionFilter

Valor de propiedad

ISubscriptionFilter

flags

Indicadores de solo lectura que describen aún más la suscripción.

flags: SubscriptionFlags

Valor de propiedad

SubscriptionFlags

id

Identificador de suscripción.

id: string

Valor de propiedad

string

lastModifiedBy

Usuario que modificó por última vez (o creó) la suscripción.

lastModifiedBy: IdentityRef

Valor de propiedad

IdentityRef

modifiedDate

Fecha en la que se modificó por última vez la suscripción. Si la suscripción no se ha actualizado desde que se creó, este valor indicará cuándo se creó la suscripción.

modifiedDate: Date

Valor de propiedad

Date

permissions

Los permisos que tiene el usuario para estas suscripciones.

permissions: SubscriptionPermissions

Valor de propiedad

SubscriptionPermissions

scope

Contenedor en el que se deben publicar los eventos a partir de para que la suscripción coincida. Si está vacío, el ámbito es el host actual (normalmente una cuenta o colección de proyectos). Por ejemplo, una suscripción cuyo ámbito sea el proyecto A no generará notificaciones para los eventos publicados desde el proyecto B.

scope: SubscriptionScope

Valor de propiedad

SubscriptionScope

status

Estado de la suscripción. Normalmente indica si la suscripción está habilitada o no.

status: SubscriptionStatus

Valor de propiedad

SubscriptionStatus

statusMessage

Mensaje que proporciona más detalles sobre el estado de la suscripción.

statusMessage: string

Valor de propiedad

string

subscriber

Usuario o grupo que recibirá notificaciones de eventos que coincidan con los criterios de filtro de la suscripción.

subscriber: IdentityRef

Valor de propiedad

IdentityRef

url

Dirección URL de la API REST de la suscripción.

url: string

Valor de propiedad

string

userSettings

Configuración administrada por el usuario para la suscripción. Solo se aplica cuando el suscriptor es un grupo. Normalmente se usa para indicar si el usuario que realiza la llamada participa o no de una suscripción de grupo.

userSettings: SubscriptionUserSettings

Valor de propiedad

SubscriptionUserSettings