Configurations - List
Projedeki ilke yapılandırmalarının listesini alma.
Eski uyumluluk nedenleri dışında bu API'nin 'scope' parametresi kullanılmamalıdır. Özel olarak kapsamlı ilkeleri döndürür ve hiyerarşik iç içe yerleştirmeyi desteklemez. Bunun yerine, birinci sınıf kapsam filtreleme desteği sağlayan /_apis/git/policy/configurations API'sini kullanın.
İsteğe bağlı policyType
parametresi, bu yöntemden döndürülen ilke kümesini filtrelemek için kullanılabilir.
GET https://dev.azure.com/{organization}/{project}/_apis/policy/configurations?api-version=7.1-preview.1
GET https://dev.azure.com/{organization}/{project}/_apis/policy/configurations?scope={scope}&$top={$top}&continuationToken={continuationToken}&policyType={policyType}&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'nin sürümü. Bu, api'nin bu sürümünü kullanmak için '7.1-preview.1' olarak ayarlanmalıdır. |
$top
|
query |
integer int32 |
Döndürülecek en fazla ilke sayısı. |
|
continuation
|
query |
string |
Sayfalandırma için kullanılan devamlılık belirteci. |
|
policy
|
query |
string uuid |
Döndürülen ilkeleri yalnızca bu türe filtrele |
|
scope
|
query |
string |
[Eski nedenlerle sağlanır] İlkelerin bir alt kümesinin tanımlandığı kapsam. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
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.code | İşlemeler, değişiklik kümeleri, dallar ve diğer sürüm denetimi yapıtları hakkında kaynak kodu ve meta verileri okuma yeteneği verir. Ayrıca kod arama ve hizmet kancaları aracılığıyla sürüm denetimi olayları hakkında bildirim alma olanağı verir. |
Örnekler
Sample Request
GET https://dev.azure.com/fabrikam/fabrikam-fiber-git/_apis/policy/configurations?api-version=7.1-preview.1
Sample Response
{
"count": 3,
"value": [
{
"createdBy": {
"id": "d6245f20-2af8-44f4-9451-8107cb2767db",
"displayName": "Normal Paulk",
"uniqueName": "fabrikamfiber16@hotmail.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
},
"createdDate": "2015-02-23T12:51:06.85754Z",
"isEnabled": true,
"isBlocking": true,
"isDeleted": false,
"settings": {
"requiredReviewerIds": [
"1d1dad71-f27c-4370-810d-838ec41efd41",
"13272ea3-92ef-46d1-b77e-608ebbf3428b"
],
"filenamePatterns": [
"*/API*.cs",
"sql/tables/*"
],
"addedFilesOnly": false,
"message": null,
"scope": [
{
"refName": "refs/heads/master",
"matchKind": "Exact",
"repositoryId": null
},
{
"refName": "refs/heads/releases/",
"matchKind": "Prefix",
"repositoryId": null
},
{
"refName": "refs/heads/adventureworks",
"matchKind": "Exact",
"repositoryId": "49c1d4d0-be28-4f20-9e0a-4ecfafc39257"
}
]
},
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/policy/configurations/17"
},
"type": {
"href": "https://dev.azure.com/fabrikam/1be3fc5b-c58c-4173-8fd7-6647d11eccd1/_apis/policy/types/fd2167ab-b0be-447a-8ec8-39368250530e"
}
},
"revision": 2,
"id": 17,
"url": "https://dev.azure.com/fabrikam/_apis/policy/configurations/17",
"type": {
"id": "fd2167ab-b0be-447a-8ec8-39368250530e",
"url": "https://dev.azure.com/fabrikam/1be3fc5b-c58c-4173-8fd7-6647d11eccd1/_apis/policy/types/fd2167ab-b0be-447a-8ec8-39368250530e",
"displayName": "Required reviewers"
}
},
{
"createdBy": {
"id": "d6245f20-2af8-44f4-9451-8107cb2767db",
"displayName": "Normal Paulk",
"uniqueName": "fabrikamfiber16@hotmail.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
},
"createdDate": "2015-02-23T12:51:06.8887894Z",
"isEnabled": true,
"isBlocking": false,
"settings": {
"minimumApproverCount": 1,
"creatorVoteCounts": false,
"scope": [
{
"refName": "refs/heads/master",
"matchKind": "Exact",
"repositoryId": null
}
]
},
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/policy/configurations/18"
},
"type": {
"href": "https://dev.azure.com/fabrikam/1be3fc5b-c58c-4173-8fd7-6647d11eccd1/_apis/policy/types/fa4e907d-c16b-4a4c-9dfa-4906e5d171dd"
}
},
"revision": 1,
"id": 18,
"url": "https://dev.azure.com/fabrikam/_apis/policy/configurations/18",
"type": {
"id": "fa4e907d-c16b-4a4c-9dfa-4906e5d171dd",
"url": "https://dev.azure.com/fabrikam/1be3fc5b-c58c-4173-8fd7-6647d11eccd1/_apis/policy/types/fa4e907d-c16b-4a4c-9dfa-4906e5d171dd",
"displayName": "Minimum approval count"
}
},
{
"createdBy": {
"id": "d6245f20-2af8-44f4-9451-8107cb2767db",
"displayName": "Normal Paulk",
"uniqueName": "fabrikamfiber16@hotmail.com",
"url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/d6245f20-2af8-44f4-9451-8107cb2767db",
"imageUrl": "https://dev.azure.com/fabrikam/_api/_common/identityImage?id=d6245f20-2af8-44f4-9451-8107cb2767db"
},
"createdDate": "2015-02-23T12:51:06.935666Z",
"isEnabled": true,
"isBlocking": false,
"settings": {
"buildDefinitionId": 5,
"scope": [
{
"refName": "refs/heads/features/",
"matchKind": "Prefix",
"repositoryId": null
}
]
},
"_links": {
"self": {
"href": "https://dev.azure.com/fabrikam/_apis/policy/configurations/19"
},
"type": {
"href": "https://dev.azure.com/fabrikam/1be3fc5b-c58c-4173-8fd7-6647d11eccd1/_apis/policy/types/0609b952-1397-4640-95ec-e00a01b2c241"
}
},
"revision": 1,
"id": 19,
"url": "https://dev.azure.com/fabrikam/_apis/policy/configurations/19",
"type": {
"id": "0609b952-1397-4640-95ec-e00a01b2c241",
"url": "https://dev.azure.com/fabrikam/1be3fc5b-c58c-4173-8fd7-6647d11eccd1/_apis/policy/types/0609b952-1397-4640-95ec-e00a01b2c241",
"displayName": "Build"
}
}
]
}
Tanımlar
Name | Description |
---|---|
Identity |
|
JObject |
Bir JSON nesnesini temsil eder. |
Policy |
Ayarlarla tam ilke yapılandırması. |
Policy |
İlke türü başvurusu. |
Reference |
REST başvuru bağlantılarının koleksiyonunu temsil eden sınıf. |
IdentityRef
Name | Tür | Description |
---|---|---|
_links |
Bu alan, grafik konusuyla ilgili sıfır veya daha fazla ilgi çekici bağlantı içerir. Bu bağlantılar, bu grafik konusu hakkında ek ilişkiler 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üğündeki "avatar" girişinde kullanılabilir |
inactive |
boolean |
Kullanım dışı - GraphUser "_links" sözlüğündeki "membershipState" girdisinde 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. |
JObject
Bir JSON nesnesini temsil eder.
Name | Tür | Description |
---|---|---|
item |
string |
|
type |
string |
Bu JToken için düğüm türünü alır. |
PolicyConfiguration
Ayarlarla tam ilke yapılandırması.
Name | Tür | Description |
---|---|---|
_links |
Bu nesneyle ilgili diğer nesnelere bağlantılar. |
|
createdBy |
İlkeyi oluşturan kimliğe başvuru. |
|
createdDate |
string |
İlkenin oluşturulduğu tarih ve saat. |
id |
integer |
İlke yapılandırma kimliği. |
isBlocking |
boolean |
İlkenin engelleyip engellemediğini gösterir. |
isDeleted |
boolean |
İlkenin (geçici) silinip silinmediğini gösterir. |
isEnabled |
boolean |
İlkenin etkinleştirilip etkinleştirilmediğini gösterir. |
isEnterpriseManaged |
boolean |
Ayarlanırsa, bu ilke oluşturmak, düzenlemek veya silmek için "Kurumsal İlkeleri Yönet" izni gerektirir. |
revision |
integer |
İlke yapılandırma düzeltme kimliği. |
settings |
İlke yapılandırma ayarları. |
|
type |
İlke yapılandırma türü. |
|
url |
string |
İlke yapılandırmasının alınabileceği URL. |
PolicyTypeRef
İlke türü başvurusu.
Name | Tür | Description |
---|---|---|
displayName |
string |
İlke türünün görünen adı. |
id |
string |
İlke türü kimliği. |
url |
string |
İlke türünün alınabileceği URL. |
ReferenceLinks
REST başvuru bağlantılarının 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 kullanıma açmak istiyoruz. |
Geri Bildirim
https://aka.ms/ContentUserFeedback.
Çok yakında: 2024 boyunca, içerik için geri bildirim mekanizması olarak GitHub Sorunları’nı kullanımdan kaldıracak ve yeni bir geri bildirim sistemiyle değiştireceğiz. Daha fazla bilgi için bkz.Gönderin ve geri bildirimi görüntüleyin