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	Administração configurações gerenciadas para a assinatura. Aplica-se somente quando o assinante é um grupo.
channel	Canal para entregar notificações disparadas 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 contextos diferentes, contextos de usuário/grupo
filter	Critérios correspondentes para a assinatura. ExpressionFilter
flags	Indicadores somente leitura que descrevem ainda mais a assinatura.
id	Identificador de assinatura.
lastModifiedBy	Usuário que modificou (ou criou) a assinatura pela última vez.
modifiedDate	Data em que a assinatura 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 do projeto B.
status	Status da assinatura. 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 que correspondam aos critérios de filtro da assinatura.
url	URL da API REST da assinatura.
userSettings	Configurações gerenciadas pelo usuário para a assinatura. Aplica-se somente quando o assinante é um grupo. Normalmente usado para indicar se o usuário que está chamando é optado por entrar ou sair de uma assinatura de grupo.

Detalhes da propriedade

adminSettings

Administração configurações gerenciadas para a assinatura. Aplica-se somente quando o assinante é um grupo.

adminSettings: SubscriptionAdminSettings

Valor da propriedade

SubscriptionAdminSettings

channel

Canal para entregar notificações disparadas pela assinatura.

channel: ISubscriptionChannel

Valor da propriedade

ISubscriptionChannel

description

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

description: string

Valor da propriedade

string

diagnostics

Diagnóstico para esta assinatura.

diagnostics: SubscriptionDiagnostics

Valor da propriedade

SubscriptionDiagnostics

extendedProperties

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

extendedProperties: {[key: string]: string}

Valor da propriedade

{[key: string]: string}

filter

Critérios correspondentes para a assinatura. ExpressionFilter

filter: ISubscriptionFilter

Valor da propriedade

ISubscriptionFilter

flags

Indicadores somente leitura que descrevem ainda mais a assinatura.

flags: SubscriptionFlags

Valor da propriedade

SubscriptionFlags

id

Identificador de assinatura.

id: string

Valor da propriedade

string

lastModifiedBy

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

lastModifiedBy: IdentityRef

Valor da propriedade

IdentityRef

modifiedDate

Data em que a assinatura 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 da propriedade

Date

permissions

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

permissions: SubscriptionPermissions

Valor da 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 do projeto B.

scope: SubscriptionScope

Valor da propriedade

SubscriptionScope

status

Status da assinatura. Normalmente indica se a assinatura está habilitada ou não.

status: SubscriptionStatus

Valor da propriedade

SubscriptionStatus

statusMessage

Mensagem que fornece mais detalhes sobre o status da assinatura.

statusMessage: string

Valor da propriedade

string

subscriber

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

subscriber: IdentityRef

Valor da propriedade

IdentityRef

url

URL da API REST da assinatura.

url: string

Valor da propriedade

string

userSettings

Configurações gerenciadas pelo usuário para a assinatura. Aplica-se somente quando o assinante é um grupo. Normalmente usado para indicar se o usuário que está chamando é optado por entrar ou sair de uma assinatura de grupo.

userSettings: SubscriptionUserSettings

Valor da propriedade

SubscriptionUserSettings