PolicyRestClient class

Csomag:

azure-devops-extension-api

Alaposztály, amelyet a VSS REST API-k kéréseinek igénylé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óját.
deletePolicyConfiguration(string, number)	Szabályzatkonfiguráció törlése az azonosítója alapján.
getPolicyConfiguration(string, number)	Szabályzatkonfiguráció lekérése az azonosítója 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)	A projekt szabályzatkonfigurációinak listájának lekérése.
getPolicyEvaluation(string, string)	Lekéri a szabályzat jelenlegi kiértékelési állapotát.
getPolicyEvaluations(string, string, boolean, number, number)	Lekéri egy adott lekéréses kérelem összes szabályzatértékelési állapotának listáját.
getPolicyType(string, string)	Adott szabályzattípus lekérése azonosító alapján.
getPolicyTypes(string)	Az összes elérhető szabályzattípus lekérése.
requeuePolicyEvaluation(string, string)	Helyezze újra a szabályzat értékelését.
updatePolicyConfiguration(PolicyConfiguration, string, number)	Frissítse a szabályzatkonfigurációt az azonosítója 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ójá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ója 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ója 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érni kívánt változatok száma.

skip

number

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

Válaszok

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

A projekt szabályzatkonfigurációinak listájának lekérése.

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 biztosított] Az a hatókör, amelyen a házirendek egy részhalmaza definiálva van.

policyType

string

A szabályzatok szűrése csak erre a típusra adott vissza

Válaszok

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

Lekéri a szabályzat jelenlegi 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ért 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 összes szabályzatértékelési állapotának 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

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, az még a lekéréses kérelemre nem vonatkozó szabályzatok esetében is visszaadja a kiértékelési rekordokat.

top

number

A lekérni kívánt szabályzatértékelési rekordok száma.

skip

number

A figyelmen kívül hagyni kívánt szabályzatértékelési rekordok száma. Ha például 101–150-et szeretne lekérni, állítsa a felső értéket 50-re, és ugorjon 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)

Az összes elérhető szabályzattípus lekérése.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

Válaszok

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

Helyezze újra a szabályzat értékelését.

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

Paraméterek

project

string

Projektazonosító vagy projektnév

evaluationId

string

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

Válaszok

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

Frissítse a szabályzatkonfigurációt az azonosítója alapján.

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

Paraméterek

configuration

PolicyConfiguration

A frissítendő házirend-konfiguráció.

project

string

Projektazonosító vagy projektnév

configurationId

number

A frissítendő meglévő házirend-konfiguráció azonosítója.

Válaszok

Promise<PolicyConfiguration>