Installed Extensions - Get

Referencia

Service:: Extension Management

API Version:: 6.0-preview.1

Obtenga una extensión instalada por su editor y nombre de extensión.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
extensionName	path	True	string	Nombre de la extensión. Ejemplo: "ops-tools".
organization	path	True	string	El nombre de la organización de Azure DevOps.
publisherName	path	True	string	Nombre del publicador. Ejemplo: "fabrikam".
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "6.0-preview.1" para usar esta versión de la API.
assetTypes	query		string array (string)

Respuestas

Nombre	Tipo	Description
200 OK	InstalledExtension	operación correcta

Seguridad

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

Nombre	Description
vso.extension_manage	Concede la capacidad de instalar, desinstalar y realizar otras acciones administrativas en las extensiones instaladas.

Ejemplos

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

Definiciones

Nombre	Description
Contribution	Una contribución individual realizada por una extensión
ContributionConstraint	Especifica una restricción que se puede usar para incluir o excluir dinámicamente una contribución determinada.
ContributionLicensingBehaviorType	Cómo debe cambiar la inclusión de esta contribución en función de las licencias
ContributionPropertyDescription	Descripción sobre una propiedad de un tipo de contribución
ContributionPropertyType	Tipo de valor usado para esta propiedad
ContributionType	Un tipo de contribución, dado por un esquema json
ExtensionEventCallback	Clase base para una devolución de llamada de evento para una extensión
ExtensionEventCallbackCollection	Colección de devoluciones de llamada de eventos: puntos de conexión a los que se llama cuando se producen eventos de extensión concretos.
ExtensionFile
ExtensionFlags	Marcas de extensión relevantes para los consumidores de contribución
ExtensionLicensing	Cómo debe controlar una extensión, incluidas las contribuciones basadas en licencias
ExtensionStateFlags	Estados de una extensión instalada
InstalledExtension	Representa una extensión de VSTS junto con su estado de instalación.
InstalledExtensionState	Estado de una extensión instalada
InstalledExtensionStateIssue	Representa un problema de instalación
InstalledExtensionStateIssueType	Tipo de problema de instalación (advertencia, error)
JObject	Representa un objeto JSON.
LicensingOverride	Asigna una contribución a un comportamiento de licencia

Contribution

Una contribución individual realizada por una extensión

Nombre	Tipo	Description
constraints	ContributionConstraint[]	Lista de restricciones (filtros) que se deben aplicar a la disponibilidad de esta contribución
description	string	Descripción de la contribución o el tipo
id	string	Identificador completo de la contribución o el tipo
includes	string[]	Incluye es un conjunto de contribuciones que deben tener esta contribución incluida en su lista de destinos.
properties	JObject	Propiedades y atributos de esta contribución
restrictedTo	string[]	Lista de notificaciones demandadas para que el usuario vea esta contribución (como anónima, pública, miembro...).
targets	string[]	Identificadores de las contribuciones a las que se dirige esta contribución. (contribuciones primarias)
type	string	Identificador del tipo de contribución
visibleTo	string[]	VisibleTo se puede usar para restringir quién puede hacer referencia a una contribución o tipo determinado. Este valor debe ser también una lista de editores o extensiones de acceso restringido. Ejemplos: "ms": significa que solo el publicador "ms" puede hacer referencia a esto. "ms.vss-web": significa que solo la extensión "vss-web" del publicador "ms" puede hacer referencia a esto.

ContributionConstraint

Especifica una restricción que se puede usar para incluir o excluir dinámicamente una contribución determinada.

Nombre	Tipo	Description
group	integer	Propiedad opcional que se puede especificar para agrupar restricciones. Todas las restricciones dentro de un grupo están juntas Y (todas deben evaluarse como True para que se incluya la contribución). Los distintos grupos de restricciones son OR'd (solo un grupo debe evaluarse como True para que se incluya la contribución).
id	string	Identificador completo de una restricción compartida
inverse	boolean	Si es true, niega el resultado del filtro (incluya la contribución si el filtro aplicado devuelve false en lugar de true).
name	string	Nombre del complemento IContributionFilter
properties	JObject	Propiedades que se alimentan a la clase de filtro de contribución
relationships	string[]	Opcionalmente, las restricciones se pueden aplicar a una o varias de las relaciones definidas en la contribución. Si no se definen relaciones, todas las relaciones están asociadas a la restricción . Esto significa que el comportamiento predeterminado eliminará la contribución del árbol por completo si se aplica la restricción.

ContributionLicensingBehaviorType

Cómo debe cambiar la inclusión de esta contribución en función de las licencias

Nombre	Tipo	Description
alwaysInclude	string	Incluya siempre la contribución independientemente de si el usuario tiene licencia para la extensión.
onlyIfLicensed	string	Valor predeterminado: incluya solo la contribución si el usuario tiene licencia para la extensión.
onlyIfUnlicensed	string	Incluya solo la contribución si el usuario NO tiene licencia para la extensión.

ContributionPropertyDescription

Descripción sobre una propiedad de un tipo de contribución

Nombre	Tipo	Description
description	string	Descripción de la propiedad
name	string	Nombre de la propiedad
required	boolean	True si se requiere esta propiedad
type	ContributionPropertyType	Tipo de valor usado para esta propiedad

