Installed Extensions - Install Extension By Name

Odwołanie

Service:: Extension Management

API Version:: 6.0-preview.1

Zainstaluj określone rozszerzenie w kolekcji konta/projektu.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
extensionName	path	True	string	Nazwa rozszerzenia. Przykład: "ops-tools".
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
publisherName	path	True	string	Nazwa wydawcy. Przykład: "fabrikam".
version	path		string
api-version	query	True	string	Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "6.0-preview.1", aby używać tej wersji interfejsu API.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	InstalledExtension	operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa	Opis
vso.extension_manage	Umożliwia instalowanie, odinstalowywanie i wykonywanie innych akcji administracyjnych w zainstalowanych rozszerzeniach.

Przykłady

Sample Request

HTTP

POST 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",
  "installState": {
    "flags": "none",
    "lastUpdated": "2017-11-30T21:38:02.463Z"
  },
  "lastPublished": "2017-01-19T13:28:00.85Z"
}

Definicje

Nazwa	Opis
Contribution	Indywidualne współtworzenie przez rozszerzenie
ContributionConstraint	Określa ograniczenie, które może służyć do dynamicznego dołączania/wykluczania danego udziału
ContributionLicensingBehaviorType	Jak włączenie tego wkładu powinno ulec zmianie w oparciu o licencjonowanie
ContributionPropertyDescription	Opis właściwości typu współtworzenia
ContributionPropertyType	Typ wartości używanej dla tej właściwości
ContributionType	Typ udziału podany przez schemat json
ExtensionEventCallback	Klasa podstawowa dla wywołania zwrotnego zdarzeń dla rozszerzenia
ExtensionEventCallbackCollection	Kolekcja wywołań zwrotnych zdarzeń — punkty końcowe wywoływane, gdy wystąpią określone zdarzenia rozszerzenia.
ExtensionFile
ExtensionFlags	Flagi rozszerzeń istotne dla użytkowników współtworzenia
ExtensionLicensing	Jak rozszerzenie powinno obsługiwać współtworzenie kontrybumentów na podstawie licencjonowania
ExtensionStateFlags	Stany zainstalowanego rozszerzenia
InstalledExtension	Reprezentuje rozszerzenie usługi VSTS wraz ze stanem instalacji
InstalledExtensionState	Stan zainstalowanego rozszerzenia
InstalledExtensionStateIssue	Reprezentuje problem z instalacją
InstalledExtensionStateIssueType	Typ problemu z instalacją (ostrzeżenie, błąd)
JObject	Reprezentuje obiekt JSON.
LicensingOverride	Mapowanie udziału w zachowaniu licencjonowania

Contribution

Indywidualne współtworzenie przez rozszerzenie

Nazwa	Typ	Opis
constraints	ContributionConstraint[]	Lista ograniczeń (filtrów), które powinny być stosowane do dostępności tego udziału
description	string	Opis udziału/typu
id	string	W pełni kwalifikowany identyfikator udziału/typu
includes	string[]	Uwzględnij jest zestaw składek, które powinny mieć ten wkład uwzględniony na liście celów.
properties	JObject	Właściwości/atrybuty tego udziału
restrictedTo	string[]	Lista żądanych oświadczeń w celu wyświetlenia tego wkładu przez użytkownika (na przykład anonimowego, publicznego, członka...).
targets	string[]	Identyfikatory współtworzenia, które są przeznaczone dla tego udziału. (współtworzenie nadrzędne)
type	string	Identyfikator typu współtworzenia
visibleTo	string[]	Element VisibleTo może służyć do ograniczania, do których można odwoływać się do danego udziału/typu. Ta wartość powinna być również listą wydawców lub rozszerzeń dostępu jest ograniczona. Przykłady: "ms" — oznacza, że tylko wydawca "ms" może się do tego odwoływać. "ms.vss-web" — oznacza tylko rozszerzenie "vss-web" od wydawcy "ms" może odwoływać się do tego.

ContributionConstraint

Określa ograniczenie, które może służyć do dynamicznego dołączania/wykluczania danego udziału

