Subscriptions - Create Subscriptions Query
Consulta de suscripciones de enlace de servicio.
POST https://dev.azure.com/{organization}/_apis/hooks/subscriptionsquery?api-version=7.1-preview.1
Parámetros de identificador URI
Nombre | En | Requerido | Tipo | Description |
---|---|---|---|---|
organization
|
path | True |
string |
El nombre de la organización de Azure DevOps. |
api-version
|
query | True |
string |
Versión de la API que se va a usar. Debe establecerse en "7.1-preview.1" para usar esta versión de la API. |
Cuerpo de la solicitud
Nombre | Tipo | Description |
---|---|---|
consumerActionId |
string |
Identificador de acción de consumidor opcional para restringir los resultados a (null para cualquiera) |
consumerId |
string |
Identificador de consumidor opcional para restringir los resultados a (null para cualquiera) |
consumerInputFilters |
Filtrar las entradas de consumidor de la suscripción |
|
eventType |
string |
Identificador de tipo de evento opcional para restringir los resultados a (null para cualquiera) |
publisherId |
string |
Identificador de publicador opcional para restringir los resultados a (null para cualquiera) |
publisherInputFilters |
Filtrar las entradas del publicador de suscripciones |
|
results |
Resultados de la consulta |
|
subscriberId |
string |
Filtro de suscriptor opcional. |
Respuestas
Nombre | Tipo | Description |
---|---|---|
200 OK |
operación correcta |
Seguridad
oauth2
Type:
oauth2
Flow:
accessCode
Authorization URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL:
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
Scopes
Nombre | Description |
---|---|
vso.work | Concede la capacidad de leer elementos de trabajo, consultas, paneles, rutas de acceso de área e iteraciones, y otros metadatos relacionados con el seguimiento de elementos de trabajo. También concede la capacidad de ejecutar consultas, buscar elementos de trabajo y recibir notificaciones sobre eventos de elementos de trabajo a través de enlaces de servicio. |
vso.build | Concede la capacidad de acceder a los artefactos de compilación, incluidos los resultados de compilación, las definiciones y las solicitudes, y la capacidad de recibir notificaciones sobre eventos de compilación a través de enlaces de servicio. |
vso.code | Concede la capacidad de leer código fuente y metadatos sobre confirmaciones, conjuntos de cambios, ramas y otros artefactos de control de versiones. También concede la capacidad de buscar código y recibir notificaciones sobre eventos de control de versiones a través de enlaces de servicio. |
Definiciones
Nombre | Description |
---|---|
Identity |
|
Input |
Define un filtro para las entradas de suscripción. El filtro coincide con un conjunto de entradas si alguno (uno o varios) de los grupos se evalúa como true. |
Input |
Expresión que se puede aplicar para filtrar una lista de entradas de suscripción |
Input |
Operador aplicado entre el valor de entrada esperado y real. |
Reference |
Clase que se va a representar una colección de vínculos de referencia de REST. |
Subscription |
Encapsula una suscripción de eventos. |
Subscriptions |
Define una consulta para las suscripciones de enlace de servicio. |
Subscription |
IdentityRef
Nombre | Tipo | Description |
---|---|---|
_links |
Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo. |
|
descriptor |
string |
El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones. |
directoryAlias |
string |
En desuso: se puede recuperar consultando al usuario de Graph al que se hace referencia en la entrada "self" del diccionario identityRef "_links". |
displayName |
string |
Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen. |
id |
string |
|
imageUrl |
string |
En desuso: disponible en la entrada "avatar" del diccionario "_links" de IdentityRef |
inactive |
boolean |
En desuso: se puede recuperar consultando el estado de pertenencia de Graph al que se hace referencia en la entrada "membershipState" del diccionario GraphUser "_links". |
isAadIdentity |
boolean |
En desuso: se puede deducir del tipo de asunto del descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType) |
isContainer |
boolean |
En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsGroupType) |
isDeletedInOrigin |
boolean |
|
profileUrl |
string |
En desuso: no en uso en la mayoría de las implementaciones preexistentes de ToIdentityRef |
uniqueName |
string |
En desuso: use Domain+PrincipalName en su lugar. |
url |
string |
Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo. |
InputFilter
Define un filtro para las entradas de suscripción. El filtro coincide con un conjunto de entradas si alguno (uno o varios) de los grupos se evalúa como true.
Nombre | Tipo | Description |
---|---|---|
conditions |
Grupos de expresiones de filtro de entrada. Este filtro coincide con un conjunto de entradas si alguno (uno o varios) de los grupos se evalúa como true. |
InputFilterCondition
Expresión que se puede aplicar para filtrar una lista de entradas de suscripción
Nombre | Tipo | Description |
---|---|---|
caseSensitive |
boolean |
Si se debe hacer o no una coincidencia con distinción entre mayúsculas y minúsculas |
inputId |
string |
Identificador de la entrada en la que se va a filtrar |
inputValue |
string |
Valor de entrada "esperado" que se va a comparar con el valor de entrada real |
operator |
Operador aplicado entre el valor de entrada esperado y real. |
InputFilterOperator
Operador aplicado entre el valor de entrada esperado y real.
Nombre | Tipo | Description |
---|---|---|
equals |
string |
|
notEquals |
string |
ReferenceLinks
Clase que se va a representar una colección de vínculos de referencia de REST.
Nombre | Tipo | Description |
---|---|---|
links |
object |
Vista de lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura. |
Subscription
Encapsula una suscripción de eventos.
Nombre | Tipo | Description |
---|---|---|
_links |
Vínculos de referencia |
|
actionDescription |
string |
|
consumerActionId |
string |
|
consumerId |
string |
|
consumerInputs |
object |
Valores de entrada del consumidor |
createdBy | ||
createdDate |
string |
|
eventDescription |
string |
|
eventType |
string |
|
id |
string |
|
lastProbationRetryDate |
string |
|
modifiedBy | ||
modifiedDate |
string |
|
probationRetries |
string |
|
publisherId |
string |
|
publisherInputs |
object |
Valores de entrada del publicador |
resourceVersion |
string |
|
status | ||
subscriber | ||
url |
string |
SubscriptionsQuery
Define una consulta para las suscripciones de enlace de servicio.
Nombre | Tipo | Description |
---|---|---|
consumerActionId |
string |
Identificador de acción de consumidor opcional para restringir los resultados a (null para cualquiera) |
consumerId |
string |
Identificador de consumidor opcional para restringir los resultados a (null para cualquiera) |
consumerInputFilters |
Filtrar las entradas de consumidor de la suscripción |
|
eventType |
string |
Identificador de tipo de evento opcional para restringir los resultados a (null para cualquiera) |
publisherId |
string |
Identificador de publicador opcional para restringir los resultados a (null para cualquiera) |
publisherInputFilters |
Filtrar las entradas del publicador de suscripciones |
|
results |
Resultados de la consulta |
|
subscriberId |
string |
Filtro de suscriptor opcional. |
SubscriptionStatus
Nombre | Tipo | Description |
---|---|---|
disabledByInactiveIdentity |
string |
La suscripción está deshabilitada porque el propietario está inactivo o faltan permisos. |
disabledBySystem |
string |
El sistema deshabilita la suscripción. |
disabledByUser |
string |
Un usuario deshabilita la suscripción. |
enabled |
string |
La suscripción está habilitada. |
onProbation |
string |
La suscripción está temporalmente en libertad condicional por el sistema. |