Installed Extensions - Get

Reference

Service:: Extension Management

API Version:: 6.0-preview.1

Získejte nainstalované rozšíření podle vydavatele a názvu rozšíření.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
extensionName	path	True	string	Název rozšíření Příklad: ops-tools.
organization	path	True	string	Název organizace Azure DevOps.
publisherName	path	True	string	Název vydavatele. Příklad: "fabrikam".
api-version	query	True	string	Verze rozhraní API, která se má použít. Tato verze rozhraní API by měla být nastavená na 6.0-preview.1.
assetTypes	query		string array (string)

Odpovědi

Name	Typ	Description
200 OK	InstalledExtension	úspěšná operace

Zabezpečení

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	Uděluje možnost instalace, odinstalace a provádění dalších akcí správy nainstalovaných rozšíření.

Příklady

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": []
}

Definice

Name	Description
Contribution	Individuální příspěvek z rozšíření
ContributionConstraint	Určuje omezení, které lze použít k dynamickému zahrnutí nebo vyloučení daného příspěvku.
ContributionLicensingBehaviorType	Jak by se zahrnutí tohoto příspěvku mělo změnit na základě licencování
ContributionPropertyDescription	Popis vlastnosti typu příspěvku
ContributionPropertyType	Typ hodnoty použité pro tuto vlastnost
ContributionType	Typ příspěvku daný schématem JSON
ExtensionEventCallback	Základní třída pro zpětné volání události pro rozšíření
ExtensionEventCallbackCollection	Kolekce zpětných volání událostí – koncové body volají, když dojde k určitým událostem rozšíření.
ExtensionFile
ExtensionFlags	Příznaky rozšíření relevantní pro příjemce příspěvků
ExtensionLicensing	Jak by mělo rozšíření zpracovávat, včetně příspěvků na základě licencí
ExtensionStateFlags	Stavy nainstalovaného rozšíření
InstalledExtension	Představuje rozšíření VSTS spolu s jeho stavem instalace.
InstalledExtensionState	Stav nainstalovaného rozšíření
InstalledExtensionStateIssue	Představuje problém s instalací.
InstalledExtensionStateIssueType	Typ problému s instalací (upozornění, chyba)
JObject	Představuje objekt JSON.
LicensingOverride	Mapuje příspěvek k chování při licencování.

Contribution

Individuální příspěvek z rozšíření

Name	Typ	Description
constraints	ContributionConstraint[]	Seznam omezení (filtrů), která by měla být použita pro dostupnost tohoto příspěvku
description	string	Popis příspěvku/typu
id	string	Plně kvalifikovaný identifikátor příspěvku/typu
includes	string[]	Zahrnutí je sada příspěvků, u kterých by měl být tento příspěvek uvedený ve svém seznamu cílů.
properties	JObject	Vlastnosti/atributy tohoto příspěvku
restrictedTo	string[]	Seznam vyžádaných deklarací identity, aby se uživateli tento příspěvek zobrazil (např. anonymní, veřejný, člen...)
targets	string[]	ID příspěvků, na které tento příspěvek cílí. (nadřazené příspěvky)
type	string	ID typu příspěvku
visibleTo	string[]	VisibleTo lze použít k omezení, kdo může odkazovat na daný příspěvek nebo typ. Tato hodnota by měla být seznam vydavatelů nebo rozšíření s omezeným přístupem. Příklady: "ms" – Znamená, že na tuto hodnotu může odkazovat pouze vydavatel "ms". "ms.vss-web" – znamená, že na toto může odkazovat pouze rozšíření vss-web od vydavatele ms.

ContributionConstraint

Určuje omezení, které lze použít k dynamickému zahrnutí nebo vyloučení daného příspěvku.

Name	Typ	Description
group	integer	Volitelná vlastnost, kterou lze zadat k seskupení omezení. Všechna omezení v rámci skupiny jsou and'd společně (všechna musí být vyhodnocena jako Pravda, aby se příspěvek zahrnul). Různé skupiny omezení jsou OR'd (pouze jedna skupina musí vyhodnotit jako Pravda, aby se příspěvek zahrnul).
id	string	Plně kvalifikovaný identifikátor sdíleného omezení
inverse	boolean	Pokud je hodnota true, negujte výsledek filtru (zahrňte příspěvek, pokud použitý filtr vrátí hodnotu false místo true).
name	string	Název modulu plug-in IContributionFilter
properties	JObject	Vlastnosti, které jsou předány do třídy filtru příspěvků
relationships	string[]	Omezení se dají volitelně použít na jeden nebo více relací definovaných v příspěvku. Pokud nejsou definovány žádné relace, jsou všechny relace přidruženy k omezení. To znamená, že výchozí chování zcela eliminuje příspěvek ze stromu, pokud se použije omezení.

ContributionLicensingBehaviorType

Jak by se zahrnutí tohoto příspěvku mělo změnit na základě licencování

Name	Typ	Description
alwaysInclude	string	Vždy zahrňte příspěvek bez ohledu na to, jestli má uživatel licenci k rozšíření.
onlyIfLicensed	string	Výchozí hodnota – zahrňte příspěvek jenom v případě, že má uživatel licenci na rozšíření.
onlyIfUnlicensed	string	Zahrňte příspěvek jenom v případě, že uživatel NEMÁ licenci na rozšíření.

ContributionPropertyDescription

Popis vlastnosti typu příspěvku

Name	Typ	Description
description	string	Popis vlastnosti
name	string	Název vlastnosti
required	boolean	True, pokud se tato vlastnost vyžaduje.
type	ContributionPropertyType	Typ hodnoty použité pro tuto vlastnost

