Diagnostics - Update

服务:

Notification

API 版本:

7.1

更新订阅的诊断设置。

PUT https://{service}dev.azure.com/{organization}/_apis/notification/subscriptions/{subscriptionId}/diagnostics?api-version=7.1

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string	通知订阅的 ID。
organization	path		string	Azure DevOps 组织的名称。
service	path		string	此请求定向到的服务。
api-version	query	True	string	要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。

请求正文

名称	类型	说明
deliveryResults	UpdateSubscripitonTracingParameters	用于保留传递结果的诊断设置。 用于服务挂钩订阅。
deliveryTracing	UpdateSubscripitonTracingParameters	诊断设置，用于排查通知传递问题。
evaluationTracing	UpdateSubscripitonTracingParameters	用于排查事件匹配问题的诊断设置。

响应

名称	类型	说明
200 OK	SubscriptionDiagnostics	成功作

安全性

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.notification_write	提供对订阅的读/写访问权限，以及对事件元数据的读取访问权限，包括可筛选字段值。
vso.notification_diagnostics	提供对通知相关的诊断日志的访问权限，并提供为单个订阅启用诊断的功能。

示例

示例请求

HTTP

PUT https://dev.azure.com/_apis/notification/subscriptions/{subscriptionId}/diagnostics?api-version=7.1

{
  "evaluationTracing": {
    "enabled": true
  }
}

示例响应

状态代码:

200

{
  "evaluationTracing": {
    "enabled": true,
    "endDate": "2019-08-08T16:01:47.3259794Z",
    "startDate": "2019-08-08T15:01:47.3259794Z",
    "maxTracedEntries": 25
  }
}

定义

名称	说明
SubscriptionDiagnostics	包含订阅的所有诊断设置。
SubscriptionTracing	控制订阅的单个诊断设置的数据。
UpdateSubscripitonDiagnosticsParameters	用于更新订阅诊断设置的参数。
UpdateSubscripitonTracingParameters	用于更新特定诊断设置的参数。

SubscriptionDiagnostics

Object

包含订阅的所有诊断设置。

名称	类型	说明
deliveryResults	SubscriptionTracing	用于保留传递结果的诊断设置。 用于服务挂钩订阅。
deliveryTracing	SubscriptionTracing	诊断设置，用于排查通知传递问题。
evaluationTracing	SubscriptionTracing	用于排查事件匹配问题的诊断设置。

SubscriptionTracing

Object

控制订阅的单个诊断设置的数据。

名称	类型	说明
enabled	boolean	指示是否启用诊断跟踪。
endDate	string (date-time)	跟踪到指定的结束日期。
maxTracedEntries	integer (int32)	要跟踪的结果详细信息的最大数目。
startDate	string (date-time)	日期和时间跟踪已启动。
tracedEntries	integer (int32)	跟踪直到剩余计数达到 0。

UpdateSubscripitonDiagnosticsParameters

Object

用于更新订阅诊断设置的参数。

名称	类型	说明
deliveryResults	UpdateSubscripitonTracingParameters	用于保留传递结果的诊断设置。 用于服务挂钩订阅。
deliveryTracing	UpdateSubscripitonTracingParameters	诊断设置，用于排查通知传递问题。
evaluationTracing	UpdateSubscripitonTracingParameters	用于排查事件匹配问题的诊断设置。

UpdateSubscripitonTracingParameters

Object

用于更新特定诊断设置的参数。

名称	类型	说明
enabled	boolean	指示是否启用以禁用诊断跟踪。