Nazwa	Typ	Opis
group	integer	Opcjonalna właściwość, którą można określić w celu grupowania ograniczeń. Wszystkie ograniczenia w grupie są ze sobą and'd (wszystkie muszą być obliczone na wartość True, aby wkład został uwzględniony). Różne grupy ograniczeń to OR (tylko jedna grupa musi ocenić wartość True, aby wkład został uwzględniony).
id	string	W pełni kwalifikowany identyfikator udostępnionego ograniczenia
inverse	boolean	Jeśli prawda, neguj wynik filtru (uwzględnij wkład, jeśli zastosowany filtr zwraca wartość false zamiast true)
name	string	Nazwa wtyczki IContributionFilter
properties	JObject	Właściwości przekazywane do klasy filtru współtworzenia
relationships	string[]	Ograniczenia można opcjonalnie zastosować do co najmniej jednej relacji zdefiniowanej w udziale. Jeśli nie zdefiniowano żadnych relacji, wszystkie relacje są skojarzone z ograniczeniem. Oznacza to, że domyślne zachowanie spowoduje całkowite wyeliminowanie udziału z drzewa, jeśli zostanie zastosowane ograniczenie.

ContributionLicensingBehaviorType

Jak włączenie tego wkładu powinno ulec zmianie w oparciu o licencjonowanie

Nazwa	Typ	Opis
alwaysInclude	string	Zawsze uwzględniaj wkład niezależnie od tego, czy użytkownik ma licencję na rozszerzenie
onlyIfLicensed	string	Wartość domyślna — uwzględnia tylko współtworzenie, jeśli użytkownik ma licencję na rozszerzenie
onlyIfUnlicensed	string	Dołącz tylko wkład, jeśli użytkownik nie ma licencji na rozszerzenie

ContributionPropertyDescription

Opis właściwości typu współtworzenia

Nazwa	Typ	Opis
description	string	Opis właściwości
name	string	Nazwa właściwości
required	boolean	Prawda, jeśli ta właściwość jest wymagana
type	ContributionPropertyType	Typ wartości używanej dla tej właściwości

ContributionPropertyType

Typ wartości używanej dla tej właściwości

Nazwa	Typ	Opis
array	string	Wartość to tablica
boolean	string	Wartość to Prawda lub Fałsz
dateTime	string	Wartość jest obiektem DateTime
dictionary	string	Wartość to ogólny słownik/obiekt JObject/torba właściwości
double	string	Wartość jest podwójna
guid	string	Wartość to identyfikator GUID
integer	string	Wartość jest liczbą całkowitą
object	string	Wartość to dowolny/niestandardowy obiekt
string	string	Wartość jest ciągiem
unknown	string	Typ udziału jest nieznany (wartość może być czymkolwiek)
uri	string	Wartość jest identyfikatorem URI

ContributionType

Typ udziału podany przez schemat json

Nazwa	Typ	Opis
description	string	Opis udziału/typu
id	string	W pełni kwalifikowany identyfikator udziału/typu
indexed	boolean	Określa, czy współtworzenie tego typu ma typ indeksowany dla zapytań. Dzięki temu klienci mogą znaleźć wszystkie rozszerzenia, które mają współtworzenie tego typu. UWAGA: Tylko zaufanepartnery mogą określać indeksowane typy składek.
name	string	Przyjazna nazwa udziału/typu
properties	<string, ContributionPropertyDescription>	Opisuje dozwolone właściwości dla tego typu udziału
visibleTo	string[]	Element VisibleTo może służyć do ograniczania, do których można odwoływać się do danego udziału/typu. Ta wartość powinna być również listą wydawców lub rozszerzeń dostępu jest ograniczona. Przykłady: "ms" — oznacza, że tylko wydawca "ms" może się do tego odwoływać. "ms.vss-web" — oznacza tylko rozszerzenie "vss-web" od wydawcy "ms" może odwoływać się do tego.

ExtensionEventCallback

Klasa podstawowa dla wywołania zwrotnego zdarzeń dla rozszerzenia

Nazwa	Typ	Opis
uri	string	Identyfikator URI punktu końcowego, który zostanie trafiony po wystąpieniu zdarzenia

