PolicyRestClient class

Pakiet:

azure-devops-extension-api

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

Rozszerzenie

RestClientBase

Konstruktory

PolicyRestClient(IVssRestClientOptions)

Właściwości

RESOURCE_AREA_ID

Metody

createPolicyConfiguration(PolicyConfiguration, string)	Utwórz konfigurację zasad dla danego typu zasad.
deletePolicyConfiguration(string, number)	Usuń konfigurację zasady według jej identyfikatora.
getPolicyConfiguration(string, number)	Pobierz konfigurację zasad według jej identyfikatora.
getPolicyConfigurationRevision(string, number, number)	Pobieranie określonej wersji danej zasady według identyfikatora.
getPolicyConfigurationRevisions(string, number, number, number)	Pobieranie wszystkich poprawek dla danej zasady.
getPolicyConfigurations(string, string, string)	Pobierz listę konfiguracji zasad w projekcie.
getPolicyEvaluation(string, string)	Pobiera bieżący 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)	Pobieranie określonego typu zasad według identyfikatora.
getPolicyTypes(string)	Pobierz wszystkie dostępne typy zasad.
requeuePolicyEvaluation(string, string)	Ponownie umieść ocenę zasad w kolejce.
updatePolicyConfiguration(PolicyConfiguration, string, number)	Zaktualizuj konfigurację zasad według jej 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 dla 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ę zasady według jej 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 jej 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)

Pobieranie określonej wersji danej zasady 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 wersji.

Zwraca

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

Pobieranie wszystkich poprawek 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. Na przykład aby 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

[Dostarczone ze względu na dziedzictwo] Zakres, w którym zdefiniowano podzbiór zasad.

policyType

string

Filtruj zwrócone zasady tylko do tego typu

Zwraca

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

Pobiera bieżący stan oceny zasad.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

evaluationId

string

Identyfikator oceny zasad, która ma zostać pobrana.

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 znaków, który jednoznacznie identyfikuje cel 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 w przypadku 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, które mają zostać zignorowane. Na przykład aby pobrać wyniki 101-150, ustaw wartość 50 pierwszych i przejdź do wartości 100.

Zwraca

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

Pobieranie określonego typu zasad według identyfikatora.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

typeId

string

Identyfikator polityki.

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)

Ponownie umieść ocenę zasad w kolejce.

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

Parametry

project

string

Identyfikator projektu lub nazwa projektu

evaluationId

string

Identyfikator oceny zasad, która ma zostać pobrana.

Zwraca

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

Zaktualizuj konfigurację zasad według jej 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, która ma zostać zaktualizowana.

Zwraca

Promise<PolicyConfiguration>