ContributionPropertyType

Typ hodnoty použité pro tuto vlastnost

Name	Typ	Description
array	string	Hodnota je pole.
boolean	string	Hodnota je True nebo False.
dateTime	string	Value je objekt DateTime.
dictionary	string	Hodnota je obecný slovník, objekt JObject nebo kontejner vlastností.
double	string	Hodnota je dvojitá.
guid	string	Hodnota je identifikátor GUID.
integer	string	Hodnota je celé číslo.
object	string	Hodnota je libovolný nebo vlastní objekt.
string	string	Hodnota je řetězec.
unknown	string	Typ příspěvku je neznámý (hodnota může být nějaká).
uri	string	Hodnota je identifikátor URI.

ContributionType

Typ příspěvku daný schématem JSON

Name	Typ	Description
description	string	Popis příspěvku/typu
id	string	Plně kvalifikovaný identifikátor příspěvku/typu
indexed	boolean	Určuje, jestli mají příspěvky tohoto typu typ indexovaný pro dotazy. To umožňuje klientům najít všechna rozšíření, která mají příspěvek tohoto typu. POZNÁMKA: Pouze důvěryhodnépartnery mohou určit indexované typy příspěvků.
name	string	Popisný název příspěvku/typu
properties	<string, ContributionPropertyDescription>	Popisuje povolené vlastnosti pro tento typ příspěvku.
visibleTo	string[]	VisibleTo lze použít k omezení, kdo může odkazovat na daný příspěvek nebo typ. Tato hodnota by měla být seznam vydavatelů nebo rozšíření s omezeným přístupem. Příklady: "ms" – Znamená, že na tuto hodnotu může odkazovat pouze vydavatel "ms". "ms.vss-web" – znamená, že na toto může odkazovat pouze rozšíření vss-web od vydavatele ms.

ExtensionEventCallback

Základní třída pro zpětné volání události pro rozšíření

Name	Typ	Description
uri	string	Identifikátor URI koncového bodu, ke kterému dojde, když dojde k události

ExtensionEventCallbackCollection

Kolekce zpětných volání událostí – koncové body volají, když dojde k určitým událostem rozšíření.

Name	Typ	Description
postDisable	ExtensionEventCallback	Nepovinný parametr. Definuje koncový bod, který je volán prostřednictvím požadavku POST s upozorněním, že došlo k zakázání rozšíření.
postEnable	ExtensionEventCallback	Nepovinný parametr. Definuje koncový bod, který je volán prostřednictvím požadavku POST s upozorněním, že došlo k povolení rozšíření.
postInstall	ExtensionEventCallback	Nepovinný parametr. Definuje koncový bod, který je volán prostřednictvím požadavku POST s oznámením o dokončení instalace rozšíření.
postUninstall	ExtensionEventCallback	Nepovinný parametr. Definuje koncový bod, který je volán prostřednictvím požadavku POST s oznámením, že došlo k odinstalaci rozšíření.
postUpdate	ExtensionEventCallback	Nepovinný parametr. Definuje koncový bod, který je volán prostřednictvím požadavku POST s oznámením, že došlo k aktualizaci rozšíření.
preInstall	ExtensionEventCallback	Nepovinný parametr. Definuje koncový bod, který je volán prostřednictvím požadavku POST s upozorněním, že dojde k instalaci rozšíření. Odpověď označuje, jestli chcete pokračovat nebo přerušit.
versionCheck	ExtensionEventCallback	U rozšíření s více verzemi definuje koncový bod, který se volá prostřednictvím požadavku OPTIONS, aby určil konkrétní verzi rozšíření, které se má použít.

ExtensionFile

Name	Typ	Description
assetType	string
language	string
source	string

ExtensionFlags

Příznaky rozšíření relevantní pro příjemce příspěvků

Name	Typ	Description
builtIn	string	Ve výchozím nastavení je pro všechny účty VSTS nainstalované integrované rozšíření.
trusted	string	Rozšíření pochází od plně důvěryhodného vydavatele.

ExtensionLicensing

Jak by mělo rozšíření zpracovávat, včetně příspěvků na základě licencí

Name	Typ	Description
overrides	LicensingOverride[]	Seznam příspěvků, které se odchylují od výchozího chování při licencování

ExtensionStateFlags

Stavy nainstalovaného rozšíření

Name	Typ	Description
autoUpgradeError	string	Při automatickém upgradu došlo k chybě. Pokud například nová verze nemá požadavky na podporu, rozšíření se nedá automaticky upgradovat.
builtIn	string	Rozšíření je integrované.
disabled	string	Rozšíření je zakázané.
error	string	Rozšíření je aktuálně v chybovém stavu
multiVersion	string	Rozšíření má několik verzí.
needsReauthorization	string	Obory rozšíření se změnily a rozšíření vyžaduje opětovnou autorizaci.
none	string	Nejsou nastavené žádné příznaky.
trusted	string	Důvěryhodná rozšíření jsou ta, která mají speciální funkce. Ty většinou pocházejí od Microsoftu a nemůžou být publikovány širokou veřejností. Poznámka: Předdefinované rozšíření jsou vždy důvěryhodné.
unInstalled	string	Rozšíření není nainstalované. Toto je pouze pro předdefinovaná rozšíření a nelze ho jinak nastavit.
versionCheckError	string	Chyba při kontrole verze
warning	string	Rozšíření je aktuálně ve stavu upozornění, který může způsobit zhoršení výkonu. Zhoršení výkonu může být způsobeno například některými zjištěnými problémy s instalací, jako jsou implicitní požadavky, které nejsou podporovány.