Share via


Evaluations - Requeue Policy Evaluation

Requeue the policy evaluation.

Some policies define a "requeue" action which performs some policy-specific operation. You can trigger this operation by updating an existing policy evaluation and setting the PolicyEvaluationRecord.Status field to Queued. Although any policy evaluation can be requeued, at present only build policies perform any action in response. Requeueing a build policy will queue a new build to run (cancelling any existing build which is running).

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

URI Parameters

Name In Required Type Description
evaluationId
path True

string (uuid)

ID of the policy evaluation to be retrieved.

organization
path True

string

The name of the Azure DevOps organization.

project
path True

string

Project ID or project name

api-version
query True

string

Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.

Responses

Name Type Description
200 OK

PolicyEvaluationRecord

successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token 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

Scopes

Name Description
vso.code_write Grants the ability to read, update, and delete source code, access metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to create and manage pull requests and code reviews and to receive notifications about version control events via service hooks.

Definitions

Name Description
IdentityRef
JObject

Represents a JSON object.

PolicyConfiguration

The full policy configuration with settings.

PolicyEvaluationRecord

This record encapsulates the current state of a policy as it applies to one specific pull request. Each pull request has a unique PolicyEvaluationRecord for each pull request which the policy applies to.

PolicyEvaluationStatus

Status of the policy (Running, Approved, Failed, etc.)

PolicyTypeRef

Policy type reference.

ReferenceLinks

The class to represent a collection of REST reference links.

IdentityRef

Name Type Description
_links

ReferenceLinks

This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.

descriptor

string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.

directoryAlias

string

Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary

displayName

string

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.

id

string

imageUrl

string

Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary

inactive

boolean

Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary

isAadIdentity

boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)

isDeletedInOrigin

boolean

profileUrl

string

Deprecated - not in use in most preexisting implementations of ToIdentityRef

uniqueName

string

Deprecated - use Domain+PrincipalName instead

url

string

This url is the full route to the source resource of this graph subject.

JObject

Represents a JSON object.

Name Type Description
item

string (JToken)

type

string (JTokenType)

Gets the node type for this JToken.

PolicyConfiguration

The full policy configuration with settings.

Name Type Description
_links

ReferenceLinks

The links to other objects related to this object.

createdBy

IdentityRef

A reference to the identity that created the policy.

createdDate

string (date-time)

The date and time when the policy was created.

id

integer (int32)

The policy configuration ID.

isBlocking

boolean

Indicates whether the policy is blocking.

isDeleted

boolean

Indicates whether the policy has been (soft) deleted.

isEnabled

boolean

Indicates whether the policy is enabled.

isEnterpriseManaged

boolean

If set, this policy requires "Manage Enterprise Policies" permission to create, edit, or delete.

revision

integer (int32)

The policy configuration revision ID.

settings

JObject

The policy configuration settings.

type

PolicyTypeRef

The policy configuration type.

url

string

The URL where the policy configuration can be retrieved.

PolicyEvaluationRecord

This record encapsulates the current state of a policy as it applies to one specific pull request. Each pull request has a unique PolicyEvaluationRecord for each pull request which the policy applies to.

Name Type Description
_links

ReferenceLinks

Links to other related objects

artifactId

string

A string which uniquely identifies the target of a policy evaluation.

completedDate

string (date-time)

Time when this policy finished evaluating on this pull request.

configuration

PolicyConfiguration

Contains all configuration data for the policy which is being evaluated.

context

JObject

Internal context data of this policy evaluation.

evaluationId

string (uuid)

Guid which uniquely identifies this evaluation record (one policy running on one pull request).

startedDate

string (date-time)

Time when this policy was first evaluated on this pull request.

status

PolicyEvaluationStatus

Status of the policy (Running, Approved, Failed, etc.)

PolicyEvaluationStatus

Status of the policy (Running, Approved, Failed, etc.)

Value Description
approved

The policy has been fulfilled for this pull request.

broken

The policy has encountered an unexpected error.

notApplicable

The policy does not apply to this pull request.

queued

The policy is either queued to run, or is waiting for some event before progressing.

rejected

The policy has rejected this pull request.

running

The policy is currently running.

PolicyTypeRef

Policy type reference.

Name Type Description
displayName

string

Display name of the policy type.

id

string (uuid)

The policy type ID.

url

string

The URL where the policy type can be retrieved.

The class to represent a collection of REST reference links.

Name Type Description
links

object

The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.