Installed Extensions - Get

Başvuru

Service:: Extension Management

API Version:: 6.0-preview.1

Yayımcısına ve uzantı adına göre yüklü bir uzantı alın.

GET https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensionsbyname/{publisherName}/{extensionName}?api-version=6.0-preview.1

With optional parameters:

GET https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensionsbyname/{publisherName}/{extensionName}?assetTypes={assetTypes}&api-version=6.0-preview.1

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
extensionName	path	True	string	Uzantının adı. Örnek: "ops-tools".
organization	path	True	string	Azure DevOps kuruluşunun adı.
publisherName	path	True	string	Yayımcının adı. Örnek: "fabrikam".
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.
assetTypes	query		string array (string)

Yanıtlar

Name	Tür	Description
200 OK	InstalledExtension	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.

Örnekler

Sample Request

HTTP

GET https://extmgmt.dev.azure.com/fabrikam/_apis/extensionmanagement/installedextensionsbyname/ms/samples-contributions-guide?api-version=6.0-preview.1

Sample Response

Status code:: 200

{
  "extensionId": "samples-contributions-guide",
  "extensionName": "Contributions Guide",
  "publisherId": "ms-samples",
  "publisherName": "Microsoft",
  "version": "0.1.35",
  "manifestVersion": 1,
  "baseUri": "https://ms-samples.gallerycdn.vsassets.io/extensions/ms-samples/samples-contributions-guide/0.1.35/1484832479380",
  "fallbackBaseUri": "https://ms-samples.gallery.vsassets.io/_apis/public/gallery/publisher/ms-samples/extension/samples-contributions-guide/0.1.35/assetbyname",
  "scopes": [],
  "installState": {
    "flags": "none",
    "lastUpdated": "2017-11-30T21:38:02.463Z"
  },
  "contributionTypes": [],
  "lastPublished": "2017-01-19T13:28:00.85Z",
  "files": []
}

Tanımlar

Name	Description
Contribution	Uzantı tarafından yapılan bireysel katkı
ContributionConstraint	Belirli bir katkıyı dinamik olarak dahil etmek/dışlamak için kullanılabilecek bir kısıtlama belirtir
ContributionLicensingBehaviorType	Lisanslama temelinde bu katkının eklenmesinin nasıl değişmesi gerekir?
ContributionPropertyDescription	Katkı türünün özelliği hakkında açıklama
ContributionPropertyType	Bu özellik için kullanılan değer türü
ContributionType	JSON şeması tarafından verilen katkı türü
ExtensionEventCallback	Uzantı için olay geri çağırma için temel sınıf
ExtensionEventCallbackCollection	Olay geri çağırmaları koleksiyonu - belirli uzantı olayları gerçekleştiğinde çağrılan uç noktalar.
ExtensionFile
ExtensionFlags	Katkı tüketicileriyle ilgili uzantı bayrakları
ExtensionLicensing	Bir uzantının lisanslamaya dayalı katkılar dahil olmak üzere nasıl işlemesi gerekir?
ExtensionStateFlags	Yüklü bir uzantının durumları
InstalledExtension	Bir VSTS uzantısını yükleme durumuyla birlikte temsil eder
InstalledExtensionState	Yüklü bir uzantının durumu
InstalledExtensionStateIssue	Yükleme sorununu temsil eder
InstalledExtensionStateIssueType	Yükleme sorun türü (Uyarı, Hata)
JObject	JSON nesnesini temsil eder.
LicensingOverride	Lisanslama davranışına katkıyı eşler

Contribution

Uzantı tarafından yapılan bireysel katkı

Name	Tür	Description
constraints	ContributionConstraint[]	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	JObject	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	JObject	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	ContributionPropertyType	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, ContributionPropertyDescription>	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	ExtensionEventCallback	İ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	ExtensionEventCallback	İ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	ExtensionEventCallback	İ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	ExtensionEventCallback	İ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	ExtensionEventCallback	İ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	ExtensionEventCallback	İ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	ExtensionEventCallback	Ç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	LicensingOverride[]	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.