PolicyRestClient class

패키지:

azure-devops-extension-api

VSS REST API에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.

Extends

RestClientBase

생성자

PolicyRestClient(IVssRestClientOptions)

속성

RESOURCE_AREA_ID

메서드

createPolicyConfiguration(PolicyConfiguration, string)	지정된 정책 유형의 정책 구성을 만듭니다.
deletePolicyConfiguration(string, number)	ID로 정책 구성을 삭제합니다.
getPolicyConfiguration(string, number)	ID로 정책 구성을 가져옵니다.
getPolicyConfigurationRevision(string, number, number)	ID별로 지정된 정책의 특정 수정 버전을 검색합니다.
getPolicyConfigurationRevisions(string, number, number, number)	지정된 정책에 대한 모든 수정 버전을 검색합니다.
getPolicyConfigurations(string, string, string)	프로젝트의 정책 구성 목록을 가져옵니다.
getPolicyEvaluation(string, string)	정책의 현재 평가 상태를 가져옵니다.
getPolicyEvaluations(string, string, boolean, number, number)	특정 끌어오기 요청에 대한 모든 정책 평가 상태 목록을 검색합니다.
getPolicyType(string, string)	ID별로 특정 정책 유형을 검색합니다.
getPolicyTypes(string)	사용 가능한 모든 정책 유형을 검색합니다.
requeuePolicyEvaluation(string, string)	정책 평가를 다시 큐에 추가합니다.
updatePolicyConfiguration(PolicyConfiguration, string, number)	ID로 정책 구성을 업데이트합니다.

생성자 세부 정보

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

프로젝트 ID 또는 프로젝트 이름

반환

Promise<PolicyConfiguration>

deletePolicyConfiguration(string, number)

ID로 정책 구성을 삭제합니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

configurationId

number

삭제할 정책 구성의 ID입니다.

반환

Promise<void>

getPolicyConfiguration(string, number)

ID로 정책 구성을 가져옵니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

configurationId

number

정책 구성의 ID

반환

Promise<PolicyConfiguration>

getPolicyConfigurationRevision(string, number, number)

ID별로 지정된 정책의 특정 수정 버전을 검색합니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

configurationId

number

정책 구성 ID입니다.

revisionId

number

수정 ID입니다.

반환

Promise<PolicyConfiguration>

getPolicyConfigurationRevisions(string, number, number, number)

지정된 정책에 대한 모든 수정 버전을 검색합니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

configurationId

number

정책 구성 ID입니다.

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

프로젝트 ID 또는 프로젝트 이름

scope

string

[레거시 이유로 제공됨] 정책의 하위 집합이 정의된 scope.

policyType

string

반환된 정책을 이 형식으로만 필터링

반환

Promise<PagedList<PolicyConfiguration>>

getPolicyEvaluation(string, string)

정책의 현재 평가 상태를 가져옵니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

evaluationId

string

검색할 정책 평가의 ID입니다.

반환

Promise<PolicyEvaluationRecord>

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

특정 끌어오기 요청에 대한 모든 정책 평가 상태 목록을 검색합니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

artifactId

string

정책 평가의 대상을 고유하게 식별하는 문자열입니다.

includeNotApplicable

boolean

일부 정책은 특정 끌어오기 요청에 적용되지 않는다고 결정할 수 있습니다. 이 매개 변수를 true로 설정하면 이 끌어오기 요청에 적용되지 않는 정책에 대해서도 평가 레코드가 반환됩니다.

top

number

검색할 정책 평가 레코드의 수입니다.

skip

number

무시할 정책 평가 레코드의 수입니다. 예를 들어 결과 101-150을 검색하려면 위쪽을 50으로 설정하고 100으로 건너뜁니다.

반환

Promise<PolicyEvaluationRecord[]>

getPolicyType(string, string)

ID별로 특정 정책 유형을 검색합니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

typeId

string

정책 ID입니다.

반환

Promise<PolicyType>

getPolicyTypes(string)

사용 가능한 모든 정책 유형을 검색합니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

반환

Promise<PolicyType[]>

requeuePolicyEvaluation(string, string)

정책 평가를 다시 큐에 추가합니다.

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

매개 변수

project

string

프로젝트 ID 또는 프로젝트 이름

evaluationId

string

검색할 정책 평가의 ID입니다.

반환

Promise<PolicyEvaluationRecord>

updatePolicyConfiguration(PolicyConfiguration, string, number)

ID로 정책 구성을 업데이트합니다.

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

매개 변수

configuration

PolicyConfiguration

업데이트할 정책 구성입니다.

project

string

프로젝트 ID 또는 프로젝트 이름

configurationId

number

업데이트할 기존 정책 구성의 ID입니다.

반환

Promise<PolicyConfiguration>