Installed Extensions - Install Extension By Name

Referência

Service:: Extension Management

API Version:: 6.0-preview.1

Instale a extensão especificada na coleção account/project.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
extensionName	path	True	string	Nome da extensão. Exemplo: "ops-tools".
organization	path	True	string	O nome da organização do Azure DevOps.
publisherName	path	True	string	Nome do editor. Exemplo: "fabrikam".
version	path		string
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '6.0-preview.1' para usar essa versão da API.

Respostas

Nome	Tipo	Description
200 OK	InstalledExtension	operação bem-sucedida

Segurança

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	Description
vso.extension_manage	Concede a capacidade de instalar, desinstalar e executar outras ações administrativas em extensões instaladas.

Exemplos

Sample Request

HTTP

POST 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",
  "installState": {
    "flags": "none",
    "lastUpdated": "2017-11-30T21:38:02.463Z"
  },
  "lastPublished": "2017-01-19T13:28:00.85Z"
}

Definições

Nome	Description
Contribution	Uma contribuição individual feita por uma extensão
ContributionConstraint	Especifica uma restrição que pode ser usada para incluir/excluir dinamicamente uma determinada contribuição
ContributionLicensingBehaviorType	Como a inclusão dessa contribuição deve mudar com base no licenciamento
ContributionPropertyDescription	Descrição sobre uma propriedade de um tipo de contribuição
ContributionPropertyType	O tipo de valor usado para esta propriedade
ContributionType	Um tipo de contribuição, fornecido por um esquema json
ExtensionEventCallback	Classe base para um retorno de chamada de evento para uma extensão
ExtensionEventCallbackCollection	Coleção de retornos de chamada de evento – pontos de extremidade chamados quando ocorrem eventos de extensão específicos.
ExtensionFile
ExtensionFlags	Sinalizadores de extensão relevantes para consumidores de contribuição
ExtensionLicensing	Como uma extensão deve lidar com a inclusão de contribuições com base no licenciamento
ExtensionStateFlags	Estados de uma extensão instalada
InstalledExtension	Representa uma extensão do VSTS junto com seu estado de instalação
InstalledExtensionState	O estado de uma extensão instalada
InstalledExtensionStateIssue	Representa um problema de instalação
InstalledExtensionStateIssueType	Tipo de problema de instalação (Aviso, Erro)
JObject	Representa um objeto JSON.
LicensingOverride	Mapeia uma contribuição para um comportamento de licenciamento

Contribution

Uma contribuição individual feita por uma extensão

Nome	Tipo	Description
constraints	ContributionConstraint[]	Lista de restrições (filtros) que devem ser aplicadas à disponibilidade dessa contribuição
description	string	Descrição da contribuição/tipo
id	string	Identificador totalmente qualificado da contribuição/tipo
includes	string[]	Includes é um conjunto de contribuições que deve ter essa contribuição incluída em sua lista de destinos.
properties	JObject	Propriedades/atributos dessa contribuição
restrictedTo	string[]	Lista de declarações solicitadas para que o usuário veja essa contribuição (como anônimo, público, membro...).
targets	string[]	As IDs das contribuições direcionadas a essa contribuição. (contribuições pai)
type	string	ID do tipo de contribuição
visibleTo	string[]	VisibleTo pode ser usado para restringir quem pode referenciar uma determinada contribuição/tipo. Esse valor deve ser uma lista de editores ou o acesso a extensões também é restrito. Exemplos: "ms" – significa que somente o editor "ms" pode fazer referência a isso. "ms.vss-web" – significa que somente a extensão "vss-web" do editor "ms" pode fazer referência a isso.

ContributionConstraint

Especifica uma restrição que pode ser usada para incluir/excluir dinamicamente uma determinada contribuição

Nome	Tipo	Description
group	integer	Uma propriedade opcional que pode ser especificada para agrupar restrições. Todas as restrições dentro de um grupo são AND'd juntas (todas devem ser avaliadas como True para que a contribuição seja incluída). Diferentes grupos de restrições são OR'd (apenas um grupo precisa ser avaliado como True para que a contribuição seja incluída).
id	string	Identificador totalmente qualificado de uma restrição compartilhada
inverse	boolean	Se for true, negue o resultado do filtro (inclua a contribuição se o filtro aplicado retornar false em vez de true)
name	string	Nome do plug-in IContributionFilter
properties	JObject	Propriedades que são alimentadas para a classe de filtro de contribuição
relationships	string[]	Opcionalmente, as restrições podem ser aplicadas a uma ou mais das relações definidas na contribuição. Se nenhuma relação for definida, todas as relações serão associadas à restrição. Isso significa que o comportamento padrão eliminará completamente a contribuição da árvore se a restrição for aplicada.

ContributionLicensingBehaviorType

Como a inclusão dessa contribuição deve mudar com base no licenciamento

Nome	Tipo	Description
alwaysInclude	string	Sempre inclua a contribuição, independentemente de o usuário ser licenciado ou não para a extensão
onlyIfLicensed	string	Valor padrão – inclua apenas a contribuição se o usuário estiver licenciado para a extensão
onlyIfUnlicensed	string	Inclua apenas a contribuição se o usuário NÃO estiver licenciado para a extensão

ContributionPropertyDescription

Descrição sobre uma propriedade de um tipo de contribuição

