PolicyRestClient class

الحزمة:

azure-devops-extension-api

الفئة الأساسية التي يجب استخدامها (مشتقة من) لتقديم طلبات إلى VSS REST apis

يمتد

RestClientBase

المنشئون

PolicyRestClient(IVssRestClientOptions)

الخصائص

RESOURCE_AREA_ID

الأساليب

createPolicyConfiguration(PolicyConfiguration, string)	قم بإنشاء تكوين نهج لنوع نهج معين.
deletePolicyConfiguration(string, number)	احذف تكوين نهج حسب معرفه.
getPolicyConfiguration(string, number)	احصل على تكوين نهج حسب معرفه.
getPolicyConfigurationRevision(string, number, number)	استرداد مراجعة معينة لنهج معين حسب المعرف.
getPolicyConfigurationRevisions(string, number, number, number)	استرداد جميع المراجعات لنهج معين.
getPolicyConfigurations(string, string, string)	احصل على قائمة بتكوينات النهج في مشروع.
getPolicyEvaluation(string, string)	الحصول على حالة التقييم الحالية للسياسة.
getPolicyEvaluations(string, string, boolean, number, number)	استرداد قائمة بجميع حالات تقييم السياسة لطلب سحب معين.
getPolicyType(string, string)	استرداد نوع نهج معين حسب المعرف.
getPolicyTypes(string)	استرداد جميع أنواع النهج المتاحة.
requeuePolicyEvaluation(string, string)	أعد وضع تقييم النهج في قائمة الانتظار.
updatePolicyConfiguration(PolicyConfiguration, string, number)	قم بتحديث تكوين نهج حسب معرفه.

تفاصيل المنشئ

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

معرف المشروع أو اسم المشروع

المرتجعات

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

احذف تكوين نهج حسب معرفه.

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

المعلمات

project

string

معرف المشروع أو اسم المشروع

configurationId

number

معرف تكوين النهج المراد حذفه.

المرتجعات

Promise<void>

getPolicyConfiguration(string, number)

احصل على تكوين نهج حسب معرفه.

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

المعلمات

project

string

معرف المشروع أو اسم المشروع

configurationId

number

معرف تكوين النهج

المرتجعات

Promise<PolicyConfiguration>

getPolicyConfigurationRevision(string, number, number)

استرداد مراجعة معينة لنهج معين حسب المعرف.

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

المعلمات

project

string

معرف المشروع أو اسم المشروع

configurationId

number

معرف تكوين السياسة.

revisionId

number

معرف المراجعة.

المرتجعات

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

استرداد جميع المراجعات لنهج معين.

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

المعلمات

project

string

معرف المشروع أو اسم المشروع

configurationId

number

معرف تكوين السياسة.

top

number

عدد المراجعات المطلوب استردادها.

skip

number

عدد المراجعات التي يجب تجاهلها. على سبيل المثال، لاسترداد النتائج 101-150، قم بتعيين أعلى إلى 50 وتخطي إلى 100.

المرتجعات

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

احصل على قائمة بتكوينات النهج في مشروع.

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

المعلمات

project

string

معرف المشروع أو اسم المشروع

scope

string

[مقدمة لأسباب إرثية] النطاق الذي يتم على أساسه تحديد مجموعة فرعية من السياسات.

policyType

string

تصفية السياسات التي تم إرجاعها إلى هذا النوع فقط

المرتجعات

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

الحصول على حالة التقييم الحالية للسياسة.

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

المعلمات

project

string

معرف المشروع أو اسم المشروع

evaluationId

string

معرف تقييم السياسة المراد استرداده.

المرتجعات

Promise<PolicyEvaluationRecord>

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

استرداد قائمة بجميع حالات تقييم السياسة لطلب سحب معين.

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

المعلمات

project

string

معرف المشروع أو اسم المشروع

artifactId

string

سلسلة تحدد بشكل فريد هدف تقييم السياسة.

includeNotApplicable

boolean

قد تحدد بعض السياسات أنها لا تنطبق على طلب سحب معين. سيؤدي تعيين هذه المعلمة إلى true إلى إرجاع سجلات التقييم حتى للنهج التي لا تنطبق على طلب السحب هذا.

top

number

عدد سجلات تقييم السياسة المطلوب استردادها.

skip

number

عدد سجلات تقييم السياسات التي يجب تجاهلها. على سبيل المثال، لاسترداد النتائج 101-150، قم بتعيين أعلى إلى 50 وتخطي إلى 100.

المرتجعات

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

استرداد نوع نهج معين حسب المعرف.

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

المعلمات

project

string

معرف المشروع أو اسم المشروع

typeId

string

معرف السياسة.

المرتجعات

Promise<PolicyType>

getPolicyTypes(string)

استرداد جميع أنواع النهج المتاحة.

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

المعلمات

project

string

معرف المشروع أو اسم المشروع

المرتجعات

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

أعد وضع تقييم النهج في قائمة الانتظار.

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

المعلمات

project

string

معرف المشروع أو اسم المشروع

evaluationId

string

معرف تقييم السياسة المراد استرداده.

المرتجعات

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

قم بتحديث تكوين نهج حسب معرفه.

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

المعلمات

configuration

PolicyConfiguration

تكوين النهج المراد تحديثه.

project

string

معرف المشروع أو اسم المشروع

configurationId

number

معرف تكوين النهج الحالي المراد تحديثه.

المرتجعات

Promise<PolicyConfiguration>