PolicyRestClient class

Paket:

azure-devops-extension-api

Basklass som ska användas (härleds från) för att göra begäranden till VSS REST API:er

Extends

RestClientBase

Konstruktorer

PolicyRestClient(IVssRestClientOptions)

Egenskaper

RESOURCE_AREA_ID

Metoder

createPolicyConfiguration(PolicyConfiguration, string)	Skapa en principkonfiguration av en viss principtyp.
deletePolicyConfiguration(string, number)	Ta bort en principkonfiguration med dess ID.
getPolicyConfiguration(string, number)	Hämta en principkonfiguration med dess ID.
getPolicyConfigurationRevision(string, number, number)	Hämta en specifik revision av en viss princip efter ID.
getPolicyConfigurationRevisions(string, number, number, number)	Hämta alla revisioner för en viss princip.
getPolicyConfigurations(string, string, string)	Hämta en lista över principkonfigurationer i ett projekt.
getPolicyEvaluation(string, string)	Hämtar det aktuella utvärderingstillståndet för en princip.
getPolicyEvaluations(string, string, boolean, number, number)	Hämtar en lista över alla statusar för principutvärdering för en specifik pull-begäran.
getPolicyType(string, string)	Hämta en specifik principtyp efter ID.
getPolicyTypes(string)	Hämta alla tillgängliga principtyper.
requeuePolicyEvaluation(string, string)	Skicka principutvärderingen på nytt.
updatePolicyConfiguration(PolicyConfiguration, string, number)	Uppdatera en principkonfiguration med dess ID.

Konstruktorinformation

PolicyRestClient(IVssRestClientOptions)

new PolicyRestClient(options: IVssRestClientOptions)

Parametrar

options

IVssRestClientOptions

Egenskapsinformation

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Egenskapsvärde

string

Metodinformation

createPolicyConfiguration(PolicyConfiguration, string)

Skapa en principkonfiguration av en viss principtyp.

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

Parametrar

configuration

PolicyConfiguration

Den principkonfiguration som ska skapas.

project

string

Projekt-ID eller projektnamn

Returer

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

Ta bort en principkonfiguration med dess ID.

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

Parametrar

project

string

Projekt-ID eller projektnamn

configurationId

number

ID för principkonfigurationen som ska tas bort.

Returer

Promise<void>

getPolicyConfiguration(string, number)

Hämta en principkonfiguration med dess ID.

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

Parametrar

project

string

Projekt-ID eller projektnamn

configurationId

number

ID för principkonfigurationen

Returer

Promise<PolicyConfiguration>

getPolicyConfigurationRevision(string, number, number)

Hämta en specifik revision av en viss princip efter ID.

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

Parametrar

project

string

Projekt-ID eller projektnamn

configurationId

number

Principkonfigurations-ID: t.

revisionId

number

Revisions-ID: t.

Returer

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

Hämta alla revisioner för en viss princip.

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

Parametrar

project

string

Projekt-ID eller projektnamn

configurationId

number

Principkonfigurations-ID: t.

top

number

Antalet revisioner som ska hämtas.

skip

number

Antalet revisioner som ska ignoreras. Om du till exempel vill hämta resultat 101–150 anger du topp till 50 och hoppar till 100.

Returer

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

Hämta en lista över principkonfigurationer i ett projekt.

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

Parametrar

project

string

Projekt-ID eller projektnamn

scope

string

[Tillhandahålls av äldre skäl] Det omfång som en delmängd av principer definieras för.

policyType

string

Filtrera returnerade principer till endast den här typen

Returer

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

Hämtar det aktuella utvärderingstillståndet för en princip.

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

Parametrar

project

string

Projekt-ID eller projektnamn

evaluationId

string

ID för den principutvärdering som ska hämtas.

Returer

Promise<PolicyEvaluationRecord>

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

Hämtar en lista över alla statusar för principutvärdering för en specifik pull-begäran.

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

Parametrar

project

string

Projekt-ID eller projektnamn

artifactId

string

En sträng som unikt identifierar målet för en principutvärdering.

includeNotApplicable

boolean

Vissa principer kan avgöra att de inte gäller för en specifik pull-begäran. Om den här parametern anges till true returneras utvärderingsposter även för principer som inte gäller för den här pull-begäran.

top

number

Antalet principutvärderingsposter som ska hämtas.

skip

number

Antalet principutvärderingsposter som ska ignoreras. Om du till exempel vill hämta resultat 101–150 anger du topp till 50 och hoppar till 100.

Returer

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

Hämta en specifik principtyp efter ID.

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

Parametrar

project

string

Projekt-ID eller projektnamn

typeId

string

Princip-ID:t.

Returer

Promise<PolicyType>

getPolicyTypes(string)

Hämta alla tillgängliga principtyper.

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

Parametrar

project

string

Projekt-ID eller projektnamn

Returer

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

Skicka principutvärderingen på nytt.

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

Parametrar

project

string

Projekt-ID eller projektnamn

evaluationId

string

ID för den principutvärdering som ska hämtas.

Returer

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

Uppdatera en principkonfiguration med dess ID.

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

Parametrar

configuration

PolicyConfiguration

Principkonfigurationen som ska uppdateras.

project

string

Projekt-ID eller projektnamn

configurationId

number

ID för den befintliga principkonfigurationen som ska uppdateras.

Returer

Promise<PolicyConfiguration>