Installed Extensions - Update
Aktualisieren Sie eine installierte Erweiterung. In der Regel wird diese API verwendet, um eine Erweiterung zu aktivieren oder zu deaktivieren.
PATCH https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensions?api-version=6.0-preview.1
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
organization
|
path | True |
string |
Der Name der Azure DevOps-Organisation. |
api-version
|
query | True |
string |
Version der zu verwendenden API. Dies sollte auf "6.0-preview.1" festgelegt werden, um diese Version der API zu verwenden. |
Anforderungstext
Name | Typ | Beschreibung |
---|---|---|
baseUri |
string |
URI, der als Basis für andere relative URIs verwendet wird, die in der Erweiterung definiert sind |
constraints |
Liste der von dieser Erweiterung definierten freigegebenen Einschränkungen |
|
contributionTypes |
Liste der von dieser Erweiterung definierten Beitragstypen |
|
contributions |
Liste der von dieser Erweiterung vorgenommenen Beiträge |
|
demands |
string[] |
Liste der expliziten Anforderungen, die für diese Erweiterung erforderlich sind |
eventCallbacks |
Sammlung von Endpunkten, die aufgerufen werden, wenn bestimmte Erweiterungsereignisse auftreten |
|
extensionId |
string |
Die benutzerfreundlichen Erweiterungs-ID für diese Erweiterung – eindeutig für einen bestimmten Herausgeber. |
extensionName |
string |
Der Anzeigename der Erweiterung. |
fallbackBaseUri |
string |
Sekundärer Speicherort, der als Basis für andere relative URIs verwendet werden kann, die in der Erweiterung definiert sind |
files |
Dies ist der Satz von Dateien, die über die Erweiterung verfügbar sind. |
|
flags |
Erweiterungsflags, die für beitragsrelevante Verbraucher relevant sind |
|
installState |
Informationen zu dieser speziellen Installation der Erweiterung |
|
language |
string |
Vom Katalog festgelegter Sprachkulturname |
lastPublished |
string |
Dies stellt das Datum/die Uhrzeit der letzten Aktualisierung der Erweiterungen im Katalog dar. Dies bedeutet nicht, dass diese Version aktualisiert wurde. Der Wert stellt Änderungen an allen Versionen der Erweiterung dar. |
licensing |
Verhalten dieser Erweiterung in Bezug auf die Lizenzierung |
|
manifestVersion |
number |
Version des Erweiterungsmanifestformats/-inhalts |
publisherId |
string |
Eindeutige ID des Herausgebers dieser Erweiterung |
publisherName |
string |
Der Anzeigename des Herausgebers |
registrationId |
string |
Eindeutige ID für diese Erweiterung (dieselbe ID wird für alle Versionen einer einzelnen Erweiterung verwendet) |
restrictedTo |
string[] |
Standardbenutzeransprüche, die auf alle Beiträge angewendet werden (mit Ausnahme derer, die explizit restrictedTo angegeben wurden), um die Sichtbarkeit eines Beitrags zu steuern. |
scopes |
string[] |
Liste aller Oauth-Bereiche, die für diese Erweiterung erforderlich sind |
serviceInstanceType |
string |
ServiceInstanceType(Guid) des VSTS-Diensts, der für ein Konto verfügbar sein muss, damit die Erweiterung installiert wird |
version |
string |
Version dieser Erweiterung |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Erfolgreicher Vorgang |
Sicherheit
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 | Beschreibung |
---|---|
vso.extension_manage | Ermöglicht das Installieren, Deinstallieren und Ausführen anderer administrativer Aktionen für installierte Erweiterungen. |
Definitionen
Name | Beschreibung |
---|---|
Contribution |
Ein individueller Beitrag durch eine Erweiterung |
Contribution |
Gibt eine Einschränkung an, die zum dynamischen Einschließen/Ausschließen eines bestimmten Beitrags verwendet werden kann. |
Contribution |
Wie sich die Einbeziehung dieses Beitrags basierend auf der Lizenzierung ändern sollte |
Contribution |
Beschreibung einer Eigenschaft eines Beitragstyps |
Contribution |
Der Werttyp, der für diese Eigenschaft verwendet wird |
Contribution |
Ein Beitragstyp, der durch ein JSON-Schema angegeben wird |
Extension |
Basisklasse für einen Ereignisrückruf für eine Erweiterung |
Extension |
Auflistung von Ereignisrückrufen : Endpunkte, die beim Auftreten bestimmter Erweiterungsereignisse aufgerufen werden. |
Extension |
|
Extension |
Erweiterungsflags, die für beitragsrelevante Verbraucher relevant sind |
Extension |
Wie eine Erweiterung behandelt werden soll, einschließlich Beiträge basierend auf der Lizenzierung |
Extension |
Status einer installierten Erweiterung |
Installed |
Stellt eine VSTS-Erweiterung zusammen mit ihrem Installationsstatus dar. |
Installed |
Der Status einer installierten Erweiterung |
Installed |
Stellt ein Installationsproblem dar. |
Installed |
Installationsproblemtyp (Warnung, Fehler) |
JObject |
Stellt ein JSON-Objekt dar. |
Licensing |
Zuordnen eines Beitrags zu einem Lizenzierungsverhalten |
Contribution
Ein individueller Beitrag durch eine Erweiterung
Name | Typ | Beschreibung |
---|---|---|
constraints |
Liste der Einschränkungen (Filter), die auf die Verfügbarkeit dieses Beitrags angewendet werden sollten |
|
description |
string |
Beschreibung des Beitrags/Typs |
id |
string |
Vollqualifizierter Bezeichner des Beitrags/Typs |
includes |
string[] |
Includes ist eine Reihe von Beiträge, für die dieser Beitrag in ihre Zielliste aufgenommen werden sollte. |
properties |
Eigenschaften/Attribute dieses Beitrags |
|
restrictedTo |
string[] |
Liste der geforderten Ansprüche, damit der Benutzer diesen Beitrag sehen kann (z. B. anonym, öffentlich, Mitglied...). |
targets |
string[] |
Die Ids der Beiträge, auf die dieser Beitrag abzielt. (übergeordnete Beiträge) |
type |
string |
ID des Beitragstyps |
visibleTo |
string[] |
VisibleTo kann verwendet werden, um einzuschränken, wer auf einen bestimmten Beitrag/Typ verweisen kann. Dieser Wert sollte eine Liste von Herausgebern sein, oder der Zugriff auf Erweiterungen ist ebenfalls eingeschränkt. Beispiele: "ms": Bedeutet, dass nur der Herausgeber "ms" darauf verweisen kann. "ms.vss-web": Bedeutet, dass nur die Erweiterung "vss-web" des Herausgebers "ms" darauf verweisen kann. |
ContributionConstraint
Gibt eine Einschränkung an, die zum dynamischen Einschließen/Ausschließen eines bestimmten Beitrags verwendet werden kann.
Name | Typ | Beschreibung |
---|---|---|
group |
integer |
Eine optionale Eigenschaft, die zum Gruppieren von Einschränkungen angegeben werden kann. Alle Einschränkungen innerhalb einer Gruppe sind UND zusammen (alle müssen als True ausgewertet werden, damit der Beitrag einbezogen werden kann). Verschiedene Gruppen von Einschränkungen sind OR'd (nur eine Gruppe muss auf True ausgewertet werden, damit der Beitrag eingeschlossen werden soll). |
id |
string |
Vollqualifizierter Bezeichner einer freigegebenen Einschränkung |
inverse |
boolean |
Wenn true, negieren Sie das Ergebnis des Filters (schließen Sie den Beitrag ein, wenn der angewendete Filter false anstelle von true zurückgibt). |
name |
string |
Name des IContributionFilter-Plug-Ins |
properties |
Eigenschaften, die der Beitragsfilterklasse zugeführt werden |
|
relationships |
string[] |
Einschränkungen können optional auf eine oder mehrere der im Beitrag definierten Beziehungen angewendet werden. Wenn keine Beziehungen definiert sind, werden alle Beziehungen der Einschränkung zugeordnet. Dies bedeutet, dass durch das Standardverhalten der Beitrag aus der Struktur vollständig entfernt wird, wenn die Einschränkung angewendet wird. |
ContributionLicensingBehaviorType
Wie sich die Einbeziehung dieses Beitrags basierend auf der Lizenzierung ändern sollte
Name | Typ | Beschreibung |
---|---|---|
alwaysInclude |
string |
Fügen Sie immer den Beitrag ein, unabhängig davon, ob der Benutzer für die Erweiterung lizenziert ist oder nicht. |
onlyIfLicensed |
string |
Standardwert: Geben Sie den Beitrag nur an, wenn der Benutzer für die Erweiterung lizenziert ist. |
onlyIfUnlicensed |
string |
Fügen Sie den Beitrag nur ein, wenn der Benutzer NICHT für die Erweiterung lizenziert ist. |
ContributionPropertyDescription
Beschreibung einer Eigenschaft eines Beitragstyps
Name | Typ | Beschreibung |
---|---|---|
description |
string |
Beschreibung der Eigenschaft |
name |
string |
Name der Eigenschaft |
required |
boolean |
True, wenn diese Eigenschaft erforderlich ist |
type |
Der Werttyp, der für diese Eigenschaft verwendet wird |
ContributionPropertyType
Der Werttyp, der für diese Eigenschaft verwendet wird
Name | Typ | Beschreibung |
---|---|---|
array |
string |
Wert ist ein Array |
boolean |
string |
Der Wert ist True oder False. |
dateTime |
string |
Value ist ein DateTime-Objekt |
dictionary |
string |
Value ist ein generisches Wörterbuch/JObject/Eigenschaftsbehälter |
double |
string |
Wert ist ein Double |
guid |
string |
Wert ist eine GUID |
integer |
string |
Wert ist eine ganze Zahl |
object |
string |
Wert ist ein beliebiges/benutzerdefiniertes Objekt. |
string |
string |
Wert ist eine Zeichenfolge |
unknown |
string |
Der Beitragstyp ist unbekannt (Wert kann alles sein) |
uri |
string |
Wert ist ein URI |
ContributionType
Ein Beitragstyp, der durch ein JSON-Schema angegeben wird
Name | Typ | Beschreibung |
---|---|---|
description |
string |
Beschreibung des Beitrags/Typs |
id |
string |
Vollqualifizierter Bezeichner des Beitrags/Typs |
indexed |
boolean |
Steuert, ob Beiträge dieses Typs den Typ für Abfragen indiziert haben. Dadurch können Clients alle Erweiterungen finden, die einen Beitrag dieses Typs haben. HINWEIS: Nur TrustedPartners dürfen indizierte Beitragstypen angeben. |
name |
string |
Anzeigename des Beitrags/Typs |
properties |
<string,
Contribution |
Beschreibt die zulässigen Eigenschaften für diesen Beitragstyp. |
visibleTo |
string[] |
VisibleTo kann verwendet werden, um einzuschränken, wer auf einen bestimmten Beitrag/Typ verweisen kann. Dieser Wert sollte eine Liste von Herausgebern sein, oder der Zugriff auf Erweiterungen ist ebenfalls eingeschränkt. Beispiele: "ms": Bedeutet, dass nur der Herausgeber "ms" darauf verweisen kann. "ms.vss-web": Bedeutet, dass nur die Erweiterung "vss-web" des Herausgebers "ms" darauf verweisen kann. |
ExtensionEventCallback
Basisklasse für einen Ereignisrückruf für eine Erweiterung
Name | Typ | Beschreibung |
---|---|---|
uri |
string |
Der URI des Endpunkts, der beim Auftreten eines Ereignisses getroffen wird |
ExtensionEventCallbackCollection
Auflistung von Ereignisrückrufen : Endpunkte, die beim Auftreten bestimmter Erweiterungsereignisse aufgerufen werden.
Name | Typ | Beschreibung |
---|---|---|
postDisable |
Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass eine Erweiterung deaktiviert wurde. |
|
postEnable |
Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass eine Erweiterung aktiviert wurde. |
|
postInstall |
Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass eine Erweiterungsinstallation abgeschlossen wurde. |
|
postUninstall |
Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass eine Erweiterung deinstalliert wurde. |
|
postUpdate |
Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass ein Erweiterungsupdate aufgetreten ist. |
|
preInstall |
Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass eine Erweiterung installiert wird. Antwort gibt an, ob fortzufahren oder abgebrochen werden soll. |
|
versionCheck |
Definiert für Erweiterungen mit mehreren Versionen einen Endpunkt, der über eine OPTIONS-Anforderung aufgerufen wird, um die bestimmte Version der zu verwendenden Erweiterung zu bestimmen. |
ExtensionFile
Name | Typ | Beschreibung |
---|---|---|
assetType |
string |
|
language |
string |
|
source |
string |
ExtensionFlags
Erweiterungsflags, die für beitragsrelevante Verbraucher relevant sind
Name | Typ | Beschreibung |
---|---|---|
builtIn |
string |
Standardmäßig wird eine integrierte Erweiterung für alle VSTS-Konten installiert. |
trusted |
string |
Die Erweiterung stammt von einem voll vertrauenswürdigen Herausgeber. |
ExtensionLicensing
Wie eine Erweiterung behandelt werden soll, einschließlich Beiträge basierend auf der Lizenzierung
Name | Typ | Beschreibung |
---|---|---|
overrides |
Eine Liste von Beiträge, die vom Standardlizenzierungsverhalten abweichen |
ExtensionStateFlags
Status einer installierten Erweiterung
Name | Typ | Beschreibung |
---|---|---|
autoUpgradeError |
string |
Fehler beim Ausführen des automatischen Upgrades. Wenn die neue Version beispielsweise Anforderungen aufweist, die nicht unterstützt werden, kann die Erweiterung nicht automatisch aktualisiert werden. |
builtIn |
string |
Die Erweiterung ist integriert |
disabled |
string |
Erweiterung ist deaktiviert |
error |
string |
Die Erweiterung befindet sich derzeit in einem Fehlerzustand. |
multiVersion |
string |
Erweiterung verfügt über mehrere Versionen |
needsReauthorization |
string |
Erweiterungsbereiche wurden geändert, und die Erweiterung erfordert eine erneute Autorisierung. |
none |
string |
Keine Flags festgelegt |
trusted |
string |
Vertrauenswürdige Erweiterungen sind solche, die besondere Funktionen erhalten. Diese stammen in der Regel von Microsoft und können nicht von der breiten Öffentlichkeit veröffentlicht werden. Hinweis: Integrierte Erweiterungen sind immer vertrauenswürdig. |
unInstalled |
string |
Die Erweiterung ist nicht installiert. Dies gilt nur für integrierte Erweiterungen und kann andernfalls nicht festgelegt werden. |
versionCheckError |
string |
Fehler bei der Versionsüberprüfung |
warning |
string |
Die Erweiterung befindet sich derzeit in einem Warnzustand, der zu einer beeinträchtigten Benutzeroberfläche führen kann. Die beeinträchtigte Benutzeroberfläche kann z. B. dadurch verursacht werden, dass einige Installationsprobleme erkannt wurden, z. B. implizite Anforderungen, die nicht unterstützt werden. |
InstalledExtension
Stellt eine VSTS-Erweiterung zusammen mit ihrem Installationsstatus dar.
Name | Typ | Beschreibung |
---|---|---|
baseUri |
string |
URI, der als Basis für andere relative URIs verwendet wird, die in der Erweiterung definiert sind |
constraints |
Liste der von dieser Erweiterung definierten freigegebenen Einschränkungen |
|
contributionTypes |
Liste der von dieser Erweiterung definierten Beitragstypen |
|
contributions |
Liste der von dieser Erweiterung vorgenommenen Beiträge |
|
demands |
string[] |
Liste der expliziten Anforderungen, die für diese Erweiterung erforderlich sind |
eventCallbacks |
Sammlung von Endpunkten, die aufgerufen werden, wenn bestimmte Erweiterungsereignisse auftreten |
|
extensionId |
string |
Die benutzerfreundlichen Erweiterungs-ID für diese Erweiterung – eindeutig für einen bestimmten Herausgeber. |
extensionName |
string |
Der Anzeigename der Erweiterung. |
fallbackBaseUri |
string |
Sekundärer Speicherort, der als Basis für andere relative URIs verwendet werden kann, die in der Erweiterung definiert sind |
files |
Dies ist der Satz von Dateien, die über die Erweiterung verfügbar sind. |
|
flags |
Erweiterungsflags, die für beitragsrelevante Verbraucher relevant sind |
|
installState |
Informationen zu dieser speziellen Installation der Erweiterung |
|
language |
string |
Vom Katalog festgelegter Sprachkulturname |
lastPublished |
string |
Dies stellt das Datum/die Uhrzeit der letzten Aktualisierung der Erweiterungen im Katalog dar. Dies bedeutet nicht, dass diese Version aktualisiert wurde. Der Wert stellt Änderungen an allen Versionen der Erweiterung dar. |
licensing |
Verhalten dieser Erweiterung in Bezug auf die Lizenzierung |
|
manifestVersion |
number |
Version des Erweiterungsmanifestformats/-inhalts |
publisherId |
string |
Eindeutige ID des Herausgebers dieser Erweiterung |
publisherName |
string |
Der Anzeigename des Herausgebers |
registrationId |
string |
Eindeutige ID für diese Erweiterung (dieselbe ID wird für alle Versionen einer einzelnen Erweiterung verwendet) |
restrictedTo |
string[] |
Standardbenutzeransprüche, die auf alle Beiträge angewendet werden (mit Ausnahme derer, die explizit restrictedTo angegeben wurden), um die Sichtbarkeit eines Beitrags zu steuern. |
scopes |
string[] |
Liste aller Oauth-Bereiche, die für diese Erweiterung erforderlich sind |
serviceInstanceType |
string |
ServiceInstanceType(Guid) des VSTS-Diensts, der für ein Konto verfügbar sein muss, damit die Erweiterung installiert wird |
version |
string |
Version dieser Erweiterung |
InstalledExtensionState
Der Status einer installierten Erweiterung
Name | Typ | Beschreibung |
---|---|---|
flags |
Status einer installierten Erweiterung |
|
installationIssues |
Liste der Installationsprobleme |
|
lastUpdated |
string |
Der Zeitpunkt, zu dem diese Installation zuletzt aktualisiert wurde |
InstalledExtensionStateIssue
Stellt ein Installationsproblem dar.
Name | Typ | Beschreibung |
---|---|---|
message |
string |
Die Fehlermeldung |
source |
string |
Quelle des Installationsproblems, z. B. "Anforderungen" |
type |
Installationsproblemtyp (Warnung, Fehler) |
InstalledExtensionStateIssueType
Installationsproblemtyp (Warnung, Fehler)
Name | Typ | Beschreibung |
---|---|---|
error |
string |
Stellt einen Installationsfehler dar, z. B. eine explizite Anforderung, die nicht unterstützt wird. |
warning |
string |
Stellt eine Installationswarnung dar, z. B. eine implizite Anforderung, die nicht unterstützt wird. |
JObject
Stellt ein JSON-Objekt dar.
Name | Typ | Beschreibung |
---|---|---|
item |
string |
|
type |
string |
Ruft den Knotentyp für dieses JToken ab. |
LicensingOverride
Zuordnen eines Beitrags zu einem Lizenzierungsverhalten
Name | Typ | Beschreibung |
---|---|---|
behavior |
Wie sich die Einbeziehung dieses Beitrags basierend auf der Lizenzierung ändern sollte |
|
id |
string |
Vollqualifizierte Beitrags-ID, für die das Lizenzierungsverhalten definiert werden soll |