Class PolicyApi

constructor

• new PolicyApi(
      baseUrl: string,
      handlers: IRequestHandler[],
      options?: IRequestOptions,
  ): PolicyApi

  Parameters

  • baseUrl: string
  • handlers: IRequestHandler[]
  • Optionaloptions: IRequestOptions

  Returns PolicyApi

Static ReadonlyRESOURCE_AREA_ID

createPolicyConfiguration

• createPolicyConfiguration(
      configuration: PolicyConfiguration,
      project: string,
  ): Promise<PolicyConfiguration>

  Create a policy configuration of a given policy type.

  Parameters

  • configuration: PolicyConfiguration

    The policy configuration to create.
  • project: string

    Project ID or project name

  Returns Promise<PolicyConfiguration>

deletePolicyConfiguration

• deletePolicyConfiguration(
      project: string,
      configurationId: number,
  ): Promise<void>

  Delete a policy configuration by its ID.

  Parameters

  • project: string

    Project ID or project name
  • configurationId: number

    ID of the policy configuration to delete.

  Returns Promise<void>

getPolicyConfiguration

• getPolicyConfiguration(
      project: string,
      configurationId: number,
  ): Promise<PolicyConfiguration>

  Get a policy configuration by its ID.

  Parameters

  • project: string

    Project ID or project name
  • configurationId: number

    ID of the policy configuration

  Returns Promise<PolicyConfiguration>

getPolicyConfigurationRevision

• getPolicyConfigurationRevision(
      project: string,
      configurationId: number,
      revisionId: number,
  ): Promise<PolicyConfiguration>

  Retrieve a specific revision of a given policy by ID.

  Parameters

  • project: string

    Project ID or project name
  • configurationId: number

    The policy configuration ID.
  • revisionId: number

    The revision ID.

  Returns Promise<PolicyConfiguration>

getPolicyConfigurationRevisions

• getPolicyConfigurationRevisions(
      project: string,
      configurationId: number,
      top?: number,
      skip?: number,
  ): Promise<PolicyConfiguration[]>

  Retrieve all revisions for a given policy.

  Parameters

  • project: string

    Project ID or project name
  • configurationId: number

    The policy configuration ID.
  • Optionaltop: number

    The number of revisions to retrieve.
  • Optionalskip: number

    The number of revisions to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.

  Returns Promise<PolicyConfiguration[]>

getPolicyConfigurations

• getPolicyConfigurations(
      project: string,
      scope?: string,
      policyType?: string,
  ): Promise<PagedList<PolicyConfiguration>>

  Get a list of policy configurations in a project.

  Parameters

  • project: string

    Project ID or project name
  • Optionalscope: string

    [Provided for legacy reasons] The scope on which a subset of policies is defined.
  • OptionalpolicyType: string

    Filter returned policies to only this type

  Returns Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation

• getPolicyEvaluation(
      project: string,
      evaluationId: string,
  ): Promise<PolicyEvaluationRecord>

  Gets the present evaluation state of a policy.

  Parameters

  • project: string

    Project ID or project name
  • evaluationId: string

    ID of the policy evaluation to be retrieved.

  Returns Promise<PolicyEvaluationRecord>

getPolicyEvaluations

• getPolicyEvaluations(
      project: string,
      artifactId: string,
      includeNotApplicable?: boolean,
      top?: number,
      skip?: number,
  ): Promise<PolicyEvaluationRecord[]>

  Retrieves a list of all the policy evaluation statuses for a specific pull request.

  Parameters

  • project: string

    Project ID or project name
  • artifactId: string

    A string which uniquely identifies the target of a policy evaluation.
  • OptionalincludeNotApplicable: boolean

    Some policies might determine that they do not apply to a specific pull request. Setting this parameter to true will return evaluation records even for policies which don't apply to this pull request.
  • Optionaltop: number

    The number of policy evaluation records to retrieve.
  • Optionalskip: number

    The number of policy evaluation records to ignore. For example, to retrieve results 101-150, set top to 50 and skip to 100.

  Returns Promise<PolicyEvaluationRecord[]>

getPolicyType

• getPolicyType(project: string, typeId: string): Promise<PolicyType>

  Retrieve a specific policy type by ID.

  Parameters

  • project: string

    Project ID or project name
  • typeId: string

    The policy ID.

  Returns Promise<PolicyType>

getPolicyTypes

• getPolicyTypes(project: string): Promise<PolicyType[]>

  Retrieve all available policy types.

  Parameters

  • project: string

    Project ID or project name

  Returns Promise<PolicyType[]>

requeuePolicyEvaluation

• requeuePolicyEvaluation(
      project: string,
      evaluationId: string,
  ): Promise<PolicyEvaluationRecord>

  Requeue the policy evaluation.

  Parameters

  • project: string

    Project ID or project name
  • evaluationId: string

    ID of the policy evaluation to be retrieved.

  Returns Promise<PolicyEvaluationRecord>

updatePolicyConfiguration

• updatePolicyConfiguration(
      configuration: PolicyConfiguration,
      project: string,
      configurationId: number,
  ): Promise<PolicyConfiguration>

  Update a policy configuration by its ID.

  Parameters

  • configuration: PolicyConfiguration

    The policy configuration to update.
  • project: string

    Project ID or project name
  • configurationId: number

    ID of the existing policy configuration to be updated.

  Returns Promise<PolicyConfiguration>