Installed Extensions - Get

Riferimento

Service:: Extension Management

API Version:: 7.1-preview.1

Ottenere un'estensione installata dal relativo server di pubblicazione e dal nome dell'estensione.

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

With optional parameters:

GET https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensionsbyname/{publisherName}/{extensionName}?assetTypes={assetTypes}&api-version=7.1-preview.1

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
extensionName	path	True	string	Nome dell'estensione. Esempio: "ops-tools".
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
publisherName	path	True	string	Nome dell'editore. Esempio: "fabrikam".
api-version	query	True	string	Versione dell'API da usare. Deve essere impostato su '7.1-preview.1' per usare questa versione dell'API.
assetTypes	query		string array (string)	Determina quali file vengono restituiti nella matrice di file. Specificare il carattere jolly '*' per restituire tutti i file o un elenco separato da due punti per recuperare i file con tipi di asset specifici.

Risposte

Nome	Tipo	Descrizione
200 OK	InstalledExtension	operazione riuscita

Sicurezza

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

Nome	Descrizione
vso.extension_manage	Concede la possibilità di installare, disinstallare ed eseguire altre azioni amministrative nelle estensioni installate.

Esempio

Sample Request

HTTP

GET https://extmgmt.dev.azure.com/fabrikam/_apis/extensionmanagement/installedextensionsbyname/ms/samples-contributions-guide?api-version=7.1-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": []
}

Definizioni

Nome	Descrizione
Contribution	Un singolo contributo effettuato da un'estensione
ContributionConstraint	Specifica un vincolo che può essere usato per includere/escludere dinamicamente un determinato contributo
ContributionLicensingBehaviorType	In che modo l'inclusione di questo contributo deve cambiare in base alle licenze
ContributionPropertyDescription	Descrizione di una proprietà di un tipo di contributo
ContributionPropertyType	Tipo di valore utilizzato per questa proprietà
ContributionType	Tipo di contributo, dato da uno schema json
ExtensionEventCallback	Classe base per un callback di eventi per un'estensione
ExtensionEventCallbackCollection	Raccolta di callback degli eventi: gli endpoint chiamati quando si verificano eventi di estensione specifici.
ExtensionFile
ExtensionFlags	Flag di estensione rilevanti per i consumer di contributi
ExtensionLicensing	Come un'estensione deve gestire i contributi in base alle licenze
ExtensionStateFlags	Stati di un'estensione installata
InstalledExtension	Rappresenta un'estensione VSTS insieme allo stato di installazione
InstalledExtensionState	Stato di un'estensione installata
InstalledExtensionStateIssue	Rappresenta un problema di installazione
InstalledExtensionStateIssueType	Tipo di problema di installazione (avviso, errore)
JObject	Rappresenta un oggetto JSON.
LicensingOverride	Esegue il mapping di un contributo a un comportamento di licenza

Contribution

Un singolo contributo effettuato da un'estensione

Nome	Tipo	Descrizione
constraints	ContributionConstraint[]	Elenco di vincoli (filtri) che devono essere applicati alla disponibilità di questo contributo
description	string	Descrizione del contributo/tipo
id	string	Identificatore completo del contributo/tipo
includes	string[]	Include è un set di contributi che devono avere questo contributo incluso nell'elenco di destinazioni.
properties	JObject	Proprietà/attributi di questo contributo
restrictedTo	string[]	Elenco delle attestazioni richieste per consentire all'utente di visualizzare questo contributo (ad esempio anonimo, pubblico, membro...).
targets	string[]	ID dei contributi che questo contributo è destinato. (contributi padre)
type	string	ID del tipo di contributo
visibleTo	string[]	VisibleTo può essere usato per limitare chi può fare riferimento a un determinato contributo/tipo. Questo valore deve essere un elenco di editori o estensioni di accesso è limitato anche. Esempi: "ms" - Indica che solo il server di pubblicazione "ms" può fare riferimento a questo. "ms.vss-web" - Indica solo l'estensione "vss-web" dal server di pubblicazione "ms" può fare riferimento a questo.

ContributionConstraint

Specifica un vincolo che può essere usato per includere/escludere dinamicamente un determinato contributo

Nome	Tipo	Descrizione
group	integer	Proprietà facoltativa che può essere specificata per raggruppare i vincoli. Tutti i vincoli all'interno di un gruppo sono AND'd insieme (tutti devono essere valutati su True per consentire l'inserimento del contributo). Diversi gruppi di vincoli sono OR(solo un gruppo deve valutare True per l'inserimento del contributo).
id	string	Identificatore completo di un vincolo condiviso
inverse	boolean	Se true, negare il risultato del filtro (includere il contributo se il filtro applicato restituisce false anziché true)
name	string	Nome del plug-in IContributionFilter
properties	JObject	Proprietà che vengono fornite alla classe di filtro di contributo
relationships	string[]	I vincoli possono essere applicati facoltativamente a una o più delle relazioni definite nel contributo. Se non vengono definite relazioni, tutte le relazioni sono associate al vincolo. Ciò significa che il comportamento predefinito eliminerà completamente il contributo dall'albero se il vincolo viene applicato.

ContributionLicensingBehaviorType

In che modo l'inclusione di questo contributo deve cambiare in base alle licenze

Nome	Tipo	Descrizione
alwaysInclude	string	Includere sempre il contributo indipendentemente dal fatto che l'utente abbia o meno la licenza per l'estensione
onlyIfLicensed	string	Valore predefinito: includere il contributo solo se l'utente ha una licenza per l'estensione
onlyIfUnlicensed	string	Includere il contributo solo se l'utente non ha licenza per l'estensione

