PolicyRestClient class

Paket:

azure-devops-extension-api

VSS REST api'lerine istekte bulunmak için kullanılması gereken (türetilen) temel sınıf

Extends

RestClientBase

Oluşturucular

PolicyRestClient(IVssRestClientOptions)

Özellikler

RESOURCE_AREA_ID

Yöntemler

createPolicyConfiguration(PolicyConfiguration, string)	Belirli bir ilke türünün ilke yapılandırmasını oluşturun.
deletePolicyConfiguration(string, number)	İlke yapılandırmasını kimliğine göre silin.
getPolicyConfiguration(string, number)	Kimliğine göre bir ilke yapılandırması alın.
getPolicyConfigurationRevision(string, number, number)	Kimliğe göre belirli bir politikanın belirli bir revizyonunu alın.
getPolicyConfigurationRevisions(string, number, number, number)	Belirli bir ilke için tüm düzeltmeleri alın.
getPolicyConfigurations(string, string, string)	Bir projedeki ilke yapılandırmalarının listesini alın.
getPolicyEvaluation(string, string)	Bir ilkenin mevcut değerlendirme durumunu alır.
getPolicyEvaluations(string, string, boolean, number, number)	Belirli bir çekme isteği için tüm ilke değerlendirme durumlarının listesini alır.
getPolicyType(string, string)	Kimliğe göre belirli bir ilke türünü alın.
getPolicyTypes(string)	Kullanılabilir tüm ilke türlerini alın.
requeuePolicyEvaluation(string, string)	İlke değerlendirmesini yeniden kuyruğa alın.
updatePolicyConfiguration(PolicyConfiguration, string, number)	İlke yapılandırmasını kimliğine göre güncelleştirin.

Oluşturucu Ayrıntıları

PolicyRestClient(IVssRestClientOptions)

new PolicyRestClient(options: IVssRestClientOptions)

Parametreler

options

IVssRestClientOptions

Özellik Ayrıntıları

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Özellik Değeri

string

Yöntem Ayrıntıları

createPolicyConfiguration(PolicyConfiguration, string)

Belirli bir ilke türünün ilke yapılandırmasını oluşturun.

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

Parametreler

configuration

PolicyConfiguration

Oluşturulacak ilke yapılandırması.

project

string

Proje kimliği veya proje adı

Döndürülenler

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

İlke yapılandırmasını kimliğine göre silin.

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

Parametreler

project

string

Proje kimliği veya proje adı

configurationId

number

Silinecek ilke yapılandırmasının kimliği.

Döndürülenler

Promise<void>

getPolicyConfiguration(string, number)

Kimliğine göre bir ilke yapılandırması alın.

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

Parametreler

project

string

Proje kimliği veya proje adı

configurationId

number

İlke yapılandırmasının kimliği

Döndürülenler

Promise<PolicyConfiguration>

getPolicyConfigurationRevision(string, number, number)

Kimliğe göre belirli bir politikanın belirli bir revizyonunu alın.

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

Parametreler

project

string

Proje kimliği veya proje adı

configurationId

number

İlke yapılandırma kimliği.

revisionId

number

Düzeltme kimliği.

Döndürülenler

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

Belirli bir ilke için tüm düzeltmeleri alın.

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

Parametreler

project

string

Proje kimliği veya proje adı

configurationId

number

İlke yapılandırma kimliği.

top

number

Alınacak düzeltmelerin sayısı.

skip

number

Yok sayılacak revizyon sayısı. Örneğin, 101-150 arası sonuçları almak için üst değerini 50 olarak ayarlayın ve 100'e atlayın.

Döndürülenler

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

Bir projedeki ilke yapılandırmalarının listesini alın.

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

Parametreler

project

string

Proje kimliği veya proje adı

scope

string

[Eski nedenlerle sağlanmıştır] İlkelerin bir alt kümesinin tanımlandığı kapsam.

policyType

string

Döndürülen ilkeleri yalnızca bu türe göre filtreleyin

Döndürülenler

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

Bir ilkenin mevcut değerlendirme durumunu alır.

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

Parametreler

project

string

Proje kimliği veya proje adı

evaluationId

string

Alınacak ilke değerlendirmesinin kimliği.

Döndürülenler

Promise<PolicyEvaluationRecord>

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

Belirli bir çekme isteği için tüm ilke değerlendirme durumlarının listesini alır.

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

Parametreler

project

string

Proje kimliği veya proje adı

artifactId

string

Bir ilke değerlendirmesinin hedefini benzersiz bir şekilde tanımlayan bir dize.

includeNotApplicable

boolean

Bazı ilkeler, belirli bir çekme isteği için geçerli olmadıklarını belirleyebilir. Bu parametreyi true olarak ayarlamak, bu çekme isteği için geçerli olmayan ilkeler için bile değerlendirme kayıtlarını döndürür.

top

number

Alınacak ilke değerlendirme kayıtlarının sayısı.

skip

number

Yok sayılacak ilke değerlendirme kayıtlarının sayısı. Örneğin, 101-150 arası sonuçları almak için üst değerini 50 olarak ayarlayın ve 100'e atlayın.

Döndürülenler

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

Kimliğe göre belirli bir ilke türünü alın.

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

Parametreler

project

string

Proje kimliği veya proje adı

typeId

string

Politika Kimliği.

Döndürülenler

Promise<PolicyType>

getPolicyTypes(string)

Kullanılabilir tüm ilke türlerini alın.

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

Parametreler

project

string

Proje kimliği veya proje adı

Döndürülenler

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

İlke değerlendirmesini yeniden kuyruğa alın.

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

Parametreler

project

string

Proje kimliği veya proje adı

evaluationId

string

Alınacak ilke değerlendirmesinin kimliği.

Döndürülenler

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

İlke yapılandırmasını kimliğine göre güncelleştirin.

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

Parametreler

configuration

PolicyConfiguration

Güncelleştirilecek ilke yapılandırması.

project

string

Proje kimliği veya proje adı

configurationId

number

Güncelleştirilecek mevcut ilke yapılandırmasının kimliği.

Döndürülenler

Promise<PolicyConfiguration>