Nome	Tipo	Description
description	string	Descrição da propriedade
name	string	Nome da propriedade
required	boolean	True se essa propriedade for necessária
type	ContributionPropertyType	O tipo de valor usado para esta propriedade

ContributionPropertyType

O tipo de valor usado para esta propriedade

Nome	Tipo	Description
array	string	O valor é uma matriz
boolean	string	O valor é True ou False
dateTime	string	Value é um objeto DateTime
dictionary	string	O valor é um dicionário/JObject/recipiente de propriedades genérico
double	string	O valor é um duplo
guid	string	O valor é um GUID
integer	string	O valor é um inteiro
object	string	Value é um objeto arbitrário/personalizado
string	string	O valor é uma cadeia de caracteres
unknown	string	O tipo de contribuição é desconhecido (o valor pode ser qualquer coisa)
uri	string	O valor é um URI

ContributionType

Um tipo de contribuição, fornecido por um esquema json

Nome	Tipo	Description
description	string	Descrição da contribuição/tipo
id	string	Identificador totalmente qualificado da contribuição/tipo
indexed	boolean	Controla se contribuições desse tipo têm ou não o tipo indexado para consultas. Isso permite que os clientes encontrem todas as extensões que têm uma contribuição desse tipo. OBSERVAÇÃO: somente TrustedPartners têm permissão para especificar tipos de contribuição indexados.
name	string	Nome amigável da contribuição/tipo
properties	<string, ContributionPropertyDescription>	Descreve as propriedades permitidas para esse tipo de contribuição
visibleTo	string[]	VisibleTo pode ser usado para restringir quem pode referenciar uma determinada contribuição/tipo. Esse valor deve ser uma lista de editores ou o acesso a extensões também é restrito. Exemplos: "ms" – significa que somente o editor "ms" pode fazer referência a isso. "ms.vss-web" – significa que somente a extensão "vss-web" do editor "ms" pode fazer referência a isso.

ExtensionEventCallback

Classe base para um retorno de chamada de evento para uma extensão

Nome	Tipo	Description
uri	string	O URI do ponto de extremidade que é atingido quando ocorre um evento

ExtensionEventCallbackCollection

Coleção de retornos de chamada de evento – pontos de extremidade chamados quando ocorrem eventos de extensão específicos.

Nome	Tipo	Description
postDisable	ExtensionEventCallback	Opcional. Define um ponto de extremidade que é chamado por meio de uma solicitação POST para notificar que ocorreu uma desabilitação de extensão.
postEnable	ExtensionEventCallback	Opcional. Define um ponto de extremidade que é chamado por meio de uma solicitação POST para notificar que ocorreu uma habilitação de extensão.
postInstall	ExtensionEventCallback	Opcional. Define um ponto de extremidade que é chamado por meio de uma solicitação POST para notificar que uma instalação de extensão foi concluída.
postUninstall	ExtensionEventCallback	Opcional. Define um ponto de extremidade que é chamado por meio de uma solicitação POST para notificar que ocorreu uma desinstalação de extensão.
postUpdate	ExtensionEventCallback	Opcional. Define um ponto de extremidade que é chamado por meio de uma solicitação POST para notificar que ocorreu uma atualização de extensão.
preInstall	ExtensionEventCallback	Opcional. Define um ponto de extremidade que é chamado por meio de uma solicitação POST para notificar que uma instalação de extensão está prestes a ocorrer. A resposta indica se deve prosseguir ou anular.
versionCheck	ExtensionEventCallback	Para extensões de várias versões, define um ponto de extremidade que é chamado por meio de uma solicitação OPTIONS para determinar a versão específica da extensão a ser usada

ExtensionFile

Nome	Tipo	Description
assetType	string
language	string
source	string

ExtensionFlags

Sinalizadores de extensão relevantes para consumidores de contribuição

Nome	Tipo	Description
builtIn	string	Uma extensão interna é instalada para todas as contas do VSTS por padrão
trusted	string	A extensão vem de um editor totalmente confiável

ExtensionLicensing

Como uma extensão deve lidar com a inclusão de contribuições com base no licenciamento

Nome	Tipo	Description
overrides	LicensingOverride[]	Uma lista de contribuições que se desviam do comportamento de licenciamento padrão

ExtensionStateFlags

Estados de uma extensão instalada

Nome	Tipo	Description
autoUpgradeError	string	Erro ao executar a atualização automática. Por exemplo, se a nova versão tiver demandas sem suporte, a extensão não poderá ser atualizada automaticamente.
builtIn	string	A extensão é interna
disabled	string	A extensão está desabilitada
error	string	A extensão está atualmente em um estado de erro
multiVersion	string	A extensão tem várias versões
needsReauthorization	string	Os escopos de extensão foram alterados e a extensão requer nova autorização
none	string	Nenhum sinalizador definido
trusted	string	Extensões confiáveis são as que recebem recursos especiais. Eles tendem a vir da Microsoft e não podem ser publicados pelo público em geral. Observação: as extensões BuiltIn são sempre confiáveis.
unInstalled	string	A extensão não está instalada. Isso é apenas para extensões internas e não pode ser definido de outra forma.
versionCheckError	string	Erro ao executar marcar de versão
warning	string	A extensão está atualmente em um estado de aviso, o que pode causar uma experiência degradada. A experiência degradada pode ser causada, por exemplo, por alguns problemas de instalação detectados, como demandas implícitas sem suporte.