Installed Extensions - Get
Obtenha uma extensão instalada pelo editor e pelo nome da extensão.
GET https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensionsbyname/{publisherName}/{extensionName}?api-version=6.0-preview.1GET https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensionsbyname/{publisherName}/{extensionName}?assetTypes={assetTypes}&api-version=6.0-preview.1Parâmetros de URI
| Nome | Em | Obrigatório | Tipo | Description |
|---|---|---|---|---|
|
extension
|
path | True |
string |
Nome da extensão. Exemplo: "ops-tools". |
|
organization
|
path | True |
string |
O nome da organização do Azure DevOps. |
|
publisher
|
path | True |
string |
Nome do editor. Exemplo: "fabrikam". |
|
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. |
|
asset
|
query |
string array (string) |
Respostas
| Nome | Tipo | Description |
|---|---|---|
| 200 OK |
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
GET https://extmgmt.dev.azure.com/fabrikam/_apis/extensionmanagement/installedextensionsbyname/ms/samples-contributions-guide?api-version=6.0-preview.1
Sample Response
{
"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": []
}Definições
| Nome | Description |
|---|---|
| Contribution |
Uma contribuição individual feita por uma extensão |
|
Contribution |
Especifica uma restrição que pode ser usada para incluir/excluir dinamicamente uma determinada contribuição |
|
Contribution |
Como a inclusão dessa contribuição deve mudar com base no licenciamento |
|
Contribution |
Descrição sobre uma propriedade de um tipo de contribuição |
|
Contribution |
O tipo de valor usado para esta propriedade |
|
Contribution |
Um tipo de contribuição, fornecido por um esquema json |
|
Extension |
Classe base para um retorno de chamada de evento para uma extensão |
|
Extension |
Coleção de retornos de chamada de evento – pontos de extremidade chamados quando eventos de extensão específicos ocorrem. |
|
Extension |
|
|
Extension |
Sinalizadores de extensão relevantes para consumidores de contribuição |
|
Extension |
Como uma extensão deve lidar com a inclusão de contribuições com base no licenciamento |
|
Extension |
Estados de uma extensão instalada |
|
Installed |
Representa uma extensão VSTS junto com seu estado de instalação |
|
Installed |
O estado de uma extensão instalada |
|
Installed |
Representa um problema de instalação |
|
Installed |
Tipo de problema de instalação (Aviso, Erro) |
| JObject |
Representa um objeto JSON. |
|
Licensing |
Mapeia uma contribuição para um comportamento de licenciamento |
Contribution
Uma contribuição individual feita por uma extensão
| Nome | Tipo | Description |
|---|---|---|
| constraints |
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 devem ter essa contribuição incluída em sua lista de destinos. |
| properties |
Propriedades/atributos dessa contribuição |
|
| restrictedTo |
string[] |
Lista de declarações exigidas 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 fazer referência a 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 em 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, anule 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 |
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 estar 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 |
O tipo de valor usado para esta propriedade |
ContributionPropertyType
O tipo de valor usado para esta propriedade
| Nome | Tipo | Description |
|---|---|---|
| array |
string |
Value é uma matriz |
| boolean |
string |
O valor é True ou False |
| dateTime |
string |
Value é um objeto DateTime |
| dictionary |
string |
Value é 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 |
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,
Contribution |
Descreve as propriedades permitidas para esse tipo de contribuição |
| visibleTo |
string[] |
VisibleTo pode ser usado para restringir quem pode fazer referência a 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 eventos de extensão específicos ocorrem.
| Nome | Tipo | Description |
|---|---|---|
| postDisable |
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 |
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 |
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 |
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 |
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 |
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 deseja continuar ou anular. |
|
| versionCheck |
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 |
Por padrão, uma extensão interna é instalada para todas as contas do VSTS |
| 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 |
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 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 serve 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. |
InstalledExtension
Representa uma extensão VSTS junto com seu estado de instalação
| Nome | Tipo | Description |
|---|---|---|
| baseUri |
string |
Uri usado como base para outros uri relativos definidos na extensão |
| constraints |
Lista de restrições compartilhadas definidas por essa extensão |
|
| contributionTypes |
Lista de tipos de contribuição definidos por essa extensão |
|
| contributions |
Lista de contribuições feita por essa extensão |
|
| demands |
string[] |
Lista de demandas explícitas exigidas por essa extensão |
| eventCallbacks |
Coleção de pontos de extremidade que são chamados quando ocorrem eventos de extensão específicos |
|
| extensionId |
string |
A ID de extensão amigável para essa extensão – exclusiva para um determinado editor. |
| extensionName |
string |
O nome de exibição da extensão. |
| fallbackBaseUri |
string |
Local secundário que pode ser usado como base para outros uris relativos definidos na extensão |
| files |
Esse é o conjunto de arquivos disponíveis na extensão. |
|
| flags |
Sinalizadores de extensão relevantes para consumidores de contribuição |
|
| installState |
Informações sobre essa instalação específica da extensão |
|
| language |
string |
Nome da Cultura da Linguagem definido pela Galeria |
| lastPublished |
string |
Isso representa a data/hora em que as extensões foram atualizadas pela última vez na galeria. Isso não significa que essa versão foi atualizada, o valor representa alterações em todas as versões da extensão. |
| licensing |
Como essa extensão se comporta em relação ao licenciamento |
|
| manifestVersion |
number |
Versão do formato/conteúdo do manifesto da extensão |
| publisherId |
string |
ID exclusiva do editor desta extensão |
| publisherName |
string |
O nome de exibição do editor |
| registrationId |
string |
ID exclusiva para essa extensão (a mesma ID é usada para todas as versões de uma única extensão) |
| restrictedTo |
string[] |
Declarações de usuário padrão aplicadas a todas as contribuições (exceto as que foram especificadas de forma restritaTo explicitamente) para controlar a visibilidade de uma contribuição. |
| scopes |
string[] |
Lista de todos os escopos de oauth exigidos por essa extensão |
| serviceInstanceType |
string |
O ServiceInstanceType(Guid) do serviço VSTS que deve estar disponível para uma conta para que a extensão seja instalada |
| version |
string |
Versão dessa extensão |
InstalledExtensionState
O estado de uma extensão instalada
| Nome | Tipo | Description |
|---|---|---|
| flags |
Estados de uma extensão instalada |
|
| installationIssues |
Lista de problemas de instalação |
|
| lastUpdated |
string |
A hora em que esta instalação foi atualizada pela última vez |
InstalledExtensionStateIssue
Representa um problema de instalação
| Nome | Tipo | Description |
|---|---|---|
| message |
string |
A mensagem de erro |
| source |
string |
Origem do problema de instalação, por exemplo, "Demandas" |
| type |
Tipo de problema de instalação (Aviso, Erro) |
InstalledExtensionStateIssueType
Tipo de problema de instalação (Aviso, Erro)
| Nome | Tipo | Description |
|---|---|---|
| error |
string |
Representa um erro de instalação, por exemplo, uma demanda explícita sem suporte |
| warning |
string |
Representa um aviso de instalação, por exemplo, uma demanda implícita sem suporte |
JObject
Representa um objeto JSON.
| Nome | Tipo | Description |
|---|---|---|
| item |
string |
|
| type |
string |
Obtém o tipo de nó para este JToken. |
LicensingOverride
Mapeia uma contribuição para um comportamento de licenciamento
| Nome | Tipo | Description |
|---|---|---|
| behavior |
Como a inclusão dessa contribuição deve mudar com base no licenciamento |
|
| id |
string |
ID de contribuição totalmente qualificada para a qual queremos definir o comportamento de licenciamento |