PolicyRestClient class

Pakket:

azure-devops-extension-api

Basisklasse die moet worden gebruikt (afgeleid van) om aanvragen te doen voor VSS REST API's

Extends

RestClientBase

Constructors

PolicyRestClient(IVssRestClientOptions)

Eigenschappen

RESOURCE_AREA_ID

Methoden

createPolicyConfiguration(PolicyConfiguration, string)	Maak een beleidsconfiguratie van een bepaald beleidstype.
deletePolicyConfiguration(string, number)	Verwijder een beleidsconfiguratie op basis van de id.
getPolicyConfiguration(string, number)	Haal een beleidsconfiguratie op op basis van de id.
getPolicyConfigurationRevision(string, number, number)	Een specifieke revisie van een bepaald beleid ophalen op id.
getPolicyConfigurationRevisions(string, number, number, number)	Alle revisies voor een bepaald beleid ophalen.
getPolicyConfigurations(string, string, string)	Een lijst met beleidsconfiguraties in een project ophalen.
getPolicyEvaluation(string, string)	Hiermee haalt u de huidige evaluatiestatus van een beleid op.
getPolicyEvaluations(string, string, boolean, number, number)	Hiermee haalt u een lijst op met alle beleidsevaluatiestatussen voor een specifieke pull-aanvraag.
getPolicyType(string, string)	Een specifiek beleidstype ophalen op id.
getPolicyTypes(string)	Alle beschikbare beleidstypen ophalen.
requeuePolicyEvaluation(string, string)	De beleidsevaluatie opnieuw in de wachtrij plaatsen.
updatePolicyConfiguration(PolicyConfiguration, string, number)	Een beleidsconfiguratie bijwerken op basis van de bijbehorende id.

Constructordetails

PolicyRestClient(IVssRestClientOptions)

new PolicyRestClient(options: IVssRestClientOptions)

Parameters

options

IVssRestClientOptions

Eigenschapdetails

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Waarde van eigenschap

string

Methodedetails

createPolicyConfiguration(PolicyConfiguration, string)

Maak een beleidsconfiguratie van een bepaald beleidstype.

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

Parameters

configuration

PolicyConfiguration

De beleidsconfiguratie die moet worden gemaakt.

project

string

Project-id of projectnaam

Retouren

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

Verwijder een beleidsconfiguratie op basis van de id.

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

Parameters

project

string

Project-id of projectnaam

configurationId

number

Id van de beleidsconfiguratie die moet worden verwijderd.

Retouren

Promise<void>

getPolicyConfiguration(string, number)

Haal een beleidsconfiguratie op op basis van de id.

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

Parameters

project

string

Project-id of projectnaam

configurationId

number

Id van de beleidsconfiguratie

Retouren

Promise<PolicyConfiguration>

getPolicyConfigurationRevision(string, number, number)

Een specifieke revisie van een bepaald beleid ophalen op id.

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

Parameters

project

string

Project-id of projectnaam

configurationId

number

De configuratie-id van het beleid.

revisionId

number

De revisie-id.

Retouren

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

Alle revisies voor een bepaald beleid ophalen.

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

Parameters

project

string

Project-id of projectnaam

configurationId

number

De configuratie-id van het beleid.

top

number

Het aantal revisies dat moet worden opgehaald.

skip

number

Het aantal revisies dat moet worden genegeerd. Als u bijvoorbeeld resultaten 101-150 wilt ophalen, stelt u top in op 50 en gaat u naar 100.

Retouren

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

Een lijst met beleidsconfiguraties in een project ophalen.

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

Parameters

project

string

Project-id of projectnaam

scope

string

[Opgegeven om verouderde redenen] Het bereik waarvoor een subset van beleidsregels wordt gedefinieerd.

policyType

string

Geretourneerde beleidsregels filteren op alleen dit type

Retouren

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

Hiermee haalt u de huidige evaluatiestatus van een beleid op.

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

Parameters

project

string

Project-id of projectnaam

evaluationId

string

Id van de beleidsevaluatie die moet worden opgehaald.

Retouren

Promise<PolicyEvaluationRecord>

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

Hiermee haalt u een lijst op met alle beleidsevaluatiestatussen voor een specifieke pull-aanvraag.

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

Parameters

project

string

Project-id of projectnaam

artifactId

string

Een tekenreeks die het doel van een beleidsevaluatie uniek aangeeft.

includeNotApplicable

boolean

Sommige beleidsregels bepalen mogelijk dat ze niet van toepassing zijn op een specifieke pull-aanvraag. Als u deze parameter instelt op true, worden evaluatierecords geretourneerd, zelfs voor beleidsregels die niet van toepassing zijn op deze pull-aanvraag.

top

number

Het aantal beleidsevaluatierecords dat moet worden opgehaald.

skip

number

Het aantal beleidsevaluatierecords dat moet worden genegeerd. Als u bijvoorbeeld resultaten 101-150 wilt ophalen, stelt u top in op 50 en gaat u naar 100.

Retouren

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

Een specifiek beleidstype ophalen op id.

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

Parameters

project

string

Project-id of projectnaam

typeId

string

De beleids-id.

Retouren

Promise<PolicyType>

getPolicyTypes(string)

Alle beschikbare beleidstypen ophalen.

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

Parameters

project

string

Project-id of projectnaam

Retouren

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

De beleidsevaluatie opnieuw in de wachtrij plaatsen.

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

Parameters

project

string

Project-id of projectnaam

evaluationId

string

Id van de beleidsevaluatie die moet worden opgehaald.

Retouren

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

Een beleidsconfiguratie bijwerken op basis van de bijbehorende id.

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

Parameters

configuration

PolicyConfiguration

De bij te werken beleidsconfiguratie.

project

string

Project-id of projectnaam

configurationId

number

Id van de bestaande beleidsconfiguratie die moet worden bijgewerkt.

Retouren

Promise<PolicyConfiguration>