ReportingRestClient class
VSS REST api에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.
- Extends
메서드
| create |
조직을 위한 새로운 고급 필터를 생성합니다. |
| delete |
고급 필터를 삭제합니다. |
| get |
ID에 따라 특정 고급 필터를 받습니다. |
| get |
조직에 대한 심각도별 경고 요약 가져오기 |
| get |
조직에 대한 결합된 경고 가져오기 |
| get |
조직의 모든 구별되는 의존성 구성 요소 이름을 얻으세요(UX 필터링에 사용) |
| get |
조직에 대한 사용 요약 가져오기 |
| get |
조직의 모든 프로젝트와 저장소를 확보하세요 (UX 필터링에 사용) |
| get |
조직별로 모든 고유한 코드 스캔 규칙명을 얻으세요(UX 필터링에 사용). |
| get |
조직별로 모든 고유한 비밀 유형을 확보하세요(UX 필터링에 사용). |
| get |
|
| list |
조직의 모든 고급 필터를 제공합니다. |
| update |
고급 필터를 업데이트합니다. 이름만 업데이트할 수 있습니다. |
생성자 세부 정보
ReportingRestClient(IVssRestClientOptions)
메서드 세부 정보
createAdvancedFilter(AdvancedFilterCreate)
조직을 위한 새로운 고급 필터를 생성합니다.
function createAdvancedFilter(filter: AdvancedFilterCreate): Promise<AdvancedFilter>매개 변수
- filter
- AdvancedFilterCreate
고급 필터를 만들어야 합니다.
반환
Promise<AdvancedFilter>
deleteAdvancedFilter(string)
고급 필터를 삭제합니다.
function deleteAdvancedFilter(filterId: string): Promise<void>매개 변수
- filterId
-
string
삭제할 고급 필터의 ID입니다.
반환
Promise<void>
getAdvancedFilter(string)
ID에 따라 특정 고급 필터를 받습니다.
function getAdvancedFilter(filterId: string): Promise<AdvancedFilter>매개 변수
- filterId
-
string
가져올 고급 필터의 ID.
반환
Promise<AdvancedFilter>
getAlertSummaryForOrg(FilterCriteria)
조직에 대한 심각도별 경고 요약 가져오기
function getAlertSummaryForOrg(criteria?: FilterCriteria): Promise<OrgAlertSummary>매개 변수
- criteria
- FilterCriteria
반환되는 요약 횟수를 제한하는 옵션
반환
Promise<OrgAlertSummary>
getCombinedAlertsForOrg(CombinedAlertFilterCriteria, number, string)
조직에 대한 결합된 경고 가져오기
function getCombinedAlertsForOrg(criteria?: CombinedAlertFilterCriteria, top?: number, continuationToken?: string): Promise<PagedList<DashboardAlert>>매개 변수
- criteria
- CombinedAlertFilterCriteria
통합 알림을 필터링하는 옵션이 반환되었습니다
- top
-
number
반환할 최대 경고 수
- continuationToken
-
string
반환할 수 있는 것보다 많은 경고가 있는 경우 연속 토큰이 "x-ms-continuationtoken" 헤더에 배치됩니다. 여기에서 해당 토큰을 사용하여 경고의 다음 페이지를 가져옵니다.
반환
Promise<PagedList<DashboardAlert>>
getDependencyComponentNamesForOrg()
조직의 모든 구별되는 의존성 구성 요소 이름을 얻으세요(UX 필터링에 사용)
function getDependencyComponentNamesForOrg(): Promise<string[]>반환
Promise<string[]>
getEnablementSummaryForOrg(EnablementFilterCriteria)
조직에 대한 사용 요약 가져오기
function getEnablementSummaryForOrg(criteria?: EnablementFilterCriteria): Promise<OrgEnablementSummary>매개 변수
- criteria
- EnablementFilterCriteria
반환되는 요약 횟수를 제한하는 옵션
반환
Promise<OrgEnablementSummary>
getProjectsAndReposForOrg()
조직의 모든 프로젝트와 저장소를 확보하세요 (UX 필터링에 사용)
function getProjectsAndReposForOrg(): Promise<ProjectAndRepoInfo[]>반환
Promise<ProjectAndRepoInfo[]>
getRuleNamesForOrg(string)
조직별로 모든 고유한 코드 스캔 규칙명을 얻으세요(UX 필터링에 사용).
function getRuleNamesForOrg(toolName?: string): Promise<CodeScanningRuleInfo[]>매개 변수
- toolName
-
string
규칙을 필터링할 수 있는 선택적 도구 이름
반환
Promise<CodeScanningRuleInfo[]>
getSecretTypesForOrg()
조직별로 모든 고유한 비밀 유형을 확보하세요(UX 필터링에 사용).
function getSecretTypesForOrg(): Promise<string[]>반환
Promise<string[]>
getUXComputedFilters()
function getUXComputedFilters(): Promise<ReportingUXComputedFilters>반환
Promise<ReportingUXComputedFilters>
listAdvancedFilters(boolean, string)
조직의 모든 고급 필터를 제공합니다.
function listAdvancedFilters(includeDeleted?: boolean, keywords?: string): Promise<AdvancedFilter[]>매개 변수
- includeDeleted
-
boolean
소프트 삭제 필터를 포함할지 여부.
- keywords
-
string
이름으로 필터를 검색하는 선택적 필터(대문자 구분 없음, 부분 일치).
반환
Promise<AdvancedFilter[]>
updateAdvancedFilter(AdvancedFilterUpdate, string)
고급 필터를 업데이트합니다. 이름만 업데이트할 수 있습니다.
function updateAdvancedFilter(filter: AdvancedFilterUpdate, filterId: string): Promise<void>매개 변수
- filter
- AdvancedFilterUpdate
새 이름이 포함된 업데이트 데이터입니다.
- filterId
-
string
고급 필터의 ID를 업데이트해야 합니다.
반환
Promise<void>