Check Configurations - Add

Başvuru

Service:: Approvals And Checks

API Version:: 7.1-preview.1

Denetim yapılandırması ekleme

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
organization	path	True	string	Azure DevOps kuruluşunun adı.
project	path	True	string	Proje Kimliği veya proje adı
api-version	query	True	string	Kullanılacak API sürümü. Api'nin bu sürümünü kullanmak için bu değer '7.1-preview.1' olarak ayarlanmalıdır.

İstek Gövdesi

Name	Tür	Description
_links	ReferenceLinks	Başvuru bağlantıları.
createdBy	IdentityRef	Denetimi yapılandıran kişinin kimliği.
createdOn	string	Denetimin yapılandırıldığı zaman.
id	integer	Yapılandırma kimliğini denetleyin.
isDisabled	boolean	Denetim devre dışı bırakıldı.
issue	CheckIssue	Yapılandırmayı denetlemek için bağlı sorun.
modifiedBy	IdentityRef	Yapılandırılan denetimi değiştiren kişinin kimliği.
modifiedOn	string	Yapılandırılan denetimin değiştirildiği zaman.
resource	Resource	Denetimin yapılandırıldığı kaynak.
timeout	integer	Çek için dakika cinsinden zaman aşımı.
type	CheckType	Yapılandırma türünü denetleme
url	string	Yapılandırılan denetimi getirebileceği URL.

Yanıtlar

Name	Tür	Description
200 OK	CheckConfiguration	başarılı işlem

Güvenlik

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

Name	Description
vso.build_execute	Derleme sonuçları, tanımlar ve istekler dahil olmak üzere derleme yapıtlarına erişme ve derlemeyi kuyruğa alma, derleme özelliklerini güncelleştirme ve hizmet kancaları aracılığıyla derleme olayları hakkında bildirim alma olanağı verir.
vso.pipelineresources_manage	Korumalı bir kaynağı veya işlem hattının korumalı kaynak kullanma isteğini yönetme olanağı verir: aracı havuzu, ortam, kuyruk, depo, güvenli dosyalar, hizmet bağlantısı ve değişken grubu

Örnekler

Approval

Task Check

Approval

Sample Request

HTTP

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

{
  "settings": {
    "approvers": [
      {
        "displayName": null,
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1"
      }
    ],
    "executionOrder": "anyOrder",
    "minRequiredApprovers": 0,
    "instructions": "Instructions",
    "blockedApprovers": []
  },
  "timeout": 43200,
  "type": {
    "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
    "name": "Approval"
  },
  "resource": {
    "type": "queue",
    "id": "1",
    "name": "Default"
  }
}

Sample Response

Status code:: 200

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

Response Body

{
  "settings": {
    "approvers": [
      {
        "displayName": null,
        "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1"
      }
    ],
    "executionOrder": "anyOrder",
    "minRequiredApprovers": 0,
    "instructions": "Instructions",
    "blockedApprovers": []
  },
  "createdBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "createdOn": "2020-11-19T10:50:46.0110496Z",
  "modifiedBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "modifiedOn": "2020-11-19T10:50:46.0110496Z",
  "timeout": 43200,
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/19"
    }
  },
  "id": 19,
  "type": {
    "id": "8c6f20a7-a545-4486-9777-f762fafe0d4d",
    "name": "Approval"
  },
  "url": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/19",
  "resource": {
    "type": "queue",
    "id": "1",
    "name": "Default"
  }
}

Task Check

Sample Request

HTTP

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

{
  "settings": {
    "displayName": "Business Hours",
    "definitionRef": {
      "id": "445fde2f-6c39-441c-807f-8a59ff2e075f",
      "name": "evaluateBusinessHours",
      "version": "0.0.1"
    },
    "inputs": {
      "businessDays": "Monday,Tuesday,Wednesday,Thursday,Friday",
      "timeZone": "UTC",
      "startTime": "04:00",
      "endTime": "11:00"
    },
    "retryInterval": 5
  },
  "timeout": 43200,
  "type": {
    "id": "fe1de3ee-a436-41b4-bb20-f6eb4cb879a7",
    "name": "Task Check"
  },
  "resource": {
    "type": "queue",
    "id": "1",
    "name": "Default"
  }
}

Sample Response

Status code:: 200

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

Response Body

{
  "settings": {
    "displayName": "Business Hours",
    "definitionRef": {
      "id": "445fde2f-6c39-441c-807f-8a59ff2e075f",
      "name": "evaluateBusinessHours",
      "version": "0.0.1"
    },
    "inputs": {
      "businessDays": "Monday,Tuesday,Wednesday,Thursday,Friday",
      "timeZone": "UTC",
      "startTime": "04:00",
      "endTime": "11:00"
    },
    "retryInterval": 5
  },
  "createdBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "createdOn": "2020-11-19T11:21:11.312742Z",
  "modifiedBy": {
    "displayName": "User Name",
    "id": "3b3db741-9d03-4e32-a7c0-6c3dfc2013c1",
    "uniqueName": "uniqueName",
    "descriptor": "Descriptor"
  },
  "modifiedOn": "2020-11-19T11:21:11.312742Z",
  "timeout": 43200,
  "_links": {
    "self": {
      "href": "https://dev.azure.com/fabrikam/d6b3e0ea-8197-4dec-831b-50e2e06ff95f/_apis/pipelines/checks/configurations/23"
    }
  },
  "id": 23,
  "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/23",
  "resource": {
    "type": "queue",
    "id": "1",
    "name": "Default"
  }
}

