General Settings - Update
更新管道常规设置。
PATCH https://dev.azure.com/{organization}/{project}/_apis/build/generalsettings?api-version=7.1
URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 组织的名称。 |
|
project
|
path | True |
string |
项目 ID 或项目名称 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。 |
请求正文
| 名称 | 类型 | 说明 |
|---|---|---|
| auditEnforceSettableVar |
boolean |
如果启用,则每当有人对管道运行进行排队并定义未标记为“队列时可设置”的变量时,都会生成审核日志。 |
| buildsEnabledForForks |
boolean |
启用分叉存储库以生成拉取请求。 |
| disableClassicBuildPipelineCreation |
boolean |
禁用经典生成管道创建。 |
| disableClassicPipelineCreation |
boolean |
禁用经典管道创建。 |
| disableClassicReleasePipelineCreation |
boolean |
禁用经典发布管道创建。 |
| enableShellTasksArgsSanitizing |
boolean |
启用 shell 任务参数清理。 |
| enableShellTasksArgsSanitizingAudit |
boolean |
启用 shell 任务清理预览版。 |
| enforceJobAuthScope |
boolean |
如果启用,所有非发布管道的访问范围都会减少到当前项目。 |
| enforceJobAuthScopeForForks |
boolean |
为分叉存储库的生成强制实施作业身份验证范围。 |
| enforceJobAuthScopeForReleases |
boolean |
如果启用,则所有发布管道的访问范围都会减少到当前项目。 |
| enforceNoAccessToSecretsFromForks |
boolean |
强制不对分叉存储库的生成进行机密访问。 |
| enforceReferencedRepoScopedToken |
boolean |
将所有管道的访问范围限制为仅由管道显式引用的存储库。 |
| enforceSettableVar |
boolean |
如果启用,则只能在队列时间设置显式标记为“Settable”的变量。 |
| forkProtectionEnabled |
boolean |
启用强制实施某些级别的保护的设置,以便全局生成分支中的拉取请求。 |
| isCommentRequiredForPullRequest |
boolean |
在所有拉取请求中生成需要注释。 |
| publishPipelineMetadata |
boolean |
允许管道记录元数据。 |
| requireCommentsForNonTeamMemberAndNonContributors |
boolean |
在非团队成员和非参与者的拉取请求中生成生成需要进行注释。 |
| requireCommentsForNonTeamMembersOnly |
boolean |
在非团队成员的拉取请求中生成生成需要进行注释。 |
| statusBadgesArePrivate |
boolean |
匿名用户可以访问所有管道的状态锁屏提醒 API,除非已启用此选项。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 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.project_write | 允许读取和更新项目和团队。 |
定义
PipelineGeneralSettings
包含管道常规设置。
| 名称 | 类型 | 说明 |
|---|---|---|
| auditEnforceSettableVar |
boolean |
如果启用,则每当有人对管道运行进行排队并定义未标记为“队列时可设置”的变量时,都会生成审核日志。 |
| buildsEnabledForForks |
boolean |
启用分叉存储库以生成拉取请求。 |
| disableClassicBuildPipelineCreation |
boolean |
禁用经典生成管道创建。 |
| disableClassicPipelineCreation |
boolean |
禁用经典管道创建。 |
| disableClassicReleasePipelineCreation |
boolean |
禁用经典发布管道创建。 |
| enableShellTasksArgsSanitizing |
boolean |
启用 shell 任务参数清理。 |
| enableShellTasksArgsSanitizingAudit |
boolean |
启用 shell 任务清理预览版。 |
| enforceJobAuthScope |
boolean |
如果启用,所有非发布管道的访问范围都会减少到当前项目。 |
| enforceJobAuthScopeForForks |
boolean |
为分叉存储库的生成强制实施作业身份验证范围。 |
| enforceJobAuthScopeForReleases |
boolean |
如果启用,则所有发布管道的访问范围都会减少到当前项目。 |
| enforceNoAccessToSecretsFromForks |
boolean |
强制不对分叉存储库的生成进行机密访问。 |
| enforceReferencedRepoScopedToken |
boolean |
将所有管道的访问范围限制为仅由管道显式引用的存储库。 |
| enforceSettableVar |
boolean |
如果启用,则只能在队列时间设置显式标记为“Settable”的变量。 |
| forkProtectionEnabled |
boolean |
启用强制实施某些级别的保护的设置,以便全局生成分支中的拉取请求。 |
| isCommentRequiredForPullRequest |
boolean |
在所有拉取请求中生成需要注释。 |
| publishPipelineMetadata |
boolean |
允许管道记录元数据。 |
| requireCommentsForNonTeamMemberAndNonContributors |
boolean |
在非团队成员和非参与者的拉取请求中生成生成需要进行注释。 |
| requireCommentsForNonTeamMembersOnly |
boolean |
在非团队成员的拉取请求中生成生成需要进行注释。 |
| statusBadgesArePrivate |
boolean |
匿名用户可以访问所有管道的状态锁屏提醒 API,除非已启用此选项。 |