PolicyRestClient class

Pakiet:

azure-devops-extension-api

Klasa podstawowa, która powinna być używana (pochodna) do tworzenia żądań do interfejsów API REST usługi VSS

Extends

RestClientBase

Konstruktory

PolicyRestClient(IVssRestClientOptions)

Właściwości

RESOURCE_AREA_ID

Metody

createPolicyConfiguration(PolicyConfiguration, string)	Utwórz konfigurację zasad danego typu zasad.
deletePolicyConfiguration(string, number)	Usuń konfigurację zasad według jego identyfikatora.
getPolicyConfiguration(string, number)	Pobierz konfigurację zasad według jego identyfikatora.
getPolicyConfigurationRevision(string, number, number)	Pobierz określoną poprawkę określonych zasad według identyfikatora.
getPolicyConfigurationRevisions(string, number, number, number)	Pobierz wszystkie poprawki dla danej zasady.
getPolicyConfigurations(string, string, string)	Pobierz listę konfiguracji zasad w projekcie.
getPolicyEvaluation(string, string)	Pobiera obecny stan oceny zasad.
getPolicyEvaluations(string, string, boolean, number, number)	Pobiera listę wszystkich stanów oceny zasad dla określonego żądania ściągnięcia.
getPolicyType(string, string)	Pobierz określony typ zasad według identyfikatora.
getPolicyTypes(string)	Pobierz wszystkie dostępne typy zasad.
requeuePolicyEvaluation(string, string)	Ponowne kolejki oceny zasad.
updatePolicyConfiguration(PolicyConfiguration, string, number)	Zaktualizuj konfigurację zasad według jego identyfikatora.

Szczegóły konstruktora

PolicyRestClient(IVssRestClientOptions)

new PolicyRestClient(options: IVssRestClientOptions)

Parametry

options

IVssRestClientOptions

Szczegóły właściwości

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Wartość właściwości

string

Szczegóły metody

createPolicyConfiguration(PolicyConfiguration, string)

Utwórz konfigurację zasad danego typu zasad.

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

Parametry

configuration

PolicyConfiguration

Konfiguracja zasad do utworzenia.

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

Usuń konfigurację zasad według jego identyfikatora.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

configurationId

number

Identyfikator konfiguracji zasad do usunięcia.

Zwraca

Promise<void>

getPolicyConfiguration(string, number)

Pobierz konfigurację zasad według jego identyfikatora.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

configurationId

number

Identyfikator konfiguracji zasad

Zwraca

Promise<PolicyConfiguration>

getPolicyConfigurationRevision(string, number, number)

Pobierz określoną poprawkę określonych zasad według identyfikatora.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

configurationId

number

Identyfikator konfiguracji zasad.

revisionId

number

Identyfikator poprawki.

Zwraca

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

Pobierz wszystkie poprawki dla danej zasady.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

configurationId

number

Identyfikator konfiguracji zasad.

top

number

Liczba poprawek do pobrania.

skip

number

Liczba poprawek do zignorowania. Aby na przykład pobrać wyniki 101-150, ustaw wartość 50 pierwszych i przejdź do wartości 100.

Zwraca

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

Pobierz listę konfiguracji zasad w projekcie.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

scope

string

[Podane ze starszych powodów] Zakres, w którym zdefiniowano podzbiór zasad.

policyType

string

Filtr zwrócił zasady tylko do tego typu

Zwraca

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

Pobiera obecny stan oceny zasad.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

evaluationId

string

Identyfikator oceny zasad do pobrania.

Zwraca

Promise<PolicyEvaluationRecord>

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

Pobiera listę wszystkich stanów oceny zasad dla określonego żądania ściągnięcia.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

artifactId

string

Ciąg, który jednoznacznie identyfikuje element docelowy oceny zasad.

includeNotApplicable

boolean

Niektóre zasady mogą określać, że nie mają zastosowania do określonego żądania ściągnięcia. Ustawienie tego parametru na wartość true spowoduje zwrócenie rekordów oceny nawet dla zasad, które nie mają zastosowania do tego żądania ściągnięcia.

top

number

Liczba rekordów oceny zasad do pobrania.

skip

number

Liczba rekordów oceny zasad do zignorowania. Aby na przykład pobrać wyniki 101-150, ustaw wartość 50 pierwszych i przejdź do wartości 100.

Zwraca

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

Pobierz określony typ zasad według identyfikatora.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

typeId

string

Identyfikator zasad.

Zwraca

Promise<PolicyType>

getPolicyTypes(string)

Pobierz wszystkie dostępne typy zasad.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

Zwraca

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

Ponowne kolejki oceny zasad.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

evaluationId

string

Identyfikator oceny zasad do pobrania.

Zwraca

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

Zaktualizuj konfigurację zasad według jego identyfikatora.

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

Parametry

configuration

PolicyConfiguration

Konfiguracja zasad do zaktualizowania.

project

string

Identyfikator projektu lub nazwa projektu

configurationId

number

Identyfikator istniejącej konfiguracji zasad do zaktualizowania.

Zwraca

Promise<PolicyConfiguration>