ManagementRestClient class
VSS REST api에 대한 요청을 만드는 데 사용해야 하는 기본 클래스(파생)입니다.
- Extends
메서드
| cancel |
조직의 모든 실행 중이거나 대기열에 있는 CodeQL 작업과 진행 중인 동적 파이프라인 실행을 취소합니다. |
| create |
EUS21(기본 배율 단위)의 다중 조직 청구 계산 중에 이 API는 특정 조직에 대한 청구 스냅샷을 만드는 데 사용됩니다. 기본 배율 단위는 서로 다른 scsle 단위의 각 조직에 대해 이 API를 호출하여 청구 스냅샷을 만듭니다. 데이터는 조직별 파티션 DB -> 청구 스냅샷 테이블에 저장됩니다. 고객이 조직별 파티션 DB에서 청구 데이터를 가져올 때 필요합니다. |
| get |
모든 사용 가능한 에이전트 풀 + 현재 선택된 에이전트 풀을 얻기 위한 기본 URL 이 작업은 관리 권한이 필요 없는 읽기 전용 작업입니다. |
| get |
VSID와 일치하지 않는 것을 포함하여 청구 가능한 모든 커밋자 세부 정보를 가져옵니다. |
| get |
조직의 실행 중이거나 대기열에 저장된 CodeQL 작업 수와 진행 중인 동적 파이프라인 실행 수를 파악합니다. |
| get |
조직의 최신 CodeQL 기본 설정 일정 구성을 받습니다. |
| get |
조직의 최신 CodeQL 기본 설정 일정 구성을 받습니다. |
| get |
이 리포지토리에 대해 Advanced Security를 사용하도록 설정한 경우 고객의 사용량에 추가될 푸셔를 예측합니다. |
| get |
이 조직에 고급 보안을 사용하도록 설정한 경우 고객의 사용량에 추가될 푸시러를 예측합니다. |
| get |
이 project에 Advanced Security가 활성화될 경우 고객 사용량에 추가될 푸셔 수를 추정하세요. |
| get |
|
| get |
청구 정보를 계산할 때 사용되는 커밋기를 가져옵니다. |
| get |
조직에 대한 고급 보안의 현재 상태 가져오기 |
| get |
project의 Advanced Security 현재 상태를 확인하세요 |
| get |
코드 보안, 비밀 보호 및 해당 기능이 리포지토리에 대해 사용하도록 설정되어 있는지 확인합니다. |
| update |
선택한 에이전트 풀의 에이전트 풀 레지스트리 값을 업데이트합니다. 이 기능은 에이전트 풀의 기본 HTTP 클라이언트를 사용하여 사용자가 해당 풀을 사용할 권한이 있는지 검증합니다 |
| update |
조직의 CodeQL 기본 설정 스캔이 실행되어야 하는 요일을 설정합니다. |
| update |
조직의 CodeQL 기본 설정 스캔이 실행되어야 하는 요일을 설정합니다. |
| update |
조직의 고급 보안 상태 업데이트 |
| update |
project의 고급 보안 상태 업데이트하기 |
| update |
지정된 리포지토리에 대한 해당 기능과 함께 코드 보안 및 비밀 보호의 사용 상태를 업데이트합니다. |
생성자 세부 정보
ManagementRestClient(IVssRestClientOptions)
메서드 세부 정보
cancelCodeQLJobs()
조직의 모든 실행 중이거나 대기열에 있는 CodeQL 작업과 진행 중인 동적 파이프라인 실행을 취소합니다.
function cancelCodeQLJobs(): Promise<number>반품
Promise<number>
createBillingSnapshot2(MeterUsageForPlan, Plan)
EUS21(기본 배율 단위)의 다중 조직 청구 계산 중에 이 API는 특정 조직에 대한 청구 스냅샷을 만드는 데 사용됩니다. 기본 배율 단위는 서로 다른 scsle 단위의 각 조직에 대해 이 API를 호출하여 청구 스냅샷을 만듭니다. 데이터는 조직별 파티션 DB -> 청구 스냅샷 테이블에 저장됩니다. 고객이 조직별 파티션 DB에서 청구 데이터를 가져올 때 필요합니다.
function createBillingSnapshot2(meterUsage: MeterUsageForPlan, plan: Plan): Promise<void>매개 변수
- meterUsage
- MeterUsageForPlan
- plan
- Plan
반품
Promise<void>
getAdvancedSecurityAgentPoolSelection()
모든 사용 가능한 에이전트 풀 + 현재 선택된 에이전트 풀을 얻기 위한 기본 URL 이 작업은 관리 권한이 필요 없는 읽기 전용 작업입니다.
function getAdvancedSecurityAgentPoolSelection(): Promise<AgentPoolDetails>반품
Promise<AgentPoolDetails>
getBillableCommitterDetails2(Plan, Date)
VSID와 일치하지 않는 것을 포함하여 청구 가능한 모든 커밋자 세부 정보를 가져옵니다.
function getBillableCommitterDetails2(plan: Plan, billingDate?: Date): Promise<BillableCommitterDetails[]>매개 변수
- plan
- Plan
쿼리할 계획입니다. 지원되는 계획: CodeSecurity 및 SecretProtection. 이는 필수 매개 변수입니다.
- billingDate
-
Date
쿼리할 날짜이거나 제공되지 않은 경우 오늘
반품
Promise<BillableCommitterDetails[]>
getCodeQLJobCount()
조직의 실행 중이거나 대기열에 저장된 CodeQL 작업 수와 진행 중인 동적 파이프라인 실행 수를 파악합니다.
function getCodeQLJobCount(): Promise<number>반품
Promise<number>
getCodeQLSchedule()
조직의 최신 CodeQL 기본 설정 일정 구성을 받습니다.
function getCodeQLSchedule(): Promise<CodeQLScheduleDetails>반품
Promise<CodeQLScheduleDetails>
getCodeQLScheduleLegacy()
조직의 최신 CodeQL 기본 설정 일정 구성을 받습니다.
function getCodeQLScheduleLegacy(): Promise<CodeQLScheduleDetails>반품
Promise<CodeQLScheduleDetails>
getEstimatedBillableCommittersDetailsForRepo2(string, string, Plan)
이 리포지토리에 대해 Advanced Security를 사용하도록 설정한 경우 고객의 사용량에 추가될 푸셔를 예측합니다.
function getEstimatedBillableCommittersDetailsForRepo2(project: string, repository: string, plan?: Plan): Promise<MeterUsageEstimate>매개 변수
- project
-
string
Project ID 또는 project 이름
- repository
-
string
리포지토리의 이름 또는 ID
- plan
- Plan
쿼리할 계획입니다.
반품
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForOrg2(Plan)
이 조직에 고급 보안을 사용하도록 설정한 경우 고객의 사용량에 추가될 푸시러를 예측합니다.
function getEstimatedBillablePushersDetailsForOrg2(plan?: Plan): Promise<MeterUsageEstimate>매개 변수
- plan
- Plan
쿼리할 계획입니다.
반품
Promise<MeterUsageEstimate>
getEstimatedBillablePushersDetailsForProject2(string, Plan)
이 project에 Advanced Security가 활성화될 경우 고객 사용량에 추가될 푸셔 수를 추정하세요.
function getEstimatedBillablePushersDetailsForProject2(project: string, plan?: Plan): Promise<MeterUsageEstimate>매개 변수
- project
-
string
Project ID 또는 project 이름
- plan
- Plan
반품
Promise<MeterUsageEstimate>
getLastMeterUsage2(Plan)
function getLastMeterUsage2(plan: Plan): Promise<MeterUsageForPlan>매개 변수
- plan
- Plan
반품
Promise<MeterUsageForPlan>
getMeterUsage2(Plan, Date)
청구 정보를 계산할 때 사용되는 커밋기를 가져옵니다.
function getMeterUsage2(plan: Plan, billingDate?: Date): Promise<MeterUsageForPlan>매개 변수
- plan
- Plan
쿼리할 계획입니다. 지원되는 계획: CodeSecurity 및 SecretProtection. 이는 필수 매개 변수입니다.
- billingDate
-
Date
쿼리할 날짜이거나 제공되지 않은 경우 오늘
반품
Promise<MeterUsageForPlan>
getOrgEnablementStatus2(boolean)
조직에 대한 고급 보안의 현재 상태 가져오기
function getOrgEnablementStatus2(includeAllProperties?: boolean): Promise<OrgEnablementSettings>매개 변수
- includeAllProperties
-
boolean
true인 경우 푸시에 비밀이 포함되어 있는지 여부도 확인합니다.
반품
Promise<OrgEnablementSettings>
getProjectEnablementStatus2(string, boolean)
project의 Advanced Security 현재 상태를 확인하세요
function getProjectEnablementStatus2(project: string, includeAllProperties?: boolean): Promise<ProjectEnablementSettings>매개 변수
- project
-
string
Project ID 또는 project 이름
- includeAllProperties
-
boolean
true인 경우 푸시에 비밀이 포함되어 있는지 여부도 확인합니다.
반품
Promise<ProjectEnablementSettings>
getRepoEnablementStatus2(string, string, boolean)
코드 보안, 비밀 보호 및 해당 기능이 리포지토리에 대해 사용하도록 설정되어 있는지 확인합니다.
function getRepoEnablementStatus2(project: string, repository: string, includeAllProperties?: boolean): Promise<RepoEnablementSettings>매개 변수
- project
-
string
Project ID 또는 project 이름
- repository
-
string
리포지토리의 이름 또는 ID
- includeAllProperties
-
boolean
true이면 비밀이 검색될 때 푸시가 차단되는지 여부도 결정됩니다.
반품
Promise<RepoEnablementSettings>
updateAdvancedSecurityAgentPoolSelection(string)
선택한 에이전트 풀의 에이전트 풀 레지스트리 값을 업데이트합니다. 이 기능은 에이전트 풀의 기본 HTTP 클라이언트를 사용하여 사용자가 해당 풀을 사용할 권한이 있는지 검증합니다
function updateAdvancedSecurityAgentPoolSelection(agentPoolName: string): Promise<AgentPoolDetails>매개 변수
- agentPoolName
-
string
반품
Promise<AgentPoolDetails>
updateCodeQLSchedule(number)
조직의 CodeQL 기본 설정 스캔이 실행되어야 하는 요일을 설정합니다.
function updateCodeQLSchedule(scheduleDayOfWeek: number): Promise<CodeQLScheduleDetails>매개 변수
- scheduleDayOfWeek
-
number
정수로는 요일: 0=일요일, 1=월요일, ..., 6=토요일.
반품
Promise<CodeQLScheduleDetails>
updateCodeQLScheduleLegacy(number)
조직의 CodeQL 기본 설정 스캔이 실행되어야 하는 요일을 설정합니다.
function updateCodeQLScheduleLegacy(scheduleDayOfWeek: number): Promise<CodeQLScheduleDetails>매개 변수
- scheduleDayOfWeek
-
number
정수로는 요일: 0=일요일, 1=월요일, ..., 6=토요일.
반품
Promise<CodeQLScheduleDetails>
updateOrgEnablementStatus2(OrgEnablementSettings)
조직의 고급 보안 상태 업데이트
function updateOrgEnablementStatus2(orgEnablementSettings: OrgEnablementSettings): Promise<void>매개 변수
- orgEnablementSettings
- OrgEnablementSettings
새 상태
반품
Promise<void>
updateProjectEnablementStatus2(ProjectEnablementSettings, string)
project의 고급 보안 상태 업데이트하기
function updateProjectEnablementStatus2(projectEnablementSettings: ProjectEnablementSettings, project: string): Promise<void>매개 변수
- projectEnablementSettings
- ProjectEnablementSettings
새 상태
- project
-
string
Project ID 또는 project 이름
반품
Promise<void>
updateRepoAdvSecEnablementStatus2(RepoEnablementSettings, string, string)
지정된 리포지토리에 대한 해당 기능과 함께 코드 보안 및 비밀 보호의 사용 상태를 업데이트합니다.
function updateRepoAdvSecEnablementStatus2(repoEnablementSettings: RepoEnablementSettings, project: string, repository: string): Promise<void>매개 변수
- repoEnablementSettings
- RepoEnablementSettings
새로운 상태
- project
-
string
Project ID 또는 project 이름
- repository
-
string
리포지토리의 이름 또는 ID
반품
Promise<void>