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>