Installed Extensions - Install Extension By Name

参考

服务:: Extension Management

API 版本:: 6.0-preview.1

将指定的扩展安装到帐户/项目集合中。

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

URI 参数

名称	在	必需	类型	说明
extensionName	path	True	string	扩展名。示例：“ops-tools”。
organization	path	True	string	Azure DevOps 组织的名称。
publisherName	path	True	string	发布者的名称。示例：“fabrikam”。
version	path		string
api-version	query	True	string	要使用的 API 版本。应将其设置为“6.0-preview.1”才能使用此版本的 API。

响应

名称	类型	说明
200 OK	InstalledExtension	成功的操作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称	说明
vso.extension_manage	授予安装、卸载和对已安装扩展执行其他管理操作的能力。

示例

示例请求

HTTP

POST https://extmgmt.dev.azure.com/fabrikam/_apis/extensionmanagement/installedextensionsbyname/ms/samples-contributions-guide?api-version=6.0-preview.1

示例响应

状态代码:: 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"
}

定义

名称	说明
Contribution	扩展的个人贡献
ContributionConstraint	指定可用于动态包含/排除给定贡献的约束
ContributionLicensingBehaviorType	此贡献的包含应如何根据许可而变化
ContributionPropertyDescription	有关贡献类型的属性的说明
ContributionPropertyType	用于此属性的值的类型
ContributionType	贡献类型，由 json 架构提供
ExtensionEventCallback	扩展的事件回调的基类
ExtensionEventCallbackCollection	事件回调的集合 - 发生特定扩展事件时调用的终结点。
ExtensionFile
ExtensionFlags	与贡献使用者相关的扩展标志
ExtensionLicensing	扩展应如何处理基于许可的包括贡献
ExtensionStateFlags	已安装扩展的状态
InstalledExtension	表示 VSTS 扩展及其安装状态
InstalledExtensionState	已安装扩展的状态
InstalledExtensionStateIssue	表示安装问题
InstalledExtensionStateIssueType	安装问题类型 (警告、错误)
JObject	表示 JSON 对象。
LicensingOverride	将贡献映射到许可行为

Contribution

Object

扩展的个人贡献

名称	类型	说明
constraints	ContributionConstraint[]	应应用于此贡献可用性的约束 (筛选器) 列表
description	string	贡献/类型的说明
id	string	贡献/类型的完全限定标识符
includes	string[]	Include 是一组贡献，应将此贡献包含在其目标列表中。
properties	JObject	此贡献的属性/属性
restrictedTo	string[]	要求声明的列表，以便用户查看此贡献 (匿名、公共、成员...) 。
targets	string[]	此贡献目标 () 的 ID。 (家长贡献)
type	string	贡献类型的 ID
visibleTo	string[]	VisibleTo 可用于限制谁可以引用给定的贡献/类型。此值应为发布者列表，或者扩展访问也受到限制。示例：“ms”- 表示只有“ms”发布者可以引用此。 “ms.vss-web” - 表示只有“ms”发布者的“vss-web”扩展可以引用此内容。

ContributionConstraint

Object

指定可用于动态包含/排除给定贡献的约束

名称	类型	说明
group	integer	一个可选属性，可以指定用于将约束组合在一起。组中的所有约束都是 AND 在一起 (所有约束都必须评估为 True，才能将贡献包含在) 。不同的约束组是 OR'd (只有一个组需要评估为 True，才能将贡献包含在) 。
id	string	共享约束的完全限定标识符
inverse	boolean	如果为 true，则否定筛选器的结果， (如果应用的筛选器返回 false 而不是 true，则包括贡献)
name	string	IContributionFilter 插件的名称
properties	JObject	馈送给贡献筛选器类的属性
relationships	string[]	可以选择性地将约束应用于贡献中定义的一个或多个关系。如果未定义任何关系，则所有关系都与约束相关联。这意味着，如果应用约束，默认行为将完全消除树的贡献。

ContributionLicensingBehaviorType

Enumeration

此贡献的包含应如何根据许可而变化

值	说明
alwaysInclude	无论用户是否获得扩展许可，始终包括贡献
onlyIfLicensed	默认值 - 仅当用户获得扩展许可时，才包括贡献
onlyIfUnlicensed	仅当用户未获得扩展许可时，才包括贡献

