PolicyRestClient class

Paket:

azure-devops-extension-api

Kelas dasar yang harus digunakan (berasal dari) untuk membuat permintaan ke VSS REST api

Memperluas

RestClientBase

Konstruktor

PolicyRestClient(IVssRestClientOptions)

Properti

RESOURCE_AREA_ID

Metode

createPolicyConfiguration(PolicyConfiguration, string)	Buat konfigurasi kebijakan dari jenis kebijakan tertentu.
deletePolicyConfiguration(string, number)	Hapus konfigurasi kebijakan dengan ID-nya.
getPolicyConfiguration(string, number)	Dapatkan konfigurasi kebijakan dengan ID-nya.
getPolicyConfigurationRevision(string, number, number)	Ambil revisi tertentu dari kebijakan tertentu berdasarkan ID.
getPolicyConfigurationRevisions(string, number, number, number)	Ambil semua revisi untuk kebijakan tertentu.
getPolicyConfigurations(string, string, string)	Dapatkan daftar konfigurasi kebijakan dalam proyek.
getPolicyEvaluation(string, string)	Mendapatkan status evaluasi kebijakan saat ini.
getPolicyEvaluations(string, string, boolean, number, number)	Mengambil daftar semua status evaluasi kebijakan untuk permintaan pull tertentu.
getPolicyType(string, string)	Ambil jenis kebijakan tertentu menurut ID.
getPolicyTypes(string)	Ambil semua jenis kebijakan yang tersedia.
requeuePolicyEvaluation(string, string)	Antre kembali evaluasi kebijakan.
updatePolicyConfiguration(PolicyConfiguration, string, number)	Perbarui konfigurasi kebijakan dengan ID-nya.

Detail Konstruktor

PolicyRestClient(IVssRestClientOptions)

new PolicyRestClient(options: IVssRestClientOptions)

Parameter

options

IVssRestClientOptions

Detail Properti

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Nilai Properti

string

Detail Metode

createPolicyConfiguration(PolicyConfiguration, string)

Buat konfigurasi kebijakan dari jenis kebijakan tertentu.

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

Parameter

configuration

PolicyConfiguration

Konfigurasi kebijakan yang akan dibuat.

project

string

ID proyek atau nama proyek

Mengembalikan

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

Hapus konfigurasi kebijakan dengan ID-nya.

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

Parameter

project

string

ID proyek atau nama proyek

configurationId

number

ID konfigurasi kebijakan yang akan dihapus.

Mengembalikan

Promise<void>

getPolicyConfiguration(string, number)

Dapatkan konfigurasi kebijakan dengan ID-nya.

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

Parameter

project

string

ID proyek atau nama proyek

configurationId

number

ID konfigurasi kebijakan

Mengembalikan

Promise<PolicyConfiguration>

getPolicyConfigurationRevision(string, number, number)

Ambil revisi tertentu dari kebijakan tertentu berdasarkan ID.

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

Parameter

project

string

ID proyek atau nama proyek

configurationId

number

ID konfigurasi kebijakan.

revisionId

number

ID revisi.

Mengembalikan

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

Ambil semua revisi untuk kebijakan tertentu.

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

Parameter

project

string

ID proyek atau nama proyek

configurationId

number

ID konfigurasi kebijakan.

top

number

Jumlah revisi yang akan diambil.

skip

number

Jumlah revisi yang akan diabaikan. Misalnya, untuk mengambil hasil 101-150, atur ke atas ke 50 dan lewati ke 100.

Mengembalikan

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

Dapatkan daftar konfigurasi kebijakan dalam proyek.

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

Parameter

project

string

ID proyek atau nama proyek

scope

string

[Disediakan untuk alasan warisan] Cakupan di mana subset kebijakan ditentukan.

policyType

string

Filter kebijakan yang dikembalikan hanya untuk jenis ini

Mengembalikan

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

Mendapatkan status evaluasi kebijakan saat ini.

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

Parameter

project

string

ID proyek atau nama proyek

evaluationId

string

ID evaluasi kebijakan yang akan diambil.

Mengembalikan

Promise<PolicyEvaluationRecord>

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

Mengambil daftar semua status evaluasi kebijakan untuk permintaan pull tertentu.

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

Parameter

project

string

ID proyek atau nama proyek

artifactId

string

String yang secara unik mengidentifikasi target evaluasi kebijakan.

includeNotApplicable

boolean

Beberapa kebijakan mungkin menentukan bahwa kebijakan tersebut tidak berlaku untuk permintaan pull tertentu. Mengatur parameter ini ke true akan mengembalikan rekaman evaluasi bahkan untuk kebijakan yang tidak berlaku untuk permintaan pull ini.

top

number

Jumlah rekaman evaluasi kebijakan yang akan diambil.

skip

number

Jumlah catatan evaluasi kebijakan yang akan diabaikan. Misalnya, untuk mengambil hasil 101-150, atur ke atas ke 50 dan lewati ke 100.

Mengembalikan

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

Ambil jenis kebijakan tertentu menurut ID.

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

Parameter

project

string

ID proyek atau nama proyek

typeId

string

ID kebijakan.

Mengembalikan

Promise<PolicyType>

getPolicyTypes(string)

Ambil semua jenis kebijakan yang tersedia.

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

Parameter

project

string

ID proyek atau nama proyek

Mengembalikan

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

Antre kembali evaluasi kebijakan.

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

Parameter

project

string

ID proyek atau nama proyek

evaluationId

string

ID evaluasi kebijakan yang akan diambil.

Mengembalikan

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

Perbarui konfigurasi kebijakan dengan ID-nya.

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

Parameter

configuration

PolicyConfiguration

Konfigurasi kebijakan untuk diperbarui.

project

string

ID proyek atau nama proyek

configurationId

number

ID konfigurasi kebijakan yang ada untuk diperbarui.

Mengembalikan

Promise<PolicyConfiguration>