General Settings - Update

リファレンス

サービス:: Build

API バージョン:: 7.1-preview.1

パイプラインの全般設定をUpdatesします。

PATCH https://dev.azure.com/{organization}/{project}/_apis/build/generalsettings?api-version=7.1-preview.1

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
project	path	True	string	プロジェクト ID またはプロジェクト名
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。

要求本文

名前	型	説明
auditEnforceSettableVar	boolean	有効にすると、誰かがパイプラインの実行をキューに入れ、"キュー時に設定可能" としてマークされていない変数を定義するたびに監査ログが生成されます。
buildsEnabledForForks	boolean	フォークされたリポジトリを有効にして、pull request をビルドします。
disableClassicBuildPipelineCreation	boolean	クラシックビルドパイプラインの作成を無効にします。
disableClassicPipelineCreation	boolean	クラシックパイプラインの作成を無効にします。
disableClassicReleasePipelineCreation	boolean	クラシックリリースパイプラインの作成を無効にします。
enableShellTasksArgsSanitizing	boolean	シェルタスク引数のサニタイズを有効にします。
enableShellTasksArgsSanitizingAudit	boolean	シェルタスク引数サニタイズプレビューを有効にします。
enforceJobAuthScope	boolean	有効にすると、リリース以外のすべてのパイプラインに対するアクセスのスコープが現在のプロジェクトに減ります。
enforceJobAuthScopeForForks	boolean	フォークされたリポジトリのビルドにジョブ認証スコープを適用します。
enforceJobAuthScopeForReleases	boolean	有効にすると、すべてのリリースパイプラインのアクセススコープが現在のプロジェクトに減ります。
enforceNoAccessToSecretsFromForks	boolean	フォークされたリポジトリのビルドにシークレットへのアクセスを強制しません。
enforceReferencedRepoScopedToken	boolean	すべてのパイプラインのアクセススコープを、パイプラインによって明示的に参照されるリポジトリのみに制限します。
enforceSettableVar	boolean	有効にした場合、キュー時に "Settable at queue time" として明示的にマークされている変数のみを設定できます。
forkProtectionEnabled	boolean	フォークからの pull request をグローバルに構築するために、特定のレベルの保護を適用する設定を有効にします。
isCommentRequiredForPullRequest	boolean	すべての pull request にビルドを含める必要があるコメントを作成します。
publishPipelineMetadata	boolean	パイプラインでメタデータを記録できるようにします。
requireCommentsForNonTeamMemberAndNonContributors	boolean	チームメンバーや共同作成者以外からの pull request にビルドを含めるために必要なコメントを作成します。
requireCommentsForNonTeamMembersOnly	boolean	チーム以外のメンバーからの pull request にビルドを含めるために必要なコメントを作成します。
statusBadgesArePrivate	boolean	匿名ユーザーは、このオプションが有効になっていない限り、すべてのパイプラインのステータスバッジ API にアクセスできます。

応答

名前	型	説明
200 OK	PipelineGeneralSettings	成功した操作

セキュリティ

oauth2

型: oauth2
フロー: accessCode
Authorization URL (承認 URL): https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL (トークン 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	フォークされたリポジトリを有効にして、pull request をビルドします。
disableClassicBuildPipelineCreation	boolean	クラシックビルドパイプラインの作成を無効にします。
disableClassicPipelineCreation	boolean	クラシックパイプラインの作成を無効にします。
disableClassicReleasePipelineCreation	boolean	クラシックリリースパイプラインの作成を無効にします。
enableShellTasksArgsSanitizing	boolean	シェルタスク引数のサニタイズを有効にします。
enableShellTasksArgsSanitizingAudit	boolean	シェルタスク引数サニタイズプレビューを有効にします。
enforceJobAuthScope	boolean	有効にすると、リリース以外のすべてのパイプラインに対するアクセスのスコープが現在のプロジェクトに減ります。
enforceJobAuthScopeForForks	boolean	フォークされたリポジトリのビルドにジョブ認証スコープを適用します。
enforceJobAuthScopeForReleases	boolean	有効にすると、すべてのリリースパイプラインのアクセススコープが現在のプロジェクトに減ります。
enforceNoAccessToSecretsFromForks	boolean	フォークされたリポジトリのビルドにシークレットへのアクセスを強制しません。
enforceReferencedRepoScopedToken	boolean	すべてのパイプラインのアクセススコープを、パイプラインによって明示的に参照されるリポジトリのみに制限します。
enforceSettableVar	boolean	有効にした場合、キュー時に "Settable at queue time" として明示的にマークされている変数のみを設定できます。
forkProtectionEnabled	boolean	フォークからの pull request をグローバルに構築するために、特定のレベルの保護を適用する設定を有効にします。
isCommentRequiredForPullRequest	boolean	すべての pull request にビルドを含める必要があるコメントを作成します。
publishPipelineMetadata	boolean	パイプラインでメタデータを記録できるようにします。
requireCommentsForNonTeamMemberAndNonContributors	boolean	チームメンバーや共同作成者以外からの pull request にビルドを含めるために必要なコメントを作成します。
requireCommentsForNonTeamMembersOnly	boolean	チーム以外のメンバーからの pull request にビルドを含めるために必要なコメントを作成します。
statusBadgesArePrivate	boolean	匿名ユーザーは、このオプションが有効になっていない限り、すべてのパイプラインのステータスバッジ API にアクセスできます。

次の方法で共有