PolicyRestClient class
Basisklasse, die zum Senden von Anforderungen an VSS-REST-APIs verwendet werden soll (abgeleitet von).
- Extends
Konstruktoren
| Policy |
Eigenschaften
| RESOURCE_AREA_ID |
Methoden
| create |
Erstellen Sie eine Richtlinienkonfiguration eines bestimmten Richtlinientyps. |
| delete |
Löschen Sie eine Richtlinienkonfiguration anhand ihrer ID. |
| get |
Rufen Sie eine Richtlinienkonfiguration anhand ihrer ID ab. |
| get |
Rufen Sie eine bestimmte Überarbeitung einer bestimmten Richtlinie anhand der ID ab. |
| get |
Ruft alle Revisionen für eine bestimmte Richtlinie ab. |
| get |
Rufen Sie eine Liste der Richtlinienkonfigurationen in einem Projekt ab. |
| get |
Ruft den aktuellen Auswertungsstatus einer Richtlinie ab. |
| get |
Ruft eine Liste aller Richtlinienauswertungsstatus für einen bestimmten Pull Request ab. |
| get |
Ruft einen bestimmten Richtlinientyp nach ID ab. |
| get |
Ruft alle verfügbaren Richtlinientypen ab. |
| requeue |
Stellen Sie die Richtlinienauswertung erneut aus. |
| update |
Aktualisieren Sie eine Richtlinienkonfiguration anhand ihrer ID. |
Details zum Konstruktor
PolicyRestClient(IVssRestClientOptions)
Details zur Eigenschaft
RESOURCE_AREA_ID
static RESOURCE_AREA_ID: stringEigenschaftswert
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 Überarbeitung einer bestimmten Richtlinie anhand der 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 zu ignorierenden Revisionen. Um beispielsweise die Ergebnisse 101-150 abzurufen, legen Sie oben 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 Legacygründen bereitgestellt] Der Bereich, für den eine Teilmenge von Richtlinien definiert ist.
- policyType
-
string
Nur für diesen Typ zurückgegebene Richtlinien filtern
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 abzurufenden Richtlinienauswertung.
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 Richtlinienauswertung eindeutig identifiziert.
- includeNotApplicable
-
boolean
Einige Richtlinien können feststellen, dass sie nicht auf einen bestimmten Pull Request angewendet werden. Wenn Sie diesen Parameter auf true festlegen, werden Auswertungsdatensätze zurückgegeben, auch für Richtlinien, die nicht für diesen Pull Request gelten.
- top
-
number
Die Anzahl der abzurufenden Richtlinienauswertungsdatensätze.
- skip
-
number
Die Anzahl der zu ignorierenden Richtlinienauswertungsdatensätze. Um beispielsweise die Ergebnisse 101-150 abzurufen, legen Sie oben auf 50 fest, und fahren Sie mit 100 fort.
Gibt zurück
Promise<PolicyEvaluationRecord[]>
getPolicyType(string, string)
Ruft einen bestimmten Richtlinientyp nach ID ab.
function getPolicyType(project: string, typeId: string): Promise<PolicyType>Parameter
- project
-
string
Projekt-ID oder Projektname
- typeId
-
string
Die Richtlinien-ID.
Gibt zurück
Promise<PolicyType>
getPolicyTypes(string)
Ruft 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 aus.
function requeuePolicyEvaluation(project: string, evaluationId: string): Promise<PolicyEvaluationRecord>Parameter
- project
-
string
Projekt-ID oder Projektname
- evaluationId
-
string
ID der abzurufenden Richtlinienauswertung.
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>
Feedback
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unter https://aka.ms/ContentUserFeedback.
Feedback senden und anzeigen für