PolicyRestClient class

包:

azure-devops-extension-api

应使用 (派生自) 的基类向 VSS REST API 发出请求

Extends

RestClientBase

构造函数

PolicyRestClient(IVssRestClientOptions)

属性

RESOURCE_AREA_ID

方法

createPolicyConfiguration(PolicyConfiguration, string)	创建给定策略类型的策略配置。
deletePolicyConfiguration(string, number)	按 ID 删除策略配置。
getPolicyConfiguration(string, number)	按 ID 获取策略配置。
getPolicyConfigurationRevision(string, number, number)	按 ID 检索给定策略的特定修订。
getPolicyConfigurationRevisions(string, number, number, number)	检索给定策略的所有修订。
getPolicyConfigurations(string, string, string)	获取项目中的策略配置列表。
getPolicyEvaluation(string, string)	获取策略的当前评估状态。
getPolicyEvaluations(string, string, boolean, number, number)	检索特定拉取请求的所有策略评估状态的列表。
getPolicyType(string, string)	按 ID 检索特定策略类型。
getPolicyTypes(string)	检索所有可用的策略类型。
requeuePolicyEvaluation(string, string)	将策略评估重新排队。
updatePolicyConfiguration(PolicyConfiguration, string, number)	按 ID 更新策略配置。

构造函数详细信息

PolicyRestClient(IVssRestClientOptions)

new PolicyRestClient(options: IVssRestClientOptions)

参数

options

IVssRestClientOptions

属性详细信息

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

属性值

string

方法详细信息

createPolicyConfiguration(PolicyConfiguration, string)

创建给定策略类型的策略配置。

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

参数

configuration

PolicyConfiguration

要创建的策略配置。

project

string

项目 ID 或项目名称

返回

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

按 ID 删除策略配置。

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

参数

project

string

项目 ID 或项目名称

configurationId

number

要删除的策略配置的 ID。

返回

Promise<void>

getPolicyConfiguration(string, number)

按 ID 获取策略配置。

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

参数

project

string

项目 ID 或项目名称

configurationId

number

策略配置的 ID

返回

Promise<PolicyConfiguration>

getPolicyConfigurationRevision(string, number, number)

按 ID 检索给定策略的特定修订。

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

参数

project

string

项目 ID 或项目名称

configurationId

number

策略配置 ID。

revisionId

number

修订 ID。

返回

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

检索给定策略的所有修订。

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

参数

project

string

项目 ID 或项目名称

configurationId

number

策略配置 ID。

top

number

要检索的修订数。

skip

number

要忽略的修订数。 例如，若要检索结果 101-150，请将 top 设置为 50，然后跳到 100。

返回

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

获取项目中的策略配置列表。

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

参数

project

string

项目 ID 或项目名称

scope

string

[出于旧版原因而提供]定义策略子集的范围。

policyType

string

将返回的策略筛选为仅此类型

返回

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

获取策略的当前评估状态。

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

参数

project

string

项目 ID 或项目名称

evaluationId

string

要检索的策略评估的 ID。

返回

Promise<PolicyEvaluationRecord>

getPolicyEvaluations(string, string, boolean, number, number)

检索特定拉取请求的所有策略评估状态的列表。

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

参数

project

string

项目 ID 或项目名称

artifactId

string

唯一标识策略评估目标的字符串。

includeNotApplicable

boolean

某些策略可能会确定它们不适用于特定拉取请求。 将此参数设置为 true 将返回评估记录，即使对于不适用于此拉取请求的策略也是如此。

top

number

要检索的策略评估记录数。

skip

number

要忽略的策略评估记录数。 例如，若要检索结果 101-150，请将 top 设置为 50，然后跳到 100。

返回

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

按 ID 检索特定策略类型。

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

参数

project

string

项目 ID 或项目名称

typeId

string

策略 ID。

返回

Promise<PolicyType>

getPolicyTypes(string)

检索所有可用的策略类型。

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

参数

project

string

项目 ID 或项目名称

返回

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

将策略评估重新排队。

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

参数

project

string

项目 ID 或项目名称

evaluationId

string

要检索的策略评估的 ID。

返回

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

按 ID 更新策略配置。

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

参数

configuration

PolicyConfiguration

要更新的策略配置。

project

string

项目 ID 或项目名称

configurationId

number

要更新的现有策略配置的 ID。

返回

Promise<PolicyConfiguration>