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 に設定すると、この pull request に適用されないポリシーでも評価レコードが返されます。

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>