Installed Extensions - Update
Yüklü bir uzantıyı güncelleştirin. Bu API genellikle bir uzantıyı etkinleştirmek veya devre dışı bırakmak için kullanılır.
PATCH https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensions?api-version=6.0-preview.1
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps kuruluşunun 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 '6.0-preview.1' olarak ayarlanmalıdır. |
İstek Gövdesi
Name | Tür | Description |
---|---|---|
baseUri |
string |
Uzantıda tanımlanan diğer göreli uri'ler için temel olarak kullanılan Uri |
constraints |
Bu uzantı tarafından tanımlanan paylaşılan kısıtlamaların listesi |
|
contributionTypes |
Bu uzantı tarafından tanımlanan katkı türlerinin listesi |
|
contributions |
Bu uzantı tarafından yapılan katkıların listesi |
|
demands |
string[] |
Bu uzantının gerektirdiği açık taleplerin listesi |
eventCallbacks |
Belirli uzantı olayları gerçekleştiğinde çağrılan uç noktaların koleksiyonu |
|
extensionId |
string |
Bu uzantı için kolay uzantı kimliği - belirli bir yayımcı için benzersiz. |
extensionName |
string |
Uzantının görünen adı. |
fallbackBaseUri |
string |
Uzantıda tanımlanan diğer göreli uri'ler için temel olarak kullanılabilecek ikincil konum |
files |
Bu, uzantıdan kullanılabilen dosya kümesidir. |
|
flags |
Katkı tüketicileriyle ilgili uzantı bayrakları |
|
installState |
Uzantının bu özel yüklemesi hakkında bilgi |
|
language |
string |
Galeri tarafından ayarlanan Dil Kültürü Adı |
lastPublished |
string |
Bu, uzantıların galeride son güncelleştirildiği tarihi/saati temsil eder. Bu, bu sürümün güncelleştirildiği anlamına gelmez, değer uzantının herhangi bir sürümündeki değişiklikleri temsil eder. |
licensing |
Bu uzantı lisanslamayla ilgili olarak nasıl davranır? |
|
manifestVersion |
number |
Uzantı bildirim biçiminin/içeriğinin sürümü |
publisherId |
string |
Bu uzantının yayımcısının benzersiz kimliği |
publisherName |
string |
Yayımcının görünen adı |
registrationId |
string |
Bu uzantının benzersiz kimliği (tek bir uzantının tüm sürümleri için aynı kimlik kullanılır) |
restrictedTo |
string[] |
Bir katkının görünürlüğünü denetlemek için tüm katkılara uygulanan varsayılan kullanıcı talepleri (açıkça restrictedTo olarak belirtilmiş olanlar hariç). |
scopes |
string[] |
Bu uzantı için gereken tüm oauth kapsamlarının listesi |
serviceInstanceType |
string |
Uzantının yüklenmesi için bir hesapta kullanılabilir olması gereken VSTS hizmetinin ServiceInstanceType(Guid) değeri |
version |
string |
Bu uzantının sürümü |
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.extension_manage | Yüklü uzantılarda yükleme, kaldırma ve diğer yönetim eylemlerini gerçekleştirme olanağı verir. |
Tanımlar
Name | Description |
---|---|
Contribution |
Uzantı tarafından yapılan bireysel katkı |
Contribution |
Belirli bir katkıyı dinamik olarak dahil etmek/dışlamak için kullanılabilecek bir kısıtlama belirtir |
Contribution |
Lisanslama temelinde bu katkının eklenmesinin nasıl değişmesi gerekir? |
Contribution |
Katkı türünün özelliği hakkında açıklama |
Contribution |
Bu özellik için kullanılan değer türü |
Contribution |
JSON şeması tarafından verilen katkı türü |
Extension |
Uzantı için olay geri çağırma için temel sınıf |
Extension |
Olay geri çağırmaları koleksiyonu - belirli uzantı olayları gerçekleştiğinde çağrılan uç noktalar. |
Extension |
|
Extension |
Katkı tüketicileriyle ilgili uzantı bayrakları |
Extension |
Bir uzantının lisanslamaya dayalı katkılar dahil olmak üzere nasıl işlemesi gerekir? |
Extension |
Yüklü bir uzantının durumları |
Installed |
Bir VSTS uzantısını yükleme durumuyla birlikte temsil eder |
Installed |
Yüklü bir uzantının durumu |
Installed |
Yükleme sorununu temsil eder |
Installed |
Yükleme sorun türü (Uyarı, Hata) |
JObject |
JSON nesnesini temsil eder. |
Licensing |
Lisanslama davranışına katkıyı eşler |
Contribution
Uzantı tarafından yapılan bireysel katkı
Name | Tür | Description |
---|---|---|
constraints |
Bu katkının kullanılabilirliğine uygulanması gereken kısıtlamaların (filtrelerin) listesi |
|
description |
string |
Katkının/türün açıklaması |
id |
string |
Katkının/türün tam tanımlayıcısı |
includes |
string[] |
Eklemeler, bu katkının hedef listesine eklenmesi gereken bir dizi katkıdır. |
properties |
Bu katkının özellikleri/öznitelikleri |
|
restrictedTo |
string[] |
Kullanıcının bu katkıyı görebilmesi için talep edilen taleplerin listesi (anonim, genel, üye...). |
targets |
string[] |
Bu katkının hedeflediğinin kimlikleri. (üst katkılar) |
type |
string |
Katkı Türünün Kimliği |
visibleTo |
string[] |
VisibleTo, belirli bir katkıya/türe başvurabilecek kişileri kısıtlamak için kullanılabilir. Bu değer yayımcıların listesi olmalıdır veya uzantı erişimi de kısıtlanmıştır. Örnekler: "ms" - Yalnızca "ms" yayımcısının buna başvurabileceği anlamına gelir. "ms.vss-web" - Yalnızca "ms" yayımcısından "vss-web" uzantısının buna başvurabileceği anlamına gelir. |
ContributionConstraint
Belirli bir katkıyı dinamik olarak dahil etmek/dışlamak için kullanılabilecek bir kısıtlama belirtir
Name | Tür | Description |
---|---|---|
group |
integer |
Kısıtlamaları birlikte gruplandırmak için belirtilebilen isteğe bağlı bir özellik. Bir grup içindeki tüm kısıtlamalar AND'd ile birliktedir (katkının dahil edilmesi için tümü True olarak değerlendirilmelidir). Farklı kısıtlama grupları OR'd'dır (katkının dahil edilmesi için yalnızca bir grubun True olarak değerlendirmesi gerekir). |
id |
string |
Paylaşılan kısıtlamanın tam tanımlayıcısı |
inverse |
boolean |
True ise, filtrenin sonucunu yoksayın (uygulanan filtre true yerine false döndürüyorsa katkıyı ekleyin) |
name |
string |
IContributionFilter eklentisinin adı |
properties |
Katkı filtresi sınıfına beslenen özellikler |
|
relationships |
string[] |
Kısıtlamalar isteğe bağlı olarak katkıda tanımlanan ilişkilerin birine veya daha fazlasına uygulanabilir. Hiçbir ilişki tanımlanmadıysa, tüm ilişkiler kısıtlamayla ilişkilendirilir. Bu, kısıtlama uygulandığında varsayılan davranışın ağaçtan gelen katkıyı tamamen ortadan kaldıracağı anlamına gelir. |
ContributionLicensingBehaviorType
Lisanslama temelinde bu katkının eklenmesinin nasıl değişmesi gerekir?
Name | Tür | Description |
---|---|---|
alwaysInclude |
string |
Kullanıcının uzantı için lisanslanıp lisanslanmadığına bakılmaksızın katkıyı her zaman dahil edin |
onlyIfLicensed |
string |
Varsayılan değer - yalnızca kullanıcı uzantı lisansına sahipse katkıyı ekleyin |
onlyIfUnlicensed |
string |
Yalnızca kullanıcının uzantı için lisanslanmaması durumunda katkıyı ekleyin |
ContributionPropertyDescription
Katkı türünün özelliği hakkında açıklama
Name | Tür | Description |
---|---|---|
description |
string |
Özelliğin açıklaması |
name |
string |
Özelliğin adı |
required |
boolean |
Bu özellik gerekliyse True |
type |
Bu özellik için kullanılan değer türü |
ContributionPropertyType
Bu özellik için kullanılan değer türü
Name | Tür | Description |
---|---|---|
array |
string |
Değer bir dizidir |
boolean |
string |
Değer Doğru veya Yanlış |
dateTime |
string |
Değer bir DateTime nesnesidir |
dictionary |
string |
Değer genel bir Sözlük/JObject/özellik paketidir |
double |
string |
Değer bir çifttir |
guid |
string |
Değer bir GUID'dir |
integer |
string |
Değer bir tamsayıdır |
object |
string |
Değer rastgele/özel bir nesnedir |
string |
string |
Değer bir dizedir |
unknown |
string |
Katkı türü bilinmiyor (değer herhangi bir şey olabilir) |
uri |
string |
Değer bir Uri'dir |
ContributionType
JSON şeması tarafından verilen katkı türü
Name | Tür | Description |
---|---|---|
description |
string |
Katkının/türün açıklaması |
id |
string |
Katkının/türün tam tanımlayıcısı |
indexed |
boolean |
Bu türdeki katkıların sorgular için dizine alınan türe sahip olup olmadığını denetler. Bu, istemcilerin bu tür bir katkıya sahip tüm uzantıları bulmasını sağlar. NOT: Yalnızca TrustedPartners'ın dizine alınan katkı türlerini belirtmesine izin verilir. |
name |
string |
Katkının/türün kolay adı |
properties |
<string,
Contribution |
Bu katkı türü için izin verilen özellikleri açıklar |
visibleTo |
string[] |
VisibleTo, belirli bir katkıya/türe başvurabilecek kişileri kısıtlamak için kullanılabilir. Bu değer yayımcıların listesi olmalıdır veya uzantı erişimi de kısıtlanmıştır. Örnekler: "ms" - Yalnızca "ms" yayımcısının buna başvurabileceği anlamına gelir. "ms.vss-web" - Yalnızca "ms" yayımcısından "vss-web" uzantısının buna başvurabileceği anlamına gelir. |
ExtensionEventCallback
Uzantı için olay geri çağırma için temel sınıf
Name | Tür | Description |
---|---|---|
uri |
string |
Bir olay gerçekleştiğinde isabet eden uç noktanın uri'si |
ExtensionEventCallbackCollection
Olay geri çağırmaları koleksiyonu - belirli uzantı olayları gerçekleştiğinde çağrılan uç noktalar.
Name | Tür | Description |
---|---|---|
postDisable |
İsteğe bağlı. Uzantı devre dışı bırakma işleminin gerçekleştiğini bildirmek için POST isteği aracılığıyla çağrılan bir uç nokta tanımlar. |
|
postEnable |
İsteğe bağlı. Uzantı etkinleştirme işleminin gerçekleştiğini bildirmek için POST isteği aracılığıyla çağrılan bir uç noktayı tanımlar. |
|
postInstall |
İsteğe bağlı. Uzantı yüklemenin tamamlandığını bildirmek için POST isteği aracılığıyla çağrılan bir uç nokta tanımlar. |
|
postUninstall |
İsteğe bağlı. Uzantı kaldırma işleminin gerçekleştiğini bildirmek için POST isteği aracılığıyla çağrılan bir uç noktayı tanımlar. |
|
postUpdate |
İsteğe bağlı. Uzantı güncelleştirmesinin gerçekleştiğini bildirmek için POST isteği aracılığıyla çağrılan bir uç noktayı tanımlar. |
|
preInstall |
İsteğe bağlı. Uzantı yüklemenin gerçekleşmek üzere olduğunu bildirmek için POST isteği aracılığıyla çağrılan bir uç nokta tanımlar. Yanıt devam etmek mi yoksa iptal etmek mi olduğunu gösterir. |
|
versionCheck |
Çok sürümlü uzantılar için, kullanılacak uzantının belirli sürümünü belirlemek üzere BIR SEÇENEKLER isteği aracılığıyla çağrılan bir uç nokta tanımlar |
ExtensionFile
Name | Tür | Description |
---|---|---|
assetType |
string |
|
language |
string |
|
source |
string |
ExtensionFlags
Katkı tüketicileriyle ilgili uzantı bayrakları
Name | Tür | Description |
---|---|---|
builtIn |
string |
Varsayılan olarak tüm VSTS hesapları için yerleşik bir uzantı yüklenir |
trusted |
string |
Uzantı, tam olarak güvenilen bir yayımcıdan gelir |
ExtensionLicensing
Bir uzantının lisanslamaya dayalı katkılar dahil olmak üzere nasıl işlemesi gerekir?
Name | Tür | Description |
---|---|---|
overrides |
Varsayılan lisanslama davranışından sapan katkıların listesi |
ExtensionStateFlags
Yüklü bir uzantının durumları
Name | Tür | Description |
---|---|---|
autoUpgradeError |
string |
Otomatik yükseltme yapılırken hata oluştu. Örneğin, yeni sürümde desteklenmeyen talepler varsa uzantı otomatik olarak yükseltilemez. |
builtIn |
string |
Uzantı yerleşik bir |
disabled |
string |
Uzantı devre dışı bırakıldı |
error |
string |
Uzantı şu anda bir hata durumunda |
multiVersion |
string |
Uzantının birden çok sürümü vardır |
needsReauthorization |
string |
Uzantı kapsamları değişti ve uzantı için yeniden yetkilendirme gerekiyor |
none |
string |
Bayrak ayarlanmadı |
trusted |
string |
Güvenilen uzantılar, özel özellikler verilen uzantılardır. Bunlar Genellikle Microsoft'tan gelir ve genel halk tarafından yayımlanamaz. Not: BuiltIn uzantılarına her zaman güvenilir. |
unInstalled |
string |
Uzantı yüklü değil. Bu yalnızca yerleşik uzantılar içindir ve başka şekilde ayarlanamaz. |
versionCheckError |
string |
Sürüm denetimi gerçekleştirirken hata oluştu |
warning |
string |
Uzantı şu anda bir uyarı durumundadır ve bu da deneyimin düşmesine neden olabilir. Düzeyi düşürülmüş deneyim, örneğin örtük taleplerin desteklenmemesi gibi algılanan bazı yükleme sorunlarında kaynaklanabilir. |
InstalledExtension
Bir VSTS uzantısını yükleme durumuyla birlikte temsil eder
Name | Tür | Description |
---|---|---|
baseUri |
string |
Uzantıda tanımlanan diğer göreli uri'ler için temel olarak kullanılan Uri |
constraints |
Bu uzantı tarafından tanımlanan paylaşılan kısıtlamaların listesi |
|
contributionTypes |
Bu uzantı tarafından tanımlanan katkı türlerinin listesi |
|
contributions |
Bu uzantı tarafından yapılan katkıların listesi |
|
demands |
string[] |
Bu uzantının gerektirdiği açık taleplerin listesi |
eventCallbacks |
Belirli uzantı olayları gerçekleştiğinde çağrılan uç noktaların koleksiyonu |
|
extensionId |
string |
Bu uzantı için kolay uzantı kimliği - belirli bir yayımcı için benzersiz. |
extensionName |
string |
Uzantının görünen adı. |
fallbackBaseUri |
string |
Uzantıda tanımlanan diğer göreli uri'ler için temel olarak kullanılabilecek ikincil konum |
files |
Bu, uzantıdan kullanılabilen dosya kümesidir. |
|
flags |
Katkı tüketicileriyle ilgili uzantı bayrakları |
|
installState |
Uzantının bu özel yüklemesi hakkında bilgi |
|
language |
string |
Galeri tarafından ayarlanan Dil Kültürü Adı |
lastPublished |
string |
Bu, uzantıların galeride son güncelleştirildiği tarihi/saati temsil eder. Bu, bu sürümün güncelleştirildiği anlamına gelmez, değer uzantının herhangi bir sürümündeki değişiklikleri temsil eder. |
licensing |
Bu uzantı lisanslamayla ilgili olarak nasıl davranır? |
|
manifestVersion |
number |
Uzantı bildirim biçiminin/içeriğinin sürümü |
publisherId |
string |
Bu uzantının yayımcısının benzersiz kimliği |
publisherName |
string |
Yayımcının görünen adı |
registrationId |
string |
Bu uzantının benzersiz kimliği (tek bir uzantının tüm sürümleri için aynı kimlik kullanılır) |
restrictedTo |
string[] |
Bir katkının görünürlüğünü denetlemek için tüm katkılara uygulanan varsayılan kullanıcı talepleri (açıkça restrictedTo olarak belirtilmiş olanlar hariç). |
scopes |
string[] |
Bu uzantı için gereken tüm oauth kapsamlarının listesi |
serviceInstanceType |
string |
Uzantının yüklenmesi için bir hesapta kullanılabilir olması gereken VSTS hizmetinin ServiceInstanceType(Guid) değeri |
version |
string |
Bu uzantının sürümü |
InstalledExtensionState
Yüklü bir uzantının durumu
Name | Tür | Description |
---|---|---|
flags |
Yüklü bir uzantının durumları |
|
installationIssues |
Yükleme sorunlarının listesi |
|
lastUpdated |
string |
Bu yüklemenin en son güncelleştirildiği saat |
InstalledExtensionStateIssue
Yükleme sorununu temsil eder
Name | Tür | Description |
---|---|---|
message |
string |
Hata iletisi |
source |
string |
Yükleme sorununun kaynağı, örneğin "Talepler" |
type |
Yükleme sorun türü (Uyarı, Hata) |
InstalledExtensionStateIssueType
Yükleme sorun türü (Uyarı, Hata)
Name | Tür | Description |
---|---|---|
error |
string |
Yükleme hatasını temsil eder; örneğin, desteklenmeyen açık bir talep |
warning |
string |
Yükleme uyarısını temsil eder, örneğin örtük talep desteklenmez |
JObject
JSON nesnesini temsil eder.
Name | Tür | Description |
---|---|---|
item |
string |
|
type |
string |
Bu JToken için düğüm türünü alır. |
LicensingOverride
Lisanslama davranışına katkıyı eşler
Name | Tür | Description |
---|---|---|
behavior |
Lisanslama temelinde bu katkının eklenmesinin nasıl değişmesi gerekir? |
|
id |
string |
Lisanslama davranışını tanımlamak istediğimiz tam katkı kimliği |