Installed Extensions - Install Extension By Name

Reference

Služba:: Extension Management

Verze rozhraní API:: 6.0-preview.1

Nainstalujte zadané rozšíření do kolekce účtu nebo projektu.

POST https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensionsbyname/{publisherName}/{extensionName}/{version}?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".
version	path		string
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.

Odpovědi

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

Zabezpečení

oauth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: 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

Rozsahy

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

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

{
  "extensionId": "samples-contributions-guide",
  "extensionName": "Contributions Guide",
  "publisherId": "ms-samples",
  "publisherName": "Microsoft",
  "version": "0.1.35",
  "installState": {
    "flags": "none",
    "lastUpdated": "2017-11-30T21:38:02.463Z"
  },
  "lastPublished": "2017-01-19T13:28:00.85Z"
}

Definice

Name	Description
Contribution	Individuální příspěvek provedený rozšířením
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 volané při výskytu konkrétních událostí 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ě licencování
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

Object

Individuální příspěvek provedený rozšířením

Name	Typ	Description
constraints	ContributionConstraint[]	Seznam omezení (filtrů), která by se měla použít 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[]	Includes je sada příspěvků, které by měly mít tento příspěvek uvedený v seznamu cílů.
properties	JObject	Vlastnosti/atributy tohoto příspěvku
restrictedTo	string[]	Seznam vyžádaných deklarací identity, aby uživatel mohl tento příspěvek zobrazit (například 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 přístup rozšíření je také omezený. Příklady: "ms" – znamená, že na to může odkazovat pouze vydavatel ms. "ms.vss-web" – znamená, že na to může odkazovat pouze rozšíření "vss-web" od vydavatele ms.

ContributionConstraint

Object

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 je možné 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í být vyhodnocena jako Pravda, aby se příspěvek zahrnul).
id	string	Plně kvalifikovaný identifikátor sdíleného omezení
inverse	boolean	Pokud je pravda, 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řiváděné do třídy filtru příspěvků
relationships	string[]	Omezení lze volitelně použít na jednu 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

Enumeration

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

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

ContributionPropertyDescription

Object

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

Enumeration

Typ hodnoty použité pro tuto vlastnost

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

ContributionType

Object

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 TrustedPartners mohou určit typy indexovaných příspěvků.
name	string	Popisný název příspěvku nebo 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 přístup rozšíření je také omezený. Příklady: "ms" – znamená, že na to může odkazovat pouze vydavatel ms. "ms.vss-web" – znamená, že na to může odkazovat pouze rozšíření "vss-web" od vydavatele ms.

ExtensionEventCallback

Object

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

Object

Kolekce zpětných volání událostí – koncové body volané při výskytu konkrétních událostí rozšíření.

Name	Typ	Description
postDisable	ExtensionEventCallback	Nepovinný parametr. Definuje koncový bod, který je volán prostřednictvím požadavku POST s oznámení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 oznámení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, že instalace rozšíření byla dokončena.
postUninstall	ExtensionEventCallback	Nepovinný parametr. Definuje koncový bod, který se volá 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 oznámením, že se chystá provést instalaci rozšíření. Odpověď označuje, jestli 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 se určila konkrétní verze rozšíření, která se má použít.

ExtensionFile

Object

Name	Typ	Description
assetType	string
language	string
source	string

ExtensionFlags

Enumeration

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

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

ExtensionLicensing

Object

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

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

ExtensionStateFlags

Enumeration

Stavy nainstalovaného rozšíření

Hodnota	Description
autoUpgradeError	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	Rozšíření je integrované
disabled	Rozšíření je zakázané
error	Rozšíření je aktuálně v chybovém stavu
multiVersion	Rozšíření má více verzí.
needsReauthorization	Obory rozšíření se změnily a rozšíření vyžaduje opětovnou autorizaci.
none	Nejsou nastavené žádné příznaky.
trusted	Důvěryhodná rozšíření jsou ta, která mají speciální funkce. Obvykle pocházejí od Microsoftu a nemůžou být publikovány veřejností. Poznámka: Předdefinované rozšíření jsou vždy důvěryhodná.
unInstalled	Rozšíření není nainstalované. To je jenom pro předdefinovaná rozšíření a jinak se nedá nastavit.
versionCheckError	Chyba při kontrole verze
warning	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.