PolicyRestClient class
應該 (衍生自) 的基類對 VSS REST API 提出要求
- Extends
建構函式
| Policy |
屬性
| RESOURCE_AREA_ID |
方法
| create |
建立指定原則類型的原則組態。 |
| delete |
依識別碼刪除原則組態。 |
| get |
依識別碼取得原則設定。 |
| get |
依識別碼擷取指定原則的特定修訂。 |
| get |
擷取指定原則的所有修訂。 |
| get |
取得專案中的原則組態清單。 |
| get |
取得原則的目前評估狀態。 |
| get |
擷取特定提取要求之所有原則評估狀態的清單。 |
| get |
依識別碼擷取特定原則類型。 |
| get |
擷取所有可用的原則類型。 |
| requeue |
重新排入原則評估佇列。 |
| update |
依識別碼更新原則組態。 |
建構函式詳細資料
PolicyRestClient(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，請將 top 設定為 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，請將 top 設定為 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>