PolicyRestClient class

Пакет:

azure-devops-extension-api

Базовый класс, который должен использоваться (производный от) для выполнения запросов к REST API VSS

Extends

RestClientBase

Конструкторы

PolicyRestClient(IVssRestClientOptions)

Свойства

RESOURCE_AREA_ID

Методы

createPolicyConfiguration(PolicyConfiguration, string)	Создайте конфигурацию политики заданного типа.
deletePolicyConfiguration(string, number)	Удалите конфигурацию политики по ее идентификатору.
getPolicyConfiguration(string, number)	Получите конфигурацию политики по ее идентификатору.
getPolicyConfigurationRevision(string, number, number)	Получение конкретной редакции данной политики по идентификатору.
getPolicyConfigurationRevisions(string, number, number, number)	Получение всех редакций для данной политики.
getPolicyConfigurations(string, string, string)	Получение списка конфигураций политик в проекте.
getPolicyEvaluation(string, string)	Получает текущую оценку состояния политики.
getPolicyEvaluations(string, string, boolean, number, number)	Извлекает список всех состояний оценки политики для конкретного запроса на вытягивание.
getPolicyType(string, string)	Получение определенного типа политики по идентификатору.
getPolicyTypes(string)	Получите все доступные типы политик.
requeuePolicyEvaluation(string, string)	Повторите постановку оценки политики в очередь.
updatePolicyConfiguration(PolicyConfiguration, string, number)	Обновите конфигурацию политики по ее идентификатору.

Сведения о конструкторе

PolicyRestClient(IVssRestClientOptions)

new PolicyRestClient(options: IVssRestClientOptions)

Параметры

options

IVssRestClientOptions

Сведения о свойстве

RESOURCE_AREA_ID

static RESOURCE_AREA_ID: string

Значение свойства

string

Сведения о методе

createPolicyConfiguration(PolicyConfiguration, string)

Создайте конфигурацию политики заданного типа.

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

Параметры

configuration

PolicyConfiguration

Создаваемая конфигурация политики.

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

Удалите конфигурацию политики по ее идентификатору.

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

Параметры

project

string

Идентификатор проекта или имя проекта

configurationId

number

Идентификатор удаляемой конфигурации политики.

Возвращаемое значение

Promise<void>

getPolicyConfiguration(string, number)

Получите конфигурацию политики по ее идентификатору.

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

Параметры

project

string

Идентификатор проекта или имя проекта

configurationId

number

Идентификатор конфигурации политики

Возвращаемое значение

Promise<PolicyConfiguration>

getPolicyConfigurationRevision(string, number, number)

Получение конкретной редакции данной политики по идентификатору.

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

Параметры

project

string

Идентификатор проекта или имя проекта

configurationId

number

Идентификатор конфигурации политики.

revisionId

number

Идентификатор редакции.

Возвращаемое значение

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

Получение всех редакций для данной политики.

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

Параметры

project

string

Идентификатор проекта или имя проекта

configurationId

number

Идентификатор конфигурации политики.

top

number

Количество ревизий для извлечения.

skip

number

Количество редакций, которые следует игнорировать. Например, чтобы получить результаты 101-150, установите верхний 50 и перейдите к 100.

Возвращаемое значение

Promise<PolicyConfiguration[]>

getPolicyConfigurations(string, string, string)

Получение списка конфигураций политик в проекте.

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

Параметры

project

string

Идентификатор проекта или имя проекта

scope

string

[Предоставлено по причинам устаревания] Область, в которой определяется подмножество политик.

policyType

string

Фильтрация возвращаемых политик только по этому типу

Возвращаемое значение

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

Получает текущую оценку состояния политики.

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

Параметры

project

string

Идентификатор проекта или имя проекта

evaluationId

string

Идентификатор оценки политики, которую необходимо получить.

Возвращаемое значение

Promise<PolicyEvaluationRecord>

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

Извлекает список всех состояний оценки политики для конкретного запроса на вытягивание.

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

Параметры

project

string

Идентификатор проекта или имя проекта

artifactId

string

Строка, которая однозначно идентифицирует цель оценки политики.

includeNotApplicable

boolean

Некоторые политики могут определять, что они не применяются к конкретному запросу на вытягивание. Если задать для этого параметра значение true, будут возвращены записи оценки даже для политик, которые не применяются к этому запросу на вытягивание.

top

number

Количество записей об оценке политики для извлечения.

skip

number

Количество записей об оценке политики, которые следует игнорировать. Например, чтобы получить результаты 101-150, установите верхний 50 и перейдите к 100.

Возвращаемое значение

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

Получение определенного типа политики по идентификатору.

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

Параметры

project

string

Идентификатор проекта или имя проекта

typeId

string

Идентификатор политики.

Возвращаемое значение

Promise<PolicyType>

getPolicyTypes(string)

Получите все доступные типы политик.

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

Параметры

project

string

Идентификатор проекта или имя проекта

Возвращаемое значение

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

Повторите постановку оценки политики в очередь.

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

Параметры

project

string

Идентификатор проекта или имя проекта

evaluationId

string

Идентификатор оценки политики, которую необходимо получить.

Возвращаемое значение

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

Обновите конфигурацию политики по ее идентификатору.

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

Параметры

configuration

PolicyConfiguration

Конфигурация политики для обновления.

project

string

Идентификатор проекта или имя проекта

configurationId

number

Идентификатор существующей конфигурации политики, которую необходимо обновить.

Возвращаемое значение

Promise<PolicyConfiguration>