NotificationSubscription interface

Pacote:

azure-devops-extension-api

Uma assinatura define critérios para eventos correspondentes e como o assinante da assinatura deve ser notificado sobre esses eventos.

Propriedades

adminSettings	Configurações gerenciadas pelo administrador para a assinatura. Aplica-se apenas quando o subscritor é um grupo.
channel	Canal para entrega de notificações acionadas pela assinatura.
description	Descrição da assinatura. Normalmente descreve critérios de filtro que ajudam a identificar a assinatura.
diagnostics	Diagnóstico para esta assinatura.
extendedProperties	Quaisquer propriedades extras, como descrição detalhada para diferentes contextos, contextos de usuário/grupo
filter	Critérios de correspondência para a subscrição. ExpressionFilter
flags	Indicadores somente leitura que descrevem melhor a assinatura.
id	Identificador de subscrição.
lastModifiedBy	Usuário que modificou (ou criou) a assinatura pela última vez.
modifiedDate	Data em que a subscrição foi modificada pela última vez. Se a assinatura não tiver sido atualizada desde que foi criada, esse valor indicará quando a assinatura foi criada.
permissions	As permissões que o usuário tem para essas assinaturas.
scope	O contêiner no qual os eventos devem ser publicados para serem correspondidos pela assinatura. Se estiver vazio, o escopo será o host atual (normalmente uma conta ou coleção de projetos). Por exemplo, uma assinatura com escopo para o projeto A não produzirá notificações para eventos publicados a partir do projeto B.
status	Estado da subscrição. Normalmente, indica se a assinatura está habilitada ou não.
statusMessage	Mensagem que fornece mais detalhes sobre o status da assinatura.
subscriber	Usuário ou grupo que receberá notificações de eventos correspondentes aos critérios de filtro da assinatura.
url	REST API URL da assinatura.
userSettings	Configurações gerenciadas pelo usuário para a assinatura. Aplica-se apenas quando o subscritor é um grupo. Normalmente usado para indicar se o usuário chamador está aceitando ou não uma assinatura de grupo.

Detalhes de Propriedade

adminSettings

Configurações gerenciadas pelo administrador para a assinatura. Aplica-se apenas quando o subscritor é um grupo.

adminSettings: SubscriptionAdminSettings

Valor de Propriedade

SubscriptionAdminSettings

channel

Canal para entrega de notificações acionadas pela assinatura.

channel: ISubscriptionChannel

Valor de Propriedade

ISubscriptionChannel

description

Descrição da assinatura. Normalmente descreve critérios de filtro que ajudam a identificar a assinatura.

description: string

Valor de Propriedade

string

diagnostics

Diagnóstico para esta assinatura.

diagnostics: SubscriptionDiagnostics

Valor de Propriedade

SubscriptionDiagnostics

extendedProperties

Quaisquer propriedades extras, como descrição detalhada para diferentes contextos, contextos de usuário/grupo

extendedProperties: {[key: string]: string}

Valor de Propriedade

{[key: string]: string}

filter

Critérios de correspondência para a subscrição. ExpressionFilter

filter: ISubscriptionFilter

Valor de Propriedade

ISubscriptionFilter

flags

Indicadores somente leitura que descrevem melhor a assinatura.

flags: SubscriptionFlags

Valor de Propriedade

SubscriptionFlags

id

Identificador de subscrição.

id: string

Valor de Propriedade

string

lastModifiedBy

Usuário que modificou (ou criou) a assinatura pela última vez.

lastModifiedBy: IdentityRef

Valor de Propriedade

IdentityRef

modifiedDate

Data em que a subscrição foi modificada pela última vez. Se a assinatura não tiver sido atualizada desde que foi criada, esse valor indicará quando a assinatura foi criada.

modifiedDate: Date

Valor de Propriedade

Date

permissions

As permissões que o usuário tem para essas assinaturas.

permissions: SubscriptionPermissions

Valor de Propriedade

SubscriptionPermissions

scope

O contêiner no qual os eventos devem ser publicados para serem correspondidos pela assinatura. Se estiver vazio, o escopo será o host atual (normalmente uma conta ou coleção de projetos). Por exemplo, uma assinatura com escopo para o projeto A não produzirá notificações para eventos publicados a partir do projeto B.

scope: SubscriptionScope

Valor de Propriedade

SubscriptionScope

status

Estado da subscrição. Normalmente, indica se a assinatura está habilitada ou não.

status: SubscriptionStatus

Valor de Propriedade

SubscriptionStatus

statusMessage

Mensagem que fornece mais detalhes sobre o status da assinatura.

statusMessage: string

Valor de Propriedade

string

subscriber

Usuário ou grupo que receberá notificações de eventos correspondentes aos critérios de filtro da assinatura.

subscriber: IdentityRef

Valor de Propriedade

IdentityRef

url

REST API URL da assinatura.

url: string

Valor de Propriedade

string

userSettings

Configurações gerenciadas pelo usuário para a assinatura. Aplica-se apenas quando o subscritor é um grupo. Normalmente usado para indicar se o usuário chamador está aceitando ou não uma assinatura de grupo.

userSettings: SubscriptionUserSettings

Valor de Propriedade

SubscriptionUserSettings