ExtensionEventCallbackCollection

Kolekcja wywołań zwrotnych zdarzeń — punkty końcowe wywoływane, gdy wystąpią określone zdarzenia rozszerzenia.

Nazwa	Typ	Opis
postDisable	ExtensionEventCallback	Opcjonalny. Definiuje punkt końcowy, który jest wywoływany za pośrednictwem żądania POST, aby powiadomić, że wystąpiło wyłączenie rozszerzenia.
postEnable	ExtensionEventCallback	Opcjonalny. Definiuje punkt końcowy, który jest wywoływany za pośrednictwem żądania POST w celu powiadomienia o wystąpieniu włączenia rozszerzenia.
postInstall	ExtensionEventCallback	Opcjonalny. Definiuje punkt końcowy, który jest wywoływany za pośrednictwem żądania POST, aby powiadomić, że instalacja rozszerzenia została ukończona.
postUninstall	ExtensionEventCallback	Opcjonalny. Definiuje punkt końcowy, który jest wywoływany za pośrednictwem żądania POST w celu powiadomienia o wystąpieniu odinstalowania rozszerzenia.
postUpdate	ExtensionEventCallback	Opcjonalny. Definiuje punkt końcowy, który jest wywoływany za pośrednictwem żądania POST w celu powiadomienia o wystąpieniu aktualizacji rozszerzenia.
preInstall	ExtensionEventCallback	Opcjonalny. Definiuje punkt końcowy, który jest wywoływany za pośrednictwem żądania POST, aby powiadomić, że instalacja rozszerzenia ma się zdarzyć. Odpowiedź wskazuje, czy kontynuować, czy przerwać.
versionCheck	ExtensionEventCallback	W przypadku rozszerzeń z wieloma wersjami definiuje punkt końcowy, który jest wywoływany za pośrednictwem żądania OPTIONS, aby określić określoną wersję rozszerzenia do użycia

ExtensionFile

Nazwa	Typ	Opis
assetType	string
language	string
source	string

ExtensionFlags

Flagi rozszerzeń istotne dla użytkowników współtworzenia

Nazwa	Typ	Opis
builtIn	string	Wbudowane rozszerzenie jest instalowane dla wszystkich kont usługi VSTS domyślnie
trusted	string	Rozszerzenie pochodzi z w pełni zaufanego wydawcy

ExtensionLicensing

Jak rozszerzenie powinno obsługiwać współtworzenie kontrybumentów na podstawie licencjonowania

Nazwa	Typ	Opis
overrides	LicensingOverride[]	Lista współtworzenia, które odbiegają od domyślnego zachowania licencjonowania

ExtensionStateFlags

Stany zainstalowanego rozszerzenia

Nazwa	Typ	Opis
autoUpgradeError	string	Błąd podczas automatycznego uaktualniania. Jeśli na przykład nowa wersja nie wymaga obsługi rozszerzenia, nie można uaktualnić go automatycznie.
builtIn	string	Rozszerzenie jest wbudowane
disabled	string	Rozszerzenie jest wyłączone
error	string	Rozszerzenie jest obecnie w stanie błędu
multiVersion	string	Rozszerzenie ma wiele wersji
needsReauthorization	string	Zakresy rozszerzeń zostały zmienione, a rozszerzenie wymaga ponownej autoryzacji
none	string	Brak ustawionych flag
trusted	string	Zaufane rozszerzenia to te, które mają specjalne możliwości. Zwykle pochodzą one z firmy Microsoft i nie mogą być publikowane przez opinię publiczną. Uwaga: rozszerzenia BuiltIn są zawsze zaufane.
unInstalled	string	Rozszerzenie nie jest zainstalowane. Jest to przeznaczone tylko dla wbudowanych rozszerzeń i nie można go ustawić w inny sposób.
versionCheckError	string	Błąd podczas sprawdzania wersji
warning	string	Rozszerzenie jest obecnie w stanie ostrzeżenia, które może spowodować obniżoną wydajność. Obniżona wydajność może być spowodowana na przykład przez niektóre wykryte problemy z instalacją, takie jak niejawne wymagania, które nie są obsługiwane.