Partilhar via

Subscriptions - Create Subscriptions Query

  • Referência
Serviço:
Service Hooks
Versão da API:
7.1

Consultar assinaturas de gancho de serviço.

POST https://dev.azure.com/{organization}/_apis/hooks/subscriptionsquery?api-version=7.1

Parâmetros de URI

Nome Em Obrigatório Tipo Description
organization
 path True

string

O nome da organização do Azure DevOps.
api-version
 query True

string

Versão da API a ser usada. Isso deve ser definido como '7.1' para usar essa versão da api.

Corpo da solicitação

Nome Tipo Description
consumerActionId

string

ID de ação opcional do consumidor para restringir os resultados (nulo para qualquer)
consumerId

string

ID do consumidor opcional para restringir os resultados (nulo para qualquer)
consumerInputFilters

InputFilter[]

Filtrar entradas do consumidor de assinatura
eventType

string

ID do tipo de evento opcional para restringir os resultados (nulo para qualquer)
publisherId

string

ID opcional do editor para restringir os resultados (nulo para qualquer)
publisherInputFilters

InputFilter[]

Filtrar entradas do editor de assinatura
results

Subscription[]

Resultados da consulta
subscriberId

string (uuid)

Filtro de assinante opcional.

Respostas

Nome Tipo Description
200 OK

SubscriptionsQuery

operação bem-sucedida

Segurança

oauth2

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL do Token: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Escopos

Nome Description
vso.work Concede a capacidade de ler itens de trabalho, consultas, placas, caminhos de área e iterações e outros metadados relacionados ao acompanhamento de itens de trabalho. Também concede a capacidade de executar consultas, pesquisar itens de trabalho e receber notificações sobre eventos de item de trabalho por meio de ganchos de serviço.
vso.build Concede a capacidade de acessar artefatos de build, incluindo resultados de build, definições e solicitações e a capacidade de receber notificações sobre eventos de build por meio de ganchos de serviço.
vso.code Concede a capacidade de ler o código-fonte e metadados sobre commits, conjuntos de alterações, branches e outros artefatos de controle de versão. Também concede a capacidade de pesquisar código e ser notificado sobre eventos de controle de versão por meio de ganchos de serviço.

Definições

Nome Description
IdentityRef
InputFilter

Define um filtro para entradas de assinatura. O filtro corresponderá a um conjunto de entradas se algum (um ou mais) dos grupos for avaliado como true.
InputFilterCondition

Uma expressão que pode ser aplicada para filtrar uma lista de entradas de assinatura
InputFilterOperator

O operador aplicado entre o valor de entrada esperado e real
ReferenceLinks

A classe para representar uma coleção de links de referência REST.
Subscription

Encapsula uma assinatura de evento.
SubscriptionsQuery

Define uma consulta para assinaturas de gancho de serviço.
SubscriptionStatus

IdentityRef

Objeto
Nome Tipo Description
_links

ReferenceLinks

Este campo contém zero ou mais links interessantes sobre o assunto do grafo. Esses links podem ser invocados para obter relações adicionais ou informações mais detalhadas sobre esse assunto do grafo.
descriptor

string

O descritor é a principal maneira de referenciar o assunto do grafo enquanto o sistema está em execução. Esse campo identificará exclusivamente o mesmo assunto de grafo em contas e organizações.
directoryAlias

string

Preterido – pode ser recuperado consultando o usuário do Graph referenciado na entrada "self" do dicionário "_links" identityRef
displayName

string

Esse é o nome de exibição não exclusivo do assunto do grafo. Para alterar esse campo, você deve alterar seu valor no provedor de origem.
id

string

imageUrl

string

Preterido – Disponível na entrada "avatar" do dicionário "_links" do IdentityRef
inactive

boolean

Preterido – pode ser recuperado consultando o estado de associação do Graph referenciado na entrada "membershipState" do dicionário "_links" do GraphUser
isAadIdentity

boolean

Preterido – pode ser adiado do tipo de assunto do descritor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Preterido – pode ser inferido do tipo de assunto do descritor (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

Preterido - não em uso na maioria das implementações pré-existentes de ToIdentityRef
uniqueName

string

Preterido – use Domain+PrincipalName em vez disso
url

string

Essa URL é a rota completa para o recurso de origem desta entidade de grafo.

InputFilter

Objeto

Define um filtro para entradas de assinatura. O filtro corresponderá a um conjunto de entradas se algum (um ou mais) dos grupos for avaliado como true.

Nome Tipo Description
conditions

InputFilterCondition[]

Grupos de expressões de filtro de entrada. Esse filtro corresponderá a um conjunto de entradas se algum (um ou mais) dos grupos for avaliado como true.

InputFilterCondition

Objeto

Uma expressão que pode ser aplicada para filtrar uma lista de entradas de assinatura

Nome Tipo Description
caseSensitive

boolean

Se uma correspondência diferencia maiúsculas de minúsculas ou não
inputId

string

A ID da entrada na qual filtrar
inputValue

string

O valor de entrada "esperado" a ser comparado com o valor de entrada real
operator

InputFilterOperator

O operador aplicado entre o valor de entrada esperado e real

InputFilterOperator

Enumeração

O operador aplicado entre o valor de entrada esperado e real

Valor Description
equals
notEquals
Objeto

A classe para representar uma coleção de links de referência REST.

Nome Tipo Description
links

object

A exibição somente leitura dos links. Como os links de referência são somente leitura, só queremos expô-los como somente leitura.

Subscription

Objeto

Encapsula uma assinatura de evento.

Nome Tipo Description
_links

ReferenceLinks

Links de referência
actionDescription

string

consumerActionId

string

consumerId

string

consumerInputs

object

Valores de entrada do consumidor
createdBy

IdentityRef

createdDate

string (date-time)

eventDescription

string

eventType

string

id

string (uuid)

lastProbationRetryDate

string (date-time)

modifiedBy

IdentityRef

modifiedDate

string (date-time)

probationRetries

string (byte)

publisherId

string

publisherInputs

object

Valores de entrada do publicador
resourceVersion

string

status

SubscriptionStatus

subscriber

IdentityRef

url

string

SubscriptionsQuery

Objeto

Define uma consulta para assinaturas de gancho de serviço.

Nome Tipo Description
consumerActionId

string

ID de ação opcional do consumidor para restringir os resultados (nulo para qualquer)
consumerId

string

ID do consumidor opcional para restringir os resultados (nulo para qualquer)
consumerInputFilters

InputFilter[]

Filtrar entradas do consumidor de assinatura
eventType

string

ID do tipo de evento opcional para restringir os resultados (nulo para qualquer)
publisherId

string

ID opcional do editor para restringir os resultados (nulo para qualquer)
publisherInputFilters

InputFilter[]

Filtrar entradas do editor de assinatura
results

Subscription[]

Resultados da consulta
subscriberId

string (uuid)

Filtro de assinante opcional.

SubscriptionStatus

Enumeração
Valor Description
disabledByInactiveIdentity

A assinatura está desabilitada porque o proprietário está inativo ou não tem permissões.
disabledBySystem

A assinatura é desabilitada pelo sistema.
disabledByUser

A assinatura é desabilitada por um usuário.
enabled

A assinatura está habilitada.
onProbation

A assinatura está temporariamente em liberdade condicional pelo sistema.