Tanımlar

Name	Description
CheckConfiguration
CheckIssue	Denetim yapılandırmasıyla ilişkili bir sorun (hata, uyarı).
CheckIssueType	Sorunun türü (hata, uyarı).
CheckType
IdentityRef
ReferenceLinks	REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.
Resource

CheckConfiguration

Name	Tür	Description
_links	ReferenceLinks	Başvuru bağlantıları.
createdBy	IdentityRef	Denetimi yapılandıran kişinin kimliği.
createdOn	string	Denetimin yapılandırıldığı zaman.
id	integer	Yapılandırma kimliğini denetleyin.
isDisabled	boolean	Denetim devre dışı bırakıldı.
issue	CheckIssue	Yapılandırmayı denetlemek için bağlı sorun.
modifiedBy	IdentityRef	Yapılandırılan denetimi değiştiren kişinin kimliği.
modifiedOn	string	Yapılandırılan denetimin değiştirildiği zaman.
resource	Resource	Denetimin yapılandırıldığı kaynak.
timeout	integer	Çek için dakika cinsinden zaman aşımı.
type	CheckType	Yapılandırma türünü denetleme
url	string	Yapılandırılan denetimi getirebileceği URL.

CheckIssue

Denetim yapılandırmasıyla ilişkili bir sorun (hata, uyarı).

Name	Tür	Description
description	string	Denetimin kısa özeti : adı ve kaynağı.
detailedMessage	string	Sorunun daha ayrıntılı bir açıklaması.
message	string	Sorunun açıklaması.
type	CheckIssueType	Sorunun türü (hata, uyarı).

CheckIssueType

Sorunun türü (hata, uyarı).

Name	Tür	Description
error	string
warning	string

CheckType

Name	Tür	Description
id	string	Denetim türü kimliğini alır veya ayarlar.
name	string	Denetim türünün adı.

IdentityRef

Name	Tür	Description
_links	ReferenceLinks	Bu alan, grafik konusu hakkında sıfır veya daha fazla ilgi çekici bağlantı içerir. Bu bağlantılar, bu grafik konusu hakkında daha fazla ilişki veya daha ayrıntılı bilgi edinmek için çağrılabilir.
descriptor	string	Tanımlayıcı, sistem çalışırken graf konusuna başvurmanın birincil yoludur. Bu alan, hem Hesaplar hem de Kuruluşlar genelinde aynı graf konusunu benzersiz olarak tanımlar.
directoryAlias	string	Kullanım dışı - IdentityRef "_links" sözlüğündeki "self" girişinde başvuruda bulunılan Graph kullanıcısı sorgulanarak alınabilir
displayName	string	Bu, grafik konusunun benzersiz olmayan görünen adıdır. Bu alanı değiştirmek için kaynak sağlayıcıdaki değerini değiştirmeniz gerekir.
id	string
imageUrl	string	Kullanım dışı - IdentityRef "_links" sözlüğün "avatar" girişinde kullanılabilir
inactive	boolean	Kullanım dışı - GraphUser "_links" sözlüğün "membershipState" girişinde başvurulan Graph üyelik durumu sorgulanarak alınabilir
isAadIdentity	boolean	Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Kullanım dışı - Tanımlayıcının konu türünden çıkarılabilir (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Kullanım dışı - ToIdentityRef'in önceden var olan uygulamalarının çoğunda kullanımda değil
uniqueName	string	Kullanım dışı - bunun yerine Domain+PrincipalName kullanın
url	string	Bu URL, bu grafik konusunun kaynak kaynağına giden tam yoldur.

ReferenceLinks

REST başvuru bağlantıları koleksiyonunu temsil eden sınıf.

Name	Tür	Description
links	object	Bağlantıların salt okunur görünümü. Başvuru bağlantıları salt okunur olduğundan, bunları yalnızca salt okunur olarak göstermek istiyoruz.

Resource

Name	Tür	Description
id	string	Kaynağın kimliği.
name	string	Kaynağın adı.
type	string	Kaynağın türü.

Check Configurations - Add

URI Parametreleri

İstek Gövdesi

Yanıtlar

Güvenlik

oauth2

Scopes

Örnekler

Approval

Sample Request

Sample Response

Task Check

Sample Request

Sample Response

Tanımlar

CheckConfiguration

CheckIssue

CheckIssueType

CheckType

IdentityRef

ReferenceLinks

Resource

Geri Bildirim

Ek kaynaklar