Installed Extensions - Get

Référence

Service:: Extension Management

API Version:: 6.0-preview.1

Obtenez une extension installée par son éditeur et son nom d’extension.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
extensionName	path	True	string	Nom de l’extension. Exemple : « ops-tools ».
organization	path	True	string	Nom de l’organisation Azure DevOps.
publisherName	path	True	string	Nom de l’éditeur. Exemple : « fabrikam ».
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 6.0-preview.1 » pour utiliser cette version de l’API.
assetTypes	query		string array (string)

Réponses

Nom	Type	Description
200 OK	InstalledExtension	opération réussie

Sécurité

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

Nom	Description
vso.extension_manage	Autorise l’installation, la désinstallation et l’exécution d’autres actions d’administration sur les extensions installées.

Exemples

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

Définitions

Nom	Description
Contribution	Contribution individuelle apportée par une extension
ContributionConstraint	Spécifie une contrainte qui peut être utilisée pour inclure/exclure dynamiquement une contribution donnée
ContributionLicensingBehaviorType	Comment l’inclusion de cette contribution doit changer en fonction des licences
ContributionPropertyDescription	Description d’une propriété d’un type de contribution
ContributionPropertyType	Type de valeur utilisé pour cette propriété
ContributionType	Type de contribution, donné par un schéma json
ExtensionEventCallback	Classe de base pour un rappel d’événement pour une extension
ExtensionEventCallbackCollection	Collection de rappels d’événements : points de terminaison appelés lorsque des événements d’extension spécifiques se produisent.
ExtensionFile
ExtensionFlags	Indicateurs d’extension pertinents pour les consommateurs de contributions
ExtensionLicensing	Comment une extension doit gérer l’inclusion de contributions basées sur les licences
ExtensionStateFlags	États d’une extension installée
InstalledExtension	Représente une extension VSTS avec son état d’installation
InstalledExtensionState	État d’une extension installée
InstalledExtensionStateIssue	Représente un problème d’installation
InstalledExtensionStateIssueType	Type de problème d’installation (Avertissement, Erreur)
JObject	Représente un objet JSON.
LicensingOverride	Mappe une contribution à un comportement de licence

Contribution

Contribution individuelle apportée par une extension

Nom	Type	Description
constraints	ContributionConstraint[]	Liste des contraintes (filtres) qui doivent être appliquées à la disponibilité de cette contribution
description	string	Description de la contribution/type
id	string	Identificateur complet de la contribution/type
includes	string[]	Includes est un ensemble de contributions qui doivent inclure cette contribution dans leur liste de cibles.
properties	JObject	Propriétés/attributs de cette contribution
restrictedTo	string[]	Liste des revendications demandées afin que l’utilisateur voit cette contribution (anonyme, public, membre...).
targets	string[]	Ids des contributions ciblées par cette contribution. (contributions parent)
type	string	ID du type de contribution
visibleTo	string[]	VisibleTo peut être utilisé pour restreindre qui peut référencer une contribution/un type donné. Cette valeur doit être une liste d’éditeurs ou d’extensions l’accès est également restreint. Exemples : « ms » : signifie que seul l’éditeur « ms » peut y faire référence. « ms.vss-web » : signifie que seule l’extension « vss-web » de l’éditeur « ms » peut y faire référence.

ContributionConstraint

Spécifie une contrainte qui peut être utilisée pour inclure/exclure dynamiquement une contribution donnée

Nom	Type	Description
group	integer	Propriété facultative qui peut être spécifiée pour regrouper les contraintes. Toutes les contraintes au sein d’un groupe sont ET ensemble (toutes doivent être évaluées sur True pour que la contribution soit incluse). Différents groupes de contraintes sont OR’d (un seul groupe doit évaluer la valeur True pour que la contribution soit incluse).
id	string	Identificateur complet d’une contrainte partagée
inverse	boolean	Si la valeur est true, annulez le résultat du filtre (incluez la contribution si le filtre appliqué retourne false au lieu de true)
name	string	Nom du plug-in IContributionFilter
properties	JObject	Propriétés qui sont transmises à la classe de filtre de contribution
relationships	string[]	Les contraintes peuvent éventuellement être appliquées à une ou plusieurs des relations définies dans la contribution. Si aucune relation n’est définie, toutes les relations sont associées à la contrainte. Cela signifie que le comportement par défaut éliminera complètement la contribution de l’arborescence si la contrainte est appliquée.

ContributionLicensingBehaviorType

Comment l’inclusion de cette contribution doit changer en fonction des licences

Nom	Type	Description
alwaysInclude	string	Incluez toujours la contribution, que l’utilisateur soit titulaire ou non d’une licence pour l’extension
onlyIfLicensed	string	Valeur par défaut : incluez la contribution uniquement si l’utilisateur dispose d’une licence pour l’extension
onlyIfUnlicensed	string	Inclure la contribution uniquement si l’utilisateur n’est PAS titulaire d’une licence pour l’extension

ContributionPropertyDescription

Description d’une propriété d’un type de contribution

Nom	Type	Description
description	string	Description de la propriété
name	string	Nom de la propriété
required	boolean	True si cette propriété est requise
type	ContributionPropertyType	Type de valeur utilisé pour cette propriété

