Installed Extensions - Update

Odwołanie

Service:: Extension Management

API Version:: 6.0-preview.1

Aktualizowanie zainstalowanego rozszerzenia. Zazwyczaj ten interfejs API służy do włączania lub wyłączania rozszerzenia.

PATCH https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensions?api-version=6.0-preview.1

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
api-version	query	True	string	Wersja interfejsu API do użycia. Należy ustawić wartość "6.0-preview.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
baseUri	string	Identyfikator URI używany jako podstawa dla innych względnych identyfikatorów URI zdefiniowanych w rozszerzeniu
constraints	ContributionConstraint[]	Lista ograniczeń udostępnionych zdefiniowanych przez to rozszerzenie
contributionTypes	ContributionType[]	Lista typów współtworzenia zdefiniowanych przez to rozszerzenie
contributions	Contribution[]	Lista współtworzeń wprowadzonych przez to rozszerzenie
demands	string[]	Lista jawnych żądań wymaganych przez to rozszerzenie
eventCallbacks	ExtensionEventCallbackCollection	Kolekcja punktów końcowych, które są wywoływane, gdy wystąpią określone zdarzenia rozszerzenia
extensionId	string	Przyjazny identyfikator rozszerzenia dla tego rozszerzenia — unikatowy dla danego wydawcy.
extensionName	string	Nazwa wyświetlana rozszerzenia.
fallbackBaseUri	string	Lokalizacja pomocnicza, która może być używana jako podstawa dla innych względnych identyfikatorów URI zdefiniowanych w rozszerzeniu
files	ExtensionFile[]	Jest to zestaw plików dostępnych z rozszerzenia.
flags	ExtensionFlags	Flagi rozszerzeń istotne dla użytkowników współtworzenia
installState	InstalledExtensionState	Informacje o tej konkretnej instalacji rozszerzenia
language	string	Nazwa kultury języka ustawiona przez galerię
lastPublished	string	Reprezentuje datę/godzinę ostatniej aktualizacji rozszerzeń w galerii. Nie oznacza to, że ta wersja została zaktualizowana, a wartość reprezentuje zmiany we wszystkich wersjach rozszerzenia.
licensing	ExtensionLicensing	Jak działa to rozszerzenie w odniesieniu do licencjonowania
manifestVersion	number	Wersja formatu/zawartości manifestu rozszerzenia
publisherId	string	Unikatowy identyfikator wydawcy tego rozszerzenia
publisherName	string	Nazwa wyświetlana wydawcy
registrationId	string	Unikatowy identyfikator dla tego rozszerzenia (ten sam identyfikator jest używany dla wszystkich wersji pojedynczego rozszerzenia)
restrictedTo	string[]	Domyślne oświadczenia użytkownika stosowane do wszystkich kontrybutów (z wyjątkiem tych, które zostały określone w sposób ograniczonyDo jawnie) w celu kontrolowania widoczności udziału.
scopes	string[]	Lista wszystkich zakresów oauth wymaganych przez to rozszerzenie
serviceInstanceType	string	ServiceInstanceType(Guid) usługi VSTS, która musi być dostępna dla konta w celu zainstalowania rozszerzenia
version	string	Wersja tego rozszerzenia

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	Daje możliwość instalowania, odinstalowywania i wykonywania innych akcji administracyjnych na zainstalowanych rozszerzeniach.

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 tej kontrybucyjności powinno ulec zmianie w zależności od licencjonowania
ContributionPropertyDescription	Opis właściwości typu udziału
ContributionPropertyType	Typ wartości używanej dla tej właściwości
ContributionType	Typ udziału podany przez schemat json
ExtensionEventCallback	Klasa bazowa 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	Mapuje współtworzenie zachowania 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 tej kontrybucyjności powinno ulec zmianie w zależności od licencjonowania

Nazwa	Typ	Opis
alwaysInclude	string	Zawsze uwzględniaj współtworzenie niezależnie od tego, czy użytkownik ma licencję na rozszerzenie
onlyIfLicensed	string	Wartość domyślna — uwzględnianie udziału tylko wtedy, gdy użytkownik ma licencję na rozszerzenie
onlyIfUnlicensed	string	Uwzględnianie udziału tylko wtedy, gdy użytkownik nie ma licencji rozszerzenia

ContributionPropertyDescription

Opis właściwości typu udziału

Nazwa	Typ	Opis
description	string	Opis właściwości
name	string	Nazwa właściwości
required	boolean	Wartość True, 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ść jest tablicą
boolean	string	Wartość to Prawda lub Fałsz
dateTime	string	Wartość jest obiektem DateTime
dictionary	string	Wartość jest ogólnym pakietem Dictionary/JObject/property
double	string	Wartość jest podwójna
guid	string	Wartość jest identyfikatorem GUID
integer	string	Wartość jest liczbą całkowitą
object	string	Wartość jest dowolnym/niestandardowym obiektem
string	string	Wartość jest ciągiem
unknown	string	Typ udziału jest nieznany (wartość może być czymś)
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 bazowa dla wywołania zwrotnego zdarzeń dla rozszerzenia

Nazwa	Typ	Opis
uri	string	Identyfikator URI punktu końcowego, który jest osiągany 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 od 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ć pogorszenie wydajności. Obniżona wydajność może być spowodowana na przykład przez wykryte problemy z instalacją, takie jak niejawne wymagania nieobsługiwane.