Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EvaluationsApi

Hierarchy

  • EvaluationsApi

Index

Constructors

constructor

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

getPolicyEvaluation

  • getPolicyEvaluation(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PolicyEvaluationRecord>
  • Gets the present evaluation state of a policy. Each policy which applies to a pull request will have an evaluation state which is specific to that policy running in the context of that pull request. Each evaluation is uniquely identified via a Guid. You can find all the policy evaluations for a specific pull request using the List operation of this controller.

    Parameters

    • params: object
      • apiVersion: string
      • evaluationId: string
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<PolicyEvaluationRecord>

getPolicyEvaluations

  • Retrieves a list of all the policy evaluation statuses for a specific pull request. Evaluations are retrieved using an artifact ID which uniquely identifies the pull request. To generate an artifact ID for a pull request, use this template: ``` vstfs:///CodeReview/CodeReviewId/{projectId}/{pullRequestId} ```

    Parameters

    • params: object
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • artifactId: string
      • Optional includeNotApplicable?: boolean
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<PolicyEvaluationRecord>>

requeuePolicyEvaluation

  • requeuePolicyEvaluation(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<PolicyEvaluationRecord>
  • 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).

    Parameters

    • params: object
      • apiVersion: string
      • evaluationId: string
      • organization: string
      • project: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<PolicyEvaluationRecord>

Generated using TypeDoc