Installed Extensions - Get

Referenz

Service:: Extension Management

API Version:: 6.0-preview.1

Rufen Sie eine installierte Erweiterung nach herausgeber und Erweiterungsname ab.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
extensionName	path	True	string	Name der Erweiterung. Beispiel: "ops-tools".
organization	path	True	string	Der Name der Azure DevOps-Organisation.
publisherName	path	True	string	Name des Herausgebers. Beispiel: "fabrikam".
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.
assetTypes	query		string array (string)

Antworten

Name	Typ	Beschreibung
200 OK	InstalledExtension	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.

Beispiele

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

Definitionen

Name	Beschreibung
Contribution	Ein individueller Beitrag durch eine Erweiterung
ContributionConstraint	Gibt eine Einschränkung an, die zum dynamischen Einschließen/Ausschließen eines bestimmten Beitrags verwendet werden kann.
ContributionLicensingBehaviorType	Wie sich die Einbeziehung dieses Beitrags basierend auf der Lizenzierung ändern sollte
ContributionPropertyDescription	Beschreibung einer Eigenschaft eines Beitragstyps
ContributionPropertyType	Der Werttyp, der für diese Eigenschaft verwendet wird
ContributionType	Ein Beitragstyp, der durch ein JSON-Schema angegeben wird
ExtensionEventCallback	Basisklasse für einen Ereignisrückruf für eine Erweiterung
ExtensionEventCallbackCollection	Auflistung von Ereignisrückrufen : Endpunkte, die beim Auftreten bestimmter Erweiterungsereignisse aufgerufen werden.
ExtensionFile
ExtensionFlags	Erweiterungsflags, die für beitragsrelevante Verbraucher relevant sind
ExtensionLicensing	Wie eine Erweiterung behandelt werden soll, einschließlich Beiträge basierend auf der Lizenzierung
ExtensionStateFlags	Status einer installierten Erweiterung
InstalledExtension	Stellt eine VSTS-Erweiterung zusammen mit ihrem Installationsstatus dar.
InstalledExtensionState	Der Status einer installierten Erweiterung
InstalledExtensionStateIssue	Stellt ein Installationsproblem dar.
InstalledExtensionStateIssueType	Installationsproblemtyp (Warnung, Fehler)
JObject	Stellt ein JSON-Objekt dar.
LicensingOverride	Zuordnen eines Beitrags zu einem Lizenzierungsverhalten

Contribution

Ein individueller Beitrag durch eine Erweiterung

Name	Typ	Beschreibung
constraints	ContributionConstraint[]	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	JObject	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	JObject	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	ContributionPropertyType	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, ContributionPropertyDescription>	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	ExtensionEventCallback	Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass eine Erweiterung deaktiviert wurde.
postEnable	ExtensionEventCallback	Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass eine Erweiterung aktiviert wurde.
postInstall	ExtensionEventCallback	Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass eine Erweiterungsinstallation abgeschlossen wurde.
postUninstall	ExtensionEventCallback	Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass eine Erweiterung deinstalliert wurde.
postUpdate	ExtensionEventCallback	Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass ein Erweiterungsupdate aufgetreten ist.
preInstall	ExtensionEventCallback	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	ExtensionEventCallback	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	LicensingOverride[]	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.