Installed Extensions - Install Extension By Name

參考

Service:: Extension Management

API Version:: 6.0-preview.1

將指定的延伸模組安裝到帳戶/專案集合中。

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

URI 參數

名稱	位於	必要	類型	Description
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。

回應

名稱	類型	Description
200 OK	InstalledExtension	成功的作業

安全性

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

名稱	Description
vso.extension_manage	授與在已安裝擴充功能上安裝、卸載和執行其他系統管理動作的能力。

範例

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"
}

定義

名稱	Description
Contribution	延伸模組所做的個別貢獻
ContributionConstraint	指定可用來動態包含/排除指定貢獻的條件約束
ContributionLicensingBehaviorType	納入此貢獻的方式應該如何根據授權而變更
ContributionPropertyDescription	關於參與類型之屬性的描述
ContributionPropertyType	這個屬性所使用的值型別
ContributionType	json 架構所提供的貢獻類型
ExtensionEventCallback	擴充功能之事件回呼的基類
ExtensionEventCallbackCollection	事件回呼集合 - 發生特定擴充事件時所呼叫的端點。
ExtensionFile
ExtensionFlags	與貢獻取用者相關的延伸模組旗標
ExtensionLicensing	延伸模組應該如何處理以授權為基礎的參與
ExtensionStateFlags	已安裝延伸模組的狀態
InstalledExtension	代表 VSTS 延伸模組及其安裝狀態
InstalledExtensionState	已安裝延伸模組的狀態
InstalledExtensionStateIssue	代表安裝問題
InstalledExtensionStateIssueType	安裝問題類型 (警告、錯誤)
JObject	表示 JSON 物件。
LicensingOverride	將參與對應至授權行為

Contribution

延伸模組所做的個別貢獻

名稱	類型	Description
constraints	ContributionConstraint[]	套用至此貢獻可用性的條件約束清單 (篩選準則)
description	string	貢獻/類型的描述
id	string	貢獻/類型的完整識別碼
includes	string[]	Include 是一組應該在其目標清單中包含此貢獻的參與。
properties	JObject	此貢獻的屬性/屬性
restrictedTo	string[]	要求宣告的清單，讓使用者看到此貢獻 (，例如匿名、公用、成員...) 。
targets	string[]	此貢獻目標 () 的貢獻識別碼。 (父貢獻)
type	string	貢獻類型的識別碼
visibleTo	string[]	VisibleTo 可用來限制可參考指定貢獻/類型的人員。此值應該是發行者或延伸模組存取的清單也會受到限制。範例：「ms」 - 表示只有「ms」發行者可以參考此專案。「ms.vss-web」 - 表示只有「ms」發行者的「vss-web」延伸模組可以參考此專案。

ContributionConstraint

指定可用來動態包含/排除指定貢獻的條件約束

名稱	類型	Description
group	integer	可指定以將條件約束群組在一起的選擇性屬性。群組中的所有條件約束都是 AND 一起 (所有條件約束都必須評估為 True，才能將貢獻包含在) 。不同的條件約束群組是 OR'd (只有一個群組需要評估為 True，才能將貢獻包含在) 。
id	string	共用條件約束的完整識別碼
inverse	boolean	如果為 true，則如果套用的篩選傳回 false，則否定篩選準則的結果 (包含貢獻，而不是 true)
name	string	IContributionFilter 外掛程式的名稱
properties	JObject	提供給貢獻篩選類別的屬性
relationships	string[]	條件約束可以選擇性地套用至貢獻中所定義的一或多個關聯性。如果未定義任何關聯性，則所有關聯性都會與條件約束相關聯。這表示如果套用條件約束，預設行為將會完全排除樹狀結構中的貢獻。

ContributionLicensingBehaviorType

納入此貢獻的方式應該如何根據授權而變更

名稱	類型	Description
alwaysInclude	string	不論使用者是否獲得授權，一律包含貢獻
onlyIfLicensed	string	預設值 - 只有在使用者獲得擴充功能的授權時，才包含貢獻
onlyIfUnlicensed	string	只有在使用者未獲得延伸模組授權時，才包含貢獻

ContributionPropertyDescription

關於參與類型之屬性的描述

名稱	類型	Description
description	string	屬性的描述
name	string	屬性的名稱
required	boolean	如果需要此屬性，則為 True
type	ContributionPropertyType	這個屬性所使用的值型別

