Subscriptions - Create Subscriptions Query
查询服务挂钩订阅。
POST https://dev.azure.com/{organization}/_apis/hooks/subscriptionsquery?api-version=7.1URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 组织的名称。 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。 |
请求正文
| 名称 | 类型 | 说明 |
|---|---|---|
| consumerActionId |
string |
可选的使用者作 ID，用于将结果限制为 （任何结果为 null） |
| consumerId |
string |
可选的使用者 ID，用于将结果限制为 （任何结果为 null） |
| consumerInputFilters |
筛选订阅使用者输入 |
|
| eventType |
string |
可选事件类型 ID，用于将结果限制为 （任何结果为 null） |
| publisherId |
string |
可选的发布者 ID，用于将结果限制为 （任何结果为 null） |
| publisherInputFilters |
筛选订阅发布者输入 |
|
| results |
来自查询的结果 |
|
| subscriberId |
string (uuid) |
可选订阅服务器筛选器。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
成功作 |
安全性
oauth2
类型:
oauth2
流向:
accessCode
授权 URL:
https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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
作用域
| 名称 | 说明 |
|---|---|
| vso.work | 授予读取工作项、查询、版块、区域和迭代路径以及其他工作项跟踪相关元数据的能力。 此外，还授予执行查询、搜索工作项以及通过服务挂钩接收有关工作项事件的通知的能力。 |
| vso.build | 授予访问生成项目（包括生成结果、定义和请求）的能力，以及通过服务挂钩接收有关生成事件的通知的能力。 |
| vso.code | 授予读取有关提交、更改集、分支和其他版本控制项目的源代码和元数据的能力。 此外，还可以通过服务挂钩搜索代码并获取有关版本控制事件的通知。 |
定义
| 名称 | 说明 |
|---|---|
|
Identity |
|
|
Input |
定义订阅输入的筛选器。 如果组的任何（一个或多个）的计算结果为 true，则筛选器匹配一组输入。 |
|
Input |
可用于筛选订阅输入列表的表达式 |
|
Input |
在预期输入值和实际输入值之间应用的运算符 |
|
Reference |
表示 REST 引用链接集合的类。 |
| Subscription |
封装事件订阅。 |
|
Subscriptions |
定义服务挂钩订阅的查询。 |
|
Subscription |
IdentityRef
| 名称 | 类型 | 说明 |
|---|---|---|
| _links |
此字段包含有关图形主题的零个或多个有趣的链接。 可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。 |
|
| descriptor |
string |
描述符是在系统运行时引用图形主题的主要方法。 此字段将唯一标识帐户和组织中的同一图形主题。 |
| directoryAlias |
string |
已弃用 - 可以通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索 |
| displayName |
string |
这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。 |
| id |
string |
|
| imageUrl |
string |
已弃用 - 在 IdentityRef“_links”字典的“虚拟形象”条目中可用 |
| inactive |
boolean |
已弃用 - 可以通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索 |
| isAadIdentity |
boolean |
已弃用 - 可以从描述符的主题类型推断（Descriptor.IsAadUserType/Descriptor.IsAadGroupType） |
| isContainer |
boolean |
已弃用 - 可以从描述符的主题类型推断（描述符.IsGroupType） |
| isDeletedInOrigin |
boolean |
|
| profileUrl |
string |
已弃用 - 不在 ToIdentityRef 的大多数预先存在的实现中使用 |
| uniqueName |
string |
已弃用 - 请改用 Domain+PrincipalName |
| url |
string |
此 URL 是指向此图形主题的源资源的完整路由。 |
InputFilter
定义订阅输入的筛选器。 如果组的任何（一个或多个）的计算结果为 true，则筛选器匹配一组输入。
| 名称 | 类型 | 说明 |
|---|---|---|
| conditions |
输入筛选器表达式组。 如果组的任何（一个或多个）的计算结果为 true，则此筛选器匹配一组输入。 |
InputFilterCondition
可用于筛选订阅输入列表的表达式
| 名称 | 类型 | 说明 |
|---|---|---|
| caseSensitive |
boolean |
是否执行区分大小写的匹配 |
| inputId |
string |
要筛选的输入的 ID |
| inputValue |
string |
要与实际输入值进行比较的“预期”输入值 |
| operator |
在预期输入值和实际输入值之间应用的运算符 |
InputFilterOperator
在预期输入值和实际输入值之间应用的运算符
| 值 | 说明 |
|---|---|
| equals | |
| notEquals |
ReferenceLinks
表示 REST 引用链接集合的类。
| 名称 | 类型 | 说明 |
|---|---|---|
| links |
object |
链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。 |
Subscription
封装事件订阅。
| 名称 | 类型 | 说明 |
|---|---|---|
| _links |
参考链接 |
|
| actionDescription |
string |
|
| consumerActionId |
string |
|
| consumerId |
string |
|
| consumerInputs |
object |
使用者输入值 |
| createdBy | ||
| createdDate |
string (date-time) |
|
| eventDescription |
string |
|
| eventType |
string |
|
| id |
string (uuid) |
|
| lastProbationRetryDate |
string (date-time) |
|
| modifiedBy | ||
| modifiedDate |
string (date-time) |
|
| probationRetries |
string (byte) |
|
| publisherId |
string |
|
| publisherInputs |
object |
发布者输入值 |
| resourceVersion |
string |
|
| status | ||
| subscriber | ||
| url |
string |
SubscriptionsQuery
定义服务挂钩订阅的查询。
| 名称 | 类型 | 说明 |
|---|---|---|
| consumerActionId |
string |
可选的使用者作 ID，用于将结果限制为 （任何结果为 null） |
| consumerId |
string |
可选的使用者 ID，用于将结果限制为 （任何结果为 null） |
| consumerInputFilters |
筛选订阅使用者输入 |
|
| eventType |
string |
可选事件类型 ID，用于将结果限制为 （任何结果为 null） |
| publisherId |
string |
可选的发布者 ID，用于将结果限制为 （任何结果为 null） |
| publisherInputFilters |
筛选订阅发布者输入 |
|
| results |
来自查询的结果 |
|
| subscriberId |
string (uuid) |
可选订阅服务器筛选器。 |
SubscriptionStatus
| 值 | 说明 |
|---|---|
| disabledByInactiveIdentity |
由于所有者处于非活动状态或缺少权限，订阅被禁用。 |
| disabledBySystem |
系统禁用订阅。 |
| disabledByUser |
用户禁用订阅。 |
| enabled |
已启用订阅。 |
| onProbation |
订阅暂时由系统进行缓刑。 |