ContributionPropertyType

Type de valeur utilisé pour cette propriété

Nom	Type	Description
array	string	La valeur est un tableau
boolean	string	La valeur est True ou False
dateTime	string	Value est un objet DateTime
dictionary	string	Value est un dictionnaire générique/JObject/property bag
double	string	La valeur est un double
guid	string	La valeur est un GUID
integer	string	La valeur est un entier
object	string	La valeur est un objet arbitraire/personnalisé
string	string	La valeur est une chaîne
unknown	string	Le type de contribution est inconnu (la valeur peut être n’importe quoi)
uri	string	La valeur est un URI

ContributionType

Type de contribution, donné par un schéma json

Nom	Type	Description
description	string	Description de la contribution/type
id	string	Identificateur complet de la contribution/type
indexed	boolean	Contrôle si contributions de ce type ont ou non le type indexé pour les requêtes. Cela permet aux clients de rechercher toutes les extensions qui ont une contribution de ce type. REMARQUE : Seuls les trustedpartners sont autorisés à spécifier des types de contribution indexés.
name	string	Nom convivial de la contribution/type
properties	<string, ContributionPropertyDescription>	Décrit les propriétés autorisées pour ce type de contribution
visibleTo	string[]	VisibleTo peut être utilisé pour restreindre qui peut référencer une contribution/un type donné. Cette valeur doit être une liste d’éditeurs ou d’extensions l’accès est également restreint. Exemples : « ms » : signifie que seul l’éditeur « ms » peut y faire référence. « ms.vss-web » : signifie que seule l’extension « vss-web » de l’éditeur « ms » peut y faire référence.

ExtensionEventCallback

Classe de base pour un rappel d’événement pour une extension

Nom	Type	Description
uri	string	URI du point de terminaison qui est atteint lorsqu’un événement se produit

ExtensionEventCallbackCollection

Collection de rappels d’événements : points de terminaison appelés lorsque des événements d’extension spécifiques se produisent.

Nom	Type	Description
postDisable	ExtensionEventCallback	facultatif. Définit un point de terminaison appelé via une requête POST pour notifier qu’une désactivation d’extension s’est produite.
postEnable	ExtensionEventCallback	facultatif. Définit un point de terminaison appelé via une requête POST pour notifier qu’une activation d’extension s’est produite.
postInstall	ExtensionEventCallback	facultatif. Définit un point de terminaison appelé via une requête POST pour notifier qu’une installation d’extension est terminée.
postUninstall	ExtensionEventCallback	facultatif. Définit un point de terminaison appelé via une requête POST pour notifier qu’une désinstallation d’extension s’est produite.
postUpdate	ExtensionEventCallback	facultatif. Définit un point de terminaison qui est appelé via une requête POST pour notifier qu’une mise à jour d’extension a eu lieu.
preInstall	ExtensionEventCallback	facultatif. Définit un point de terminaison appelé via une requête POST pour notifier qu’une installation d’extension est sur le point de se produire. La réponse indique s’il faut continuer ou abandonner.
versionCheck	ExtensionEventCallback	Pour les extensions multi-versions, définit un point de terminaison appelé via une requête OPTIONS pour déterminer la version particulière de l’extension à utiliser

ExtensionFile

Nom	Type	Description
assetType	string
language	string
source	string

ExtensionFlags

Indicateurs d’extension pertinents pour les consommateurs de contributions

Nom	Type	Description
builtIn	string	Une extension intégrée est installée par défaut pour tous les comptes VSTS
trusted	string	L’extension provient d’un éditeur entièrement fiable

ExtensionLicensing

Comment une extension doit gérer l’inclusion de contributions basées sur les licences

Nom	Type	Description
overrides	LicensingOverride[]	Liste des contributions qui s’écartent du comportement de licence par défaut

ExtensionStateFlags

États d’une extension installée

Nom	Type	Description
autoUpgradeError	string	Erreur lors de la mise à niveau automatique. Par exemple, si la nouvelle version n’a pas de demandes prises en charge, l’extension ne peut pas être mise à niveau automatique.
builtIn	string	L’extension est une extension intégrée
disabled	string	L’extension est désactivée
error	string	L’extension est actuellement dans un état d’erreur
multiVersion	string	L’extension a plusieurs versions
needsReauthorization	string	Les étendues d’extension ont changé et l’extension nécessite une nouvelle autorisation
none	string	Aucun indicateur défini.
trusted	string	Les extensions approuvées sont celles qui bénéficient de fonctionnalités spéciales. Celles-ci proviennent généralement de Microsoft et ne peuvent pas être publiées par le grand public. Remarque : Les extensions BuiltIn sont toujours approuvées.
unInstalled	string	L’extension n’est pas installée. Il s’agit d’extensions intégrées uniquement et ne peut pas être définie autrement.
versionCheckError	string	Erreur lors de l’exécution de l’case activée de version
warning	string	L’extension est actuellement dans un état d’avertissement, ce qui peut entraîner une expérience dégradée. L’expérience dégradée peut être provoquée, par exemple, par certains problèmes d’installation détectés, tels que des demandes implicites non prises en charge.