ContributionPropertyType

這個屬性所使用的值型別

名稱	類型	Description
array	string	值是陣列
boolean	string	值為 True 或 False
dateTime	string	Value 是 DateTime 物件
dictionary	string	值是泛型 Dictionary/JObject/property bag
double	string	值為雙精度浮點數
guid	string	值是 GUID
integer	string	值是整數
object	string	值是任意/自訂物件
string	string	值是字串
unknown	string	貢獻類型未知 (值可能是任何)
uri	string	值是 URI

ContributionType

json 架構所提供的貢獻類型

名稱	類型	Description
description	string	貢獻/類型的描述
id	string	貢獻/類型的完整識別碼
indexed	boolean	控制此類型的參與是否具有為查詢編制索引的類型。這可讓用戶端尋找具有此類型貢獻的所有延伸模組。注意：只允許 TrustedPartners 指定索引參與類型。
name	string	貢獻/類型的易記名稱
properties	<string, ContributionPropertyDescription>	描述此貢獻類型的允許屬性
visibleTo	string[]	VisibleTo 可用來限制可參考指定貢獻/類型的人員。此值應該是發行者或延伸模組存取的清單也會受到限制。範例：「ms」 - 表示只有「ms」發行者可以參考此專案。「ms.vss-web」 - 表示只有「ms」發行者的「vss-web」延伸模組可以參考此專案。

ExtensionEventCallback

擴充功能之事件回呼的基類

名稱	類型	Description
uri	string	事件發生時所叫用端點的 URI

ExtensionEventCallbackCollection

事件回呼集合 - 發生特定擴充事件時所呼叫的端點。

名稱	類型	Description
postDisable	ExtensionEventCallback	選擇性。定義透過 POST 要求呼叫的端點，以通知延伸模組已停用。
postEnable	ExtensionEventCallback	選擇性。定義透過 POST 要求呼叫的端點，以通知延伸模組已啟用已發生。
postInstall	ExtensionEventCallback	選擇性。定義透過 POST 要求呼叫的端點，以通知延伸模組安裝已完成。
postUninstall	ExtensionEventCallback	選擇性。定義透過 POST 要求呼叫的端點，以通知延伸模組卸載已發生。
postUpdate	ExtensionEventCallback	選擇性。定義透過 POST 要求呼叫的端點，以通知已發生擴充功能更新。
preInstall	ExtensionEventCallback	選擇性。定義透過 POST 要求呼叫的端點，以通知即將發生擴充功能安裝。回應指出是否要繼續或中止。
versionCheck	ExtensionEventCallback	針對多版本延伸模組，定義透過 OPTIONS 要求呼叫的端點，以判斷要使用的擴充功能特定版本

ExtensionFile

名稱	類型	Description
assetType	string
language	string
source	string

ExtensionFlags

與貢獻取用者相關的延伸模組旗標

名稱	類型	Description
builtIn	string	預設會為所有 VSTS 帳戶安裝內建擴充功能
trusted	string	擴充功能來自完全信任的發行者

ExtensionLicensing

延伸模組應該如何處理以授權為基礎的參與

名稱	類型	Description
overrides	LicensingOverride[]	與預設授權行為相隔的參與清單

ExtensionStateFlags

已安裝延伸模組的狀態

名稱	類型	Description
autoUpgradeError	string	執行自動升級時發生錯誤。例如，如果新版本的需求不受支援，則無法自動升級擴充功能。
builtIn	string	擴充功能是內建的
disabled	string	擴充功能已停用
error	string	擴充功能目前處於錯誤狀態
multiVersion	string	延伸模組有多個版本
needsReauthorization	string	延伸模組範圍已變更，且擴充功能需要重新授權
none	string	未設定旗標
trusted	string	信任的擴充功能是提供特殊功能的擴充功能。這些通常來自 Microsoft，且無法由一般大眾發佈。注意：BuiltIn 延伸模組一律受信任。
unInstalled	string	未安裝擴充功能。這僅適用于內建延伸模組，否則無法設定。
versionCheckError	string	執行版本檢查時發生錯誤
warning	string	擴充功能目前處於警告狀態，這可能會導致體驗降級。降級的體驗可能是由偵測到的某些安裝問題所造成，例如不支援隱含需求。