ContributionPropertyType

Tipo de valor usado para esta propiedad

Nombre	Tipo	Description
array	string	El valor es una matriz
boolean	string	El valor es True o False
dateTime	string	Value es un objeto DateTime
dictionary	string	El valor es un contenedor genérico Dictionary/JObject/property
double	string	El valor es un valor double
guid	string	El valor es un GUID
integer	string	El valor es un entero
object	string	El valor es un objeto arbitrario o personalizado
string	string	El valor es una cadena
unknown	string	El tipo de contribución es desconocido (el valor puede ser cualquier cosa)
uri	string	El valor es un URI

ContributionType

Un tipo de contribución, dado por un esquema json

Nombre	Tipo	Description
description	string	Descripción de la contribución o el tipo
id	string	Identificador completo de la contribución o el tipo
indexed	boolean	Controla si las contribuciones de este tipo tienen el tipo indexado para las consultas. Esto permite a los clientes encontrar todas las extensiones que tienen una contribución de este tipo. NOTA: Solo trustedPartners puede especificar tipos de contribución indizado.
name	string	Nombre descriptivo de la contribución o el tipo
properties	<string, ContributionPropertyDescription>	Describe las propiedades permitidas para este tipo de contribución.
visibleTo	string[]	VisibleTo se puede usar para restringir quién puede hacer referencia a una contribución o tipo determinado. Este valor debe ser también una lista de editores o extensiones de acceso restringido. Ejemplos: "ms": significa que solo el publicador "ms" puede hacer referencia a esto. "ms.vss-web": significa que solo la extensión "vss-web" del publicador "ms" puede hacer referencia a esto.

ExtensionEventCallback

Clase base para una devolución de llamada de evento para una extensión

Nombre	Tipo	Description
uri	string	URI del punto de conexión que se alcanza cuando se produce un evento

ExtensionEventCallbackCollection

Colección de devoluciones de llamada de eventos: puntos de conexión a los que se llama cuando se producen eventos de extensión concretos.

Nombre	Tipo	Description
postDisable	ExtensionEventCallback	Opcional. Define un punto de conexión al que se llama a través de una solicitud POST para notificar que se ha producido una deshabilitación de extensión.
postEnable	ExtensionEventCallback	Opcional. Define un punto de conexión al que se llama a través de una solicitud POST para notificar que se ha producido una habilitación de extensión.
postInstall	ExtensionEventCallback	Opcional. Define un punto de conexión al que se llama a través de una solicitud POST para notificar que se ha completado una instalación de extensión.
postUninstall	ExtensionEventCallback	Opcional. Define un punto de conexión al que se llama a través de una solicitud POST para notificar que se ha producido una desinstalación de extensión.
postUpdate	ExtensionEventCallback	Opcional. Define un punto de conexión al que se llama a través de una solicitud POST para notificar que se ha producido una actualización de extensión.
preInstall	ExtensionEventCallback	Opcional. Define un punto de conexión al que se llama a través de una solicitud POST para notificar que se va a producir una instalación de extensión. La respuesta indica si se debe continuar o anular.
versionCheck	ExtensionEventCallback	Para las extensiones de varias versiones, define un punto de conexión al que se llama a través de una solicitud OPTIONS para determinar la versión concreta de la extensión que se va a usar.

ExtensionFile

Nombre	Tipo	Description
assetType	string
language	string
source	string

ExtensionFlags

Marcas de extensión relevantes para los consumidores de contribución

Nombre	Tipo	Description
builtIn	string	Se instala una extensión integrada para todas las cuentas de VSTS de forma predeterminada.
trusted	string	La extensión procede de un publicador de plena confianza

ExtensionLicensing

Cómo debe controlar una extensión, incluidas las contribuciones basadas en licencias

Nombre	Tipo	Description
overrides	LicensingOverride[]	Lista de contribuciones que se desvía del comportamiento de licencia predeterminado

ExtensionStateFlags

Estados de una extensión instalada

Nombre	Tipo	Description
autoUpgradeError	string	Error al realizar la actualización automática. Por ejemplo, si la nueva versión no admite la extensión, no se puede actualizar automáticamente.
builtIn	string	La extensión es un elemento integrado
disabled	string	La extensión está deshabilitada
error	string	La extensión se encuentra actualmente en un estado de error
multiVersion	string	La extensión tiene varias versiones
needsReauthorization	string	Los ámbitos de extensión han cambiado y la extensión requiere volver a autorizar
none	string	No se estableció ninguna marca
trusted	string	Las extensiones de confianza son las que tienen funcionalidades especiales. Estos tienden a provenir de Microsoft y no pueden publicarse por el público general. Nota: Las extensiones builtIn siempre son de confianza.
unInstalled	string	La extensión no está instalada. Esto es solo para extensiones integradas y no se puede establecer de otro modo.
versionCheckError	string	Error al realizar la comprobación de versiones
warning	string	La extensión se encuentra actualmente en un estado de advertencia, lo que puede provocar una experiencia degradada. La experiencia degradada puede deberse, por ejemplo, a algunos problemas de instalación detectados, como demandas implícitas no admitidas.