PolicyRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k felé irányuló kérések küldéséhez (származtatásából) kell használni

Extends

RestClientBase

Konstruktorok

PolicyRestClient(IVssRestClientOptions)

Tulajdonságok

RESOURCE_AREA_ID

Metódusok

createPolicyConfiguration(PolicyConfiguration, string)	Hozzon létre egy adott szabályzattípusú szabályzatkonfigurációt.
deletePolicyConfiguration(string, number)	Szabályzatkonfiguráció törlése az azonosító alapján.
getPolicyConfiguration(string, number)	Szabályzatkonfiguráció lekérése az azonosító alapján.
getPolicyConfigurationRevision(string, number, number)	Egy adott szabályzat adott változatának lekérése azonosító alapján.
getPolicyConfigurationRevisions(string, number, number, number)	Egy adott szabályzat összes változatának lekérése.
getPolicyConfigurations(string, string, string)	Lekérheti a projekt szabályzatkonfigurációinak listáját.
getPolicyEvaluation(string, string)	Lekéri egy szabályzat aktuális kiértékelési állapotát.
getPolicyEvaluations(string, string, boolean, number, number)	Lekéri egy adott lekéréses kérelem szabályzatértékelési állapotainak listáját.
getPolicyType(string, string)	Adott szabályzattípus lekérése azonosító alapján.
getPolicyTypes(string)	Kérje le az összes elérhető szabályzattípust.
requeuePolicyEvaluation(string, string)	A szabályzat kiértékelését újra leküldi.
updatePolicyConfiguration(PolicyConfiguration, string, number)	Szabályzatkonfiguráció frissítése az azonosító alapján.

Konstruktor adatai

PolicyRestClient(IVssRestClientOptions)

new PolicyRestClient(options: IVssRestClientOptions)

Paraméterek

options

IVssRestClientOptions

Tulajdonság adatai

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Tulajdonság értéke

string

Metódus adatai

createPolicyConfiguration(PolicyConfiguration, string)

Hozzon létre egy adott szabályzattípusú szabályzatkonfigurációt.

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

Paraméterek

configuration

PolicyConfiguration

A létrehozandó szabályzatkonfiguráció.

project

string

Projektazonosító vagy projektnév

Válaszok

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

Szabályzatkonfiguráció törlése az azonosító alapján.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

configurationId

number

A törölni kívánt szabályzatkonfiguráció azonosítója.

Válaszok

Promise<void>

getPolicyConfiguration(string, number)

Szabályzatkonfiguráció lekérése az azonosító alapján.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

configurationId

number

A szabályzatkonfiguráció azonosítója

Válaszok

Promise<PolicyConfiguration>

getPolicyConfigurationRevision(string, number, number)

Egy adott szabályzat adott változatának lekérése azonosító alapján.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

configurationId

number

A szabályzat konfigurációs azonosítója.

revisionId

number

A változat azonosítója.

Válaszok

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

Egy adott szabályzat összes változatának lekérése.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

configurationId

number

A szabályzat konfigurációs azonosítója.

top

number

A lekérendő változatok száma.

skip

number

A figyelmen kívül hagyandó változatok száma. Ha például a 101–150 értéket szeretné lekérni, állítsa a felső értéket 50-re, és ugorjon a 100-ra.

Válaszok

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

Lekérheti a projekt szabályzatkonfigurációinak listáját.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

scope

string

[Örökölt okokból megadva] A hatókör, amelyen a szabályzatok egy részhalmaza definiálva van.

policyType

string

Visszaadott szabályzatok szűrése csak erre a típusra

Válaszok

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

Lekéri egy szabályzat aktuális kiértékelési állapotát.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

evaluationId

string

A lekérendő szabályzatértékelés azonosítója.

Válaszok

Promise<PolicyEvaluationRecord>

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

Lekéri egy adott lekéréses kérelem szabályzatértékelési állapotainak listáját.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

artifactId

string

Egy sztring, amely egyedileg azonosítja a szabályzatértékelés célját.

includeNotApplicable

boolean

Egyes szabályzatok megállapíthatják, hogy nem vonatkoznak egy adott lekéréses kérelemre. Ha ezt a paramétert true (igaz) értékre állítja, akkor a kiértékelési rekordok akkor is megjelennek, ha a szabályzatok nem vonatkoznak erre a lekéréses kérelemre.

top

number

A lekérendő szabályzatértékelési rekordok száma.

skip

number

A figyelmen kívül hagyandó szabályzatértékelési rekordok száma. Ha például a 101–150 értéket szeretné lekérni, állítsa a felső értéket 50-re, és ugorjon a 100-ra.

Válaszok

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

Adott szabályzattípus lekérése azonosító alapján.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

typeId

string

A szabályzat azonosítója.

Válaszok

Promise<PolicyType>

getPolicyTypes(string)

Kérje le az összes elérhető szabályzattípust.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

Válaszok

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

A szabályzat kiértékelését újra leküldi.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

evaluationId

string

A lekérendő szabályzatértékelés azonosítója.

Válaszok

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

Szabályzatkonfiguráció frissítése az azonosító alapján.

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

Paraméterek

configuration

PolicyConfiguration

A frissíteni kívánt szabályzatkonfiguráció.

project

string

Projektazonosító vagy projektnév

configurationId

number

A frissítendő meglévő szabályzatkonfiguráció azonosítója.

Válaszok

Promise<PolicyConfiguration>