ContributionPropertyDescription

Object

有关贡献类型的属性的说明

名称	类型	说明
description	string	属性的说明
name	string	属性的名称
required	boolean	如果此属性是必需的，则为 True
type	ContributionPropertyType	用于此属性的值的类型

ContributionPropertyType

Enumeration

用于此属性的值的类型

值	说明
array	值是数组
boolean	值为 True 或 False
dateTime	Value 是 DateTime 对象
dictionary	值是泛型 Dictionary/JObject/property 包
double	值是双精度值
guid	值是 GUID
integer	值是整数
object	值是任意/自定义对象
string	值是字符串
unknown	贡献类型未知 (值可以是任何)
uri	值是 URI

ContributionType

Object

贡献类型，由 json 架构提供

名称	类型	说明
description	string	贡献/类型的说明
id	string	贡献/类型的完全限定标识符
indexed	boolean	控制此类型的贡献是否为查询编制了类型索引。这允许客户端查找具有此类型贡献的所有扩展。注意：仅允许 TrustedPartners 指定索引贡献类型。
name	string	贡献/类型的友好名称
properties	<string, ContributionPropertyDescription>	描述此贡献类型的允许属性
visibleTo	string[]	VisibleTo 可用于限制谁可以引用给定的贡献/类型。此值应为发布者列表，或者扩展访问也受到限制。示例：“ms”- 表示只有“ms”发布者可以引用此。 “ms.vss-web” - 表示只有“ms”发布者的“vss-web”扩展可以引用此内容。

ExtensionEventCallback

Object

扩展的事件回调的基类

名称	类型	说明
uri	string	事件发生时命中的终结点的 URI

ExtensionEventCallbackCollection

Object

事件回调的集合 - 发生特定扩展事件时调用的终结点。

名称	类型	说明
postDisable	ExtensionEventCallback	可选。定义一个终结点，该终结点通过 POST 请求调用，以通知扩展禁用已发生。
postEnable	ExtensionEventCallback	可选。定义一个终结点，该终结点通过 POST 请求调用，以通知已启用扩展。
postInstall	ExtensionEventCallback	可选。定义一个终结点，该终结点通过 POST 请求调用，以通知扩展安装已完成。
postUninstall	ExtensionEventCallback	可选。定义一个终结点，该终结点通过 POST 请求调用，以通知扩展卸载已发生。
postUpdate	ExtensionEventCallback	可选。定义通过 POST 请求调用的终结点，以通知扩展更新已发生。
preInstall	ExtensionEventCallback	可选。定义通过 POST 请求调用的终结点，以通知即将进行扩展安装。响应指示是继续还是中止。
versionCheck	ExtensionEventCallback	对于多版本扩展，定义通过 OPTIONS 请求调用的终结点，以确定要使用的扩展的特定版本

ExtensionFile

Object

名称	类型	说明
assetType	string
language	string
source	string

ExtensionFlags

Enumeration

与贡献使用者相关的扩展标志

值	说明
builtIn	默认情况下，为所有 VSTS 帐户安装内置扩展
trusted	扩展来自完全受信任的发布者

ExtensionLicensing

Object

扩展应如何处理基于许可的包括贡献

名称	类型	说明
overrides	LicensingOverride[]	与默认许可行为不同的贡献列表

ExtensionStateFlags

Enumeration

已安装扩展的状态

值	说明
autoUpgradeError	执行自动升级时出错。例如，如果新版本要求不支持该扩展，则无法自动升级。
builtIn	扩展是内置的
disabled	扩展已禁用
error	扩展当前处于错误状态
multiVersion	扩展具有多个版本
needsReauthorization	扩展范围已更改，扩展需要重新授权
none	未设置标志
trusted	受信任的扩展是具有特殊功能的扩展。这些内容往往来自 Microsoft，不能由公众发布。注意：内置扩展始终受信任。
unInstalled	未安装扩展。这仅适用于内置扩展，否则无法进行设置。
versionCheckError	执行版本检查时出错
warning	扩展当前处于警告状态，这可能会导致体验降级。降级的体验可能是由检测到的某些安装问题（例如不支持的隐式需求）引起的。