Check Configurations - Get

參考

Service:: Approvals And Checks

API Version:: 7.1-preview.1

依識別碼取得檢查組態

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations/{id}?api-version=7.1-preview.1

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations/{id}?$expand={$expand}&api-version=7.1-preview.1

URI 參數

名稱	位於	必要	類型	Description
id	path	True	integer int32
organization	path	True	string	Azure DevOps 組織的名稱。
project	path	True	string	專案識別碼或專案名稱
api-version	query	True	string	要使用的 API 版本。這應該設定為 '7.1-preview.1' 以使用此版本的 API。
$expand	query		CheckConfigurationExpandParameter

回應

名稱	類型	Description
200 OK	CheckConfiguration	成功作業

安全性

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

名稱	Description
vso.build	授與存取組建成品的能力，包括建置結果、定義和要求，以及能夠透過服務勾點接收有關建置事件的通知。

範例

Sample Request

HTTP

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/checks/configurations/{id}?api-version=7.1-preview.1

Sample Response

Status code:: 200

request-Context: appId=cid-v1:a892bfef-0287-4640-9f5e-cffc90fbcf94
access-Control-Expose-Headers: Request-Context

Response Body

{
  "createdBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "createdOn": "2020-11-19T10:28:46.4136508Z",
  "modifiedBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "modifiedOn": "2020-11-19T10:28:46.4136508Z",
  "timeout": 43200,
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/16"
    }
  },
  "id": 16,
  "type": {
    "id": "fe1de3ee-a436-41b4-bb20-f6eb4cb879a7",
    "name": "Task Check"
  },
  "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/16",
  "resource": {
    "type": "environment",
    "id": "1",
    "name": "SampleEnv"
  }
}

定義

名稱	Description
CheckConfiguration
CheckConfigurationExpandParameter
CheckIssue	與檢查組態相關聯的問題 (錯誤、警告) 。
CheckIssueType	(錯誤、警告) 問題類型。
CheckType
IdentityRef
ReferenceLinks	表示 REST 參考連結集合的類別。
Resource

CheckConfiguration

名稱	類型	Description
_links	ReferenceLinks	參考連結。
createdBy	IdentityRef	已設定檢查的人員身分識別。
createdOn	string	檢查設定的時間。
id	integer	檢查組態識別碼。
isDisabled	boolean	已停用檢查。
issue	CheckIssue	連線到檢查組態的問題。
modifiedBy	IdentityRef	修改已設定檢查的人員身分識別。
modifiedOn	string	已修改已設定檢查的時間。
resource	Resource	檢查設定的資源。
timeout	integer	檢查的逾時分鐘數。
type	CheckType	檢查組態類型
url	string	可從中擷取已設定檢查的 URL。

CheckConfigurationExpandParameter

名稱	類型	Description
none	string
settings	string

CheckIssue

與檢查組態相關聯的問題 (錯誤、警告) 。

名稱	類型	Description
description	string	檢查的簡短摘要 - 其名稱和資源。
detailedMessage	string	問題的詳細描述。
message	string	問題的描述。
type	CheckIssueType	(錯誤、警告) 問題類型。

CheckIssueType

(錯誤、警告) 問題類型。

名稱	類型	Description
error	string
warning	string

CheckType

名稱	類型	Description
id	string	取得或設定檢查類型識別碼。
name	string	檢查類型的名稱。

IdentityRef

名稱	類型	Description
_links	ReferenceLinks	此欄位包含圖表主旨的相關零或更多有趣連結。您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。
descriptor	string	描述項是在系統執行時參考圖形主旨的主要方式。此欄位可唯一識別帳戶和組織之間的相同圖表主旨。
directoryAlias	string	已被取代 - 您可以藉由查詢 IdentityRef 「_links」字典的「self」專案中參考的 Graph 使用者來擷取
displayName	string	這是圖形主體的非唯一顯示名稱。若要變更此欄位，您必須變更來源提供者中的值。
id	string
imageUrl	string	已淘汰 - 可在 IdentityRef 「_links」字典的「avatar」專案中使用
inactive	boolean	已被取代 - 您可以藉由查詢 GraphUser 「_links」字典的「membershipState」專案中所參考的 Graph 成員資格狀態來擷取
isAadIdentity	boolean	已被取代 - 可以從描述元的主旨類型推斷 (描述元.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已被取代 - 可以從描述元的主旨類型推斷 (描述元.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已被取代 - 不在 ToIdentityRef 的大部分預先存在實作中使用
uniqueName	string	已被取代 - 請改用 Domain+PrincipalName
url	string	此 URL 是此圖形主體來源資源的完整路由。

ReferenceLinks

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的唯讀檢視。因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。

Resource

名稱	類型	Description
id	string	資源的識別碼。
name	string	資源名稱。
type	string	資源類型。

共用方式為