PolicyRestClient class

Paket:

azure-devops-extension-api

Basisklasse, die verwendet werden soll (abgeleitet von), um Anforderungen an VSS-REST-APIs zu stellen

Extends

RestClientBase

Konstruktoren

PolicyRestClient(IVssRestClientOptions)

Eigenschaften

RESOURCE_AREA_ID

Methoden

createPolicyConfiguration(PolicyConfiguration, string)	Erstellen Sie eine Richtlinienkonfiguration eines bestimmten Richtlinientyps.
deletePolicyConfiguration(string, number)	Löschen Sie eine Richtlinienkonfiguration anhand ihrer ID.
getPolicyConfiguration(string, number)	Rufen Sie eine Richtlinienkonfiguration anhand ihrer ID ab.
getPolicyConfigurationRevision(string, number, number)	Rufen Sie eine bestimmte Revision einer bestimmten Richtlinie nach ID ab.
getPolicyConfigurationRevisions(string, number, number, number)	Ruft alle Revisionen für eine bestimmte Richtlinie ab.
getPolicyConfigurations(string, string, string)	Rufen Sie eine Liste der Richtlinienkonfigurationen in einem Projekt ab.
getPolicyEvaluation(string, string)	Ruft den aktuellen Auswertungsstatus einer Richtlinie ab.
getPolicyEvaluations(string, string, boolean, number, number)	Ruft eine Liste aller Richtlinienauswertungsstatus für einen bestimmten Pull Request ab.
getPolicyType(string, string)	Rufen Sie einen bestimmten Richtlinientyp anhand der ID ab.
getPolicyTypes(string)	Rufen Sie alle verfügbaren Richtlinientypen ab.
requeuePolicyEvaluation(string, string)	Stellen Sie die Richtlinienauswertung erneut in die Warteschlange.
updatePolicyConfiguration(PolicyConfiguration, string, number)	Aktualisieren Sie eine Richtlinienkonfiguration anhand ihrer ID.

Details zum Konstruktor

PolicyRestClient(IVssRestClientOptions)

new PolicyRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Details zur Eigenschaft

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Eigenschaftswert

string

Details zur Methode

createPolicyConfiguration(PolicyConfiguration, string)

Erstellen Sie eine Richtlinienkonfiguration eines bestimmten Richtlinientyps.

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

Parameter

configuration

PolicyConfiguration

Die zu erstellende Richtlinienkonfiguration.

project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

Löschen Sie eine Richtlinienkonfiguration anhand ihrer ID.

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

Parameter

project

string

Projekt-ID oder Projektname

configurationId

number

ID der zu löschenden Richtlinienkonfiguration.

Gibt zurück

Promise<void>

getPolicyConfiguration(string, number)

Rufen Sie eine Richtlinienkonfiguration anhand ihrer ID ab.

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

Parameter

project

string

Projekt-ID oder Projektname

configurationId

number

ID der Richtlinienkonfiguration

Gibt zurück

Promise<PolicyConfiguration>

getPolicyConfigurationRevision(string, number, number)

Rufen Sie eine bestimmte Revision einer bestimmten Richtlinie nach ID ab.

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

Parameter

project

string

Projekt-ID oder Projektname

configurationId

number

Die Richtlinienkonfigurations-ID.

revisionId

number

Die Revisions-ID.

Gibt zurück

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

Ruft alle Revisionen für eine bestimmte Richtlinie ab.

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

Parameter

project

string

Projekt-ID oder Projektname

configurationId

number

Die Richtlinienkonfigurations-ID.

top

number

Die Anzahl der abzurufenden Revisionen.

skip

number

Die Anzahl der Revisionen, die ignoriert werden sollen. Wenn Sie z. B. Ergebnisse 101-150 abrufen möchten, legen Sie den Oberen auf 50 fest, und fahren Sie mit 100 fort.

Gibt zurück

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

Rufen Sie eine Liste der Richtlinienkonfigurationen in einem Projekt ab.

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

Parameter

project

string

Projekt-ID oder Projektname

scope

string

[Aus Gründen des Vermächtnisses zur Verfügung gestellt] Der Bereich, für den eine Teilmenge von Richtlinien definiert ist.

policyType

string

Filtern zurückgegebener Richtlinien nur auf diesen Typ

Gibt zurück

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

Ruft den aktuellen Auswertungsstatus einer Richtlinie ab.

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

Parameter

project

string

Projekt-ID oder Projektname

evaluationId

string

ID der Richtlinienauswertung, die abgerufen werden soll.

Gibt zurück

Promise<PolicyEvaluationRecord>

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

Ruft eine Liste aller Richtlinienauswertungsstatus für einen bestimmten Pull Request ab.

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

Parameter

project

string

Projekt-ID oder Projektname

artifactId

string

Eine Zeichenfolge, die das Ziel einer Richtlinienbewertung eindeutig identifiziert.

includeNotApplicable

boolean

Einige Richtlinien stellen möglicherweise fest, dass sie nicht für einen bestimmten Pull Request gelten. Wenn Sie diesen Parameter auf true festlegen, werden Auswertungsdatensätze auch für Richtlinien zurückgegeben, die nicht für diesen Pull Request gelten.

top

number

Die Anzahl der abzurufenden Richtlinienauswertungsdatensätze.

skip

number

Die Anzahl der Richtlinienauswertungsdatensätze, die ignoriert werden sollen. Wenn Sie z. B. Ergebnisse 101-150 abrufen möchten, legen Sie den Oberen auf 50 fest, und fahren Sie mit 100 fort.

Gibt zurück

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

Rufen Sie einen bestimmten Richtlinientyp anhand der ID ab.

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

Parameter

project

string

Projekt-ID oder Projektname

typeId

string

Richtlinien-ID.

Gibt zurück

Promise<PolicyType>

getPolicyTypes(string)

Rufen Sie alle verfügbaren Richtlinientypen ab.

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

Parameter

project

string

Projekt-ID oder Projektname

Gibt zurück

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

Stellen Sie die Richtlinienauswertung erneut in die Warteschlange.

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

Parameter

project

string

Projekt-ID oder Projektname

evaluationId

string

ID der Richtlinienauswertung, die abgerufen werden soll.

Gibt zurück

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

Aktualisieren Sie eine Richtlinienkonfiguration anhand ihrer ID.

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

Parameter

configuration

PolicyConfiguration

Die zu aktualisierende Richtlinienkonfiguration.

project

string

Projekt-ID oder Projektname

configurationId

number

ID der vorhandenen Richtlinienkonfiguration, die aktualisiert werden soll.

Gibt zurück

Promise<PolicyConfiguration>