PolicyRestClient class

Balíček:

azure-devops-extension-api

Základní třída, která by se měla použít (odvozená) k provádění požadavků na rozhraní REST API služby VSS

Extends

RestClientBase

Konstruktory

PolicyRestClient(IVssRestClientOptions)

Vlastnosti

RESOURCE_AREA_ID

Metody

createPolicyConfiguration(PolicyConfiguration, string)	Vytvořte konfiguraci zásad daného typu zásady.
deletePolicyConfiguration(string, number)	Odstraňte konfiguraci zásad podle id.
getPolicyConfiguration(string, number)	Získejte konfiguraci zásad podle id.
getPolicyConfigurationRevision(string, number, number)	Načtěte konkrétní revizi dané zásady podle ID.
getPolicyConfigurationRevisions(string, number, number, number)	Načtěte všechny revize pro danou zásadu.
getPolicyConfigurations(string, string, string)	Získejte seznam konfigurací zásad v projektu.
getPolicyEvaluation(string, string)	Získá aktuální stav vyhodnocení zásady.
getPolicyEvaluations(string, string, boolean, number, number)	Načte seznam všech stavů vyhodnocení zásad pro konkrétní žádost o přijetí změn.
getPolicyType(string, string)	Načtěte konkrétní typ zásady podle ID.
getPolicyTypes(string)	Načtěte všechny dostupné typy zásad.
requeuePolicyEvaluation(string, string)	Znovu vyhodnocení zásad.
updatePolicyConfiguration(PolicyConfiguration, string, number)	Aktualizujte konfiguraci zásad podle jeho ID.

Podrobnosti konstruktoru

PolicyRestClient(IVssRestClientOptions)

new PolicyRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Podrobnosti vlastnosti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Hodnota vlastnosti

string

Podrobnosti metody

createPolicyConfiguration(PolicyConfiguration, string)

Vytvořte konfiguraci zásad daného typu zásady.

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

Parametry

configuration

PolicyConfiguration

Konfigurace zásad, která se má vytvořit.

project

string

ID projektu nebo název projektu

Návraty

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

Odstraňte konfiguraci zásad podle id.

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

Parametry

project

string

ID projektu nebo název projektu

configurationId

number

ID konfigurace zásad, která se má odstranit.

Návraty

Promise<void>

getPolicyConfiguration(string, number)

Získejte konfiguraci zásad podle id.

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

Parametry

project

string

ID projektu nebo název projektu

configurationId

number

ID konfigurace zásad

Návraty

Promise<PolicyConfiguration>

getPolicyConfigurationRevision(string, number, number)

Načtěte konkrétní revizi dané zásady podle ID.

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

Parametry

project

string

ID projektu nebo název projektu

configurationId

number

ID konfigurace zásad.

revisionId

number

ID revize.

Návraty

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

Načtěte všechny revize pro danou zásadu.

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

Parametry

project

string

ID projektu nebo název projektu

configurationId

number

ID konfigurace zásad.

top

number

Počet revizí, které se mají načíst.

skip

number

Počet revizí, které se mají ignorovat. Pokud chcete například načíst výsledky 101–150, nastavte hodnotu 50 na 50 a přeskočte na 100.

Návraty

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

Získejte seznam konfigurací zásad v projektu.

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

Parametry

project

string

ID projektu nebo název projektu

scope

string

[Z důvodu starší verze] Obor, na kterém je definována podmnožina zásad.

policyType

string

Filtrování vrácených zásad pouze pro tento typ

Návraty

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

Získá aktuální stav vyhodnocení zásady.

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

Parametry

project

string

ID projektu nebo název projektu

evaluationId

string

ID vyhodnocení zásad, které se má načíst.

Návraty

Promise<PolicyEvaluationRecord>

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

Načte seznam všech stavů vyhodnocení zásad pro konkrétní žádost o přijetí změn.

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

Parametry

project

string

ID projektu nebo název projektu

artifactId

string

Řetězec, který jednoznačně identifikuje cíl vyhodnocení zásad.

includeNotApplicable

boolean

Některé zásady můžou určit, že se nevztahují na konkrétní žádost o přijetí změn. Když tento parametr nastavíte na true, vrátí se zkušební záznamy i pro zásady, které se na tuto žádost o přijetí změn nevztahují.

top

number

Počet záznamů vyhodnocení zásad, které se mají načíst.

skip

number

Počet záznamů vyhodnocení zásad, které se mají ignorovat. Pokud chcete například načíst výsledky 101–150, nastavte hodnotu 50 na 50 a přeskočte na 100.

Návraty

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

Načtěte konkrétní typ zásady podle ID.

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

Parametry

project

string

ID projektu nebo název projektu

typeId

string

ID zásady.

Návraty

Promise<PolicyType>

getPolicyTypes(string)

Načtěte všechny dostupné typy zásad.

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

Parametry

project

string

ID projektu nebo název projektu

Návraty

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

Znovu vyhodnocení zásad.

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

Parametry

project

string

ID projektu nebo název projektu

evaluationId

string

ID vyhodnocení zásad, které se má načíst.

Návraty

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

Aktualizujte konfiguraci zásad podle jeho ID.

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

Parametry

configuration

PolicyConfiguration

Konfigurace zásad, která se má aktualizovat.

project

string

ID projektu nebo název projektu

configurationId

number

ID stávající konfigurace zásad, která se má aktualizovat.

Návraty

Promise<PolicyConfiguration>