ContributionPropertyDescription

Descrizione di una proprietà di un tipo di contributo

Nome	Tipo	Descrizione
description	string	Descrizione della proprietà
name	string	Nome della proprietà
required	boolean	True se questa proprietà è obbligatoria
type	ContributionPropertyType	Tipo di valore utilizzato per questa proprietà

ContributionPropertyType

Tipo di valore utilizzato per questa proprietà

Nome	Tipo	Descrizione
array	string	Value è una matrice
boolean	string	Il valore è True o False
dateTime	string	Value è un oggetto DateTime
dictionary	string	Value è un contenitore generico dizionario/JObject/proprietà
double	string	Il valore è un valore double
guid	string	Value è un GUID
integer	string	Il valore è un numero intero
object	string	Value è un oggetto arbitrario/personalizzato
string	string	Il valore è una stringa
unknown	string	Il tipo di contributo è sconosciuto (il valore può essere qualsiasi elemento)
uri	string	Value è un URI

ContributionType

Tipo di contributo, dato da uno schema json

Nome	Tipo	Descrizione
description	string	Descrizione del contributo/tipo
id	string	Identificatore completo del contributo/tipo
indexed	boolean	Controlla se i contributi di questo tipo hanno il tipo indicizzato per le query. Ciò consente ai client di trovare tutte le estensioni che hanno un contributo di questo tipo. NOTA: è consentito specificare solo i tipi di contributo indicizzati.
name	string	Nome descrittivo del contributo/tipo
properties	<string, ContributionPropertyDescription>	Descrive le proprietà consentite per questo tipo di contributo
visibleTo	string[]	VisibleTo può essere usato per limitare chi può fare riferimento a un determinato contributo/tipo. Questo valore deve essere un elenco di editori o estensioni di accesso è limitato anche. Esempi: "ms" - Indica che solo il server di pubblicazione "ms" può fare riferimento a questo. "ms.vss-web" - Indica solo l'estensione "vss-web" dal server di pubblicazione "ms" può fare riferimento a questo.

ExtensionEventCallback

Classe base per un callback di eventi per un'estensione

Nome	Tipo	Descrizione
uri	string	URI dell'endpoint che viene raggiunto quando si verifica un evento

ExtensionEventCallbackCollection

Raccolta di callback degli eventi: gli endpoint chiamati quando si verificano eventi di estensione specifici.

Nome	Tipo	Descrizione
postDisable	ExtensionEventCallback	Facoltativa. Definisce un endpoint che viene chiamato tramite una richiesta POST per notificare che si è verificata una disabilitazione dell'estensione.
postEnable	ExtensionEventCallback	Facoltativa. Definisce un endpoint che viene chiamato tramite una richiesta POST per notificare che si è verificato un'estensione abilitata.
postInstall	ExtensionEventCallback	Facoltativa. Definisce un endpoint che viene chiamato tramite una richiesta POST per notificare che un'installazione dell'estensione è stata completata.
postUninstall	ExtensionEventCallback	Facoltativa. Definisce un endpoint che viene chiamato tramite una richiesta POST per notificare che si è verificata una disinstallazione dell'estensione.
postUpdate	ExtensionEventCallback	Facoltativa. Definisce un endpoint che viene chiamato tramite una richiesta POST per notificare che si è verificato un aggiornamento dell'estensione.
preInstall	ExtensionEventCallback	Facoltativa. Definisce un endpoint che viene chiamato tramite una richiesta POST per notificare che si verifica un'installazione dell'estensione. Risposta indica se procedere o interrompere.
versionCheck	ExtensionEventCallback	Per le estensioni multi-version, definisce un endpoint che viene chiamato tramite una richiesta OPTIONS per determinare la versione specifica dell'estensione da usare

ExtensionFile

Nome	Tipo	Descrizione
assetType	string
language	string
source	string

ExtensionFlags

Flag di estensione rilevanti per i consumer di contributi

Nome	Tipo	Descrizione
builtIn	string	Un'estensione predefinita viene installata per tutti gli account VSTS per impostazione predefinita
trusted	string	L'estensione proviene da un editore completamente attendibile

ExtensionLicensing

Come un'estensione deve gestire i contributi in base alle licenze

Nome	Tipo	Descrizione
overrides	LicensingOverride[]	Elenco dei contributi che deviano dal comportamento predefinito delle licenze

ExtensionStateFlags

Stati di un'estensione installata

Nome	Tipo	Descrizione
autoUpgradeError	string	Errore durante l'aggiornamento automatico. Ad esempio, se la nuova versione non supporta l'estensione non può essere aggiornata automaticamente.
builtIn	string	L'estensione è un'estensione incorporata
disabled	string	L'estensione è disabilitata
error	string	L'estensione è attualmente in uno stato di errore
multiVersion	string	L'estensione include più versioni
needsReauthorization	string	Gli ambiti di estensione sono stati modificati e l'estensione richiede nuovamente l'autorizzazione
none	string	Nessun flag impostato
trusted	string	Le estensioni attendibili sono quelle che offrono funzionalità speciali. Questi tendono a venire da Microsoft e non possono essere pubblicati dal pubblico generale. Nota: le estensioni BuiltIn sono sempre attendibili.
unInstalled	string	L'estensione non è installata. Questo è solo per le estensioni predefinite e non può essere impostato in caso contrario.
versionCheckError	string	Errore durante l'esecuzione del controllo della versione
warning	string	L'estensione è attualmente in uno stato di avviso, che può causare un'esperienza danneggiata. L'esperienza danneggiata può essere causata, ad esempio, da alcuni problemi di installazione rilevati, ad esempio richieste implicite non supportate.