Evaluations - Requeue Policy Evaluation

サービス:

Policy

API バージョン:

7.1-preview.1

ポリシーの評価を再キューに入れ直します。

一部のポリシーでは、ポリシー固有の操作を実行する "requeue" アクションが定義されています。 この操作をトリガーするには、既存のポリシー評価を更新し、PolicyEvaluationRecord.Status フィールドを Queued に設定します。 どのポリシー評価も再キューに入れ直すことができますが、現時点では、ビルド ポリシーのみが応答でアクションを実行します。 ビルド ポリシーをキューに入れ直すと、実行する新しいビルドがキューに入れられます (実行中の既存のビルドは取り消されます)。

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

URI パラメーター

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

応答

名前	型	説明
200 OK	PolicyEvaluationRecord	正常な操作

セキュリティ

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.code_write	ソース コードの読み取り、更新、削除、コミット、変更セット、ブランチ、およびその他のバージョン管理成果物に関するメタデータへのアクセスを許可します。 また、pull request とコード レビューを作成および管理したり、サービス フックを介してバージョン管理イベントに関する通知を受信したりすることもできます。

定義

名前	説明
IdentityRef
JObject	JSON オブジェクトを表します。
PolicyConfiguration	設定を含む完全なポリシー構成。
PolicyEvaluationRecord	このレコードは、1 つの特定のプル要求に適用されるポリシーの現在の状態をカプセル化します。 各プル要求には、ポリシーが適用されるプル要求ごとに一意の PolicyEvaluationRecord があります。
PolicyEvaluationStatus	ポリシーの状態 (実行中、承認済み、失敗など)
PolicyTypeRef	ポリシーの種類のリファレンス。
ReferenceLinks	REST 参照リンクのコレクションを表す クラス。

IdentityRef

Object

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。 これらのリンクを呼び出して、このグラフの主題に関する追加のリレーションシップや詳細情報を取得できます。
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	非推奨 - 記述子のサブジェクト型 (Descriptor.IsGroupType) から推論できます
isDeletedInOrigin	boolean
profileUrl	string	非推奨 - ToIdentityRef の既存のほとんどの実装では使用されていません
uniqueName	string	非推奨 - 代わりに Domain+PrincipalName を使用します
url	string	この URL は、このグラフの件名のソース リソースへの完全なルートです。

JObject

Object

JSON オブジェクトを表します。

名前	型	説明
item	string
type	string	この JToken のノードの種類を取得します。

PolicyConfiguration

Object

設定を含む完全なポリシー構成。

名前	型	説明
_links	ReferenceLinks	このオブジェクトに関連する他のオブジェクトへのリンク。
createdBy	IdentityRef	ポリシーを作成した ID への参照。
createdDate	string	ポリシーが作成された日時。
id	integer	ポリシー構成 ID。
isBlocking	boolean	ポリシーがブロックされているかどうかを示します。
isDeleted	boolean	ポリシーが (論理的に) 削除されたかどうかを示します。
isEnabled	boolean	ポリシーが有効かどうかを示します。
isEnterpriseManaged	boolean	設定されている場合、このポリシーには、作成、編集、または削除するための "エンタープライズ ポリシーの管理" アクセス許可が必要です。
revision	integer	ポリシー構成リビジョン ID。
settings	JObject	ポリシー構成設定。
type	PolicyTypeRef	ポリシー構成の種類。
url	string	ポリシー構成を取得できる URL。

PolicyEvaluationRecord

Object

このレコードは、1 つの特定のプル要求に適用されるポリシーの現在の状態をカプセル化します。 各プル要求には、ポリシーが適用されるプル要求ごとに一意の PolicyEvaluationRecord があります。

名前	型	説明
_links	ReferenceLinks	他の関連オブジェクトへのリンク
artifactId	string	ポリシー評価のターゲットを一意に識別する文字列。
completedDate	string	このプル要求でこのポリシーの評価が完了した時刻。
configuration	PolicyConfiguration	評価対象のポリシーのすべての構成データが含まれます。
context	JObject	このポリシー評価の内部コンテキスト データ。
evaluationId	string	この評価レコードを一意に識別する Guid (1 つのプル要求で実行されている 1 つのポリシー)。
startedDate	string	このプル要求でこのポリシーが最初に評価された時刻。
status	PolicyEvaluationStatus	ポリシーの状態 (実行中、承認済み、失敗など)

PolicyEvaluationStatus

列挙

ポリシーの状態 (実行中、承認済み、失敗など)

値	説明
approved	この pull request に対してポリシーが満たされました。
broken	ポリシーで予期しないエラーが発生しました。
notApplicable	ポリシーは、この pull request には適用されません。
queued	ポリシーは、実行するためにキューに登録されているか、進行する前に何らかのイベントを待機しています。
rejected	ポリシーによってこの pull request が拒否されました。
running	ポリシーは現在実行中です。

PolicyTypeRef

Object

ポリシーの種類のリファレンス。

名前	型	説明
displayName	string	ポリシーの種類の表示名。
id	string	ポリシーの種類 ID。
url	string	ポリシーの種類を取得できる URL。

ReferenceLinks

Object

REST 参照リンクのコレクションを表す クラス。

名前	型	説明
links	object	リンクの読み取り時ビュー。 参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。