Installed Extensions - Get

リファレンス

Service:: Extension Management

API Version:: 6.0-preview.1

インストールされている拡張機能を、その発行元と拡張機能の名前で取得します。

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

URI パラメーター

名前	/	必須	型	説明
extensionName	path	True	string	拡張機能の名前。例: "ops-tools"
organization	path	True	string	Azure DevOps 組織の名前です。
publisherName	path	True	string	発行元の名前。例: "fabrikam"
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '6.0-preview.1' に設定する必要があります。
assetTypes	query		string array (string)

応答

名前	型	説明
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

名前	説明
vso.extension_manage	インストールされている拡張機能に対して、インストール、アンインストール、その他の管理アクションを実行する機能を付与します。

例

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

定義

名前	説明
Contribution	拡張機能によって行われた個々の貢献
ContributionConstraint	特定のコントリビューションを動的に含める/除外するために使用できる制約を指定します
ContributionLicensingBehaviorType	ライセンスに基づいてこのコントリビューションを含める方法
ContributionPropertyDescription	コントリビューション型のプロパティに関する説明
ContributionPropertyType	このプロパティに使用される値の型
ContributionType	json スキーマによって指定されるコントリビューション型
ExtensionEventCallback	拡張機能のイベントコールバックの基本クラス
ExtensionEventCallbackCollection	イベントコールバックのコレクション - 特定の拡張イベントが発生したときに呼び出されるエンドポイント。
ExtensionFile
ExtensionFlags	コントリビューションコンシューマーに関連する拡張機能フラグ
ExtensionLicensing	ライセンスに基づくコントリビューションを含む拡張機能の処理方法
ExtensionStateFlags	インストールされている拡張機能の状態
InstalledExtension	VSTS 拡張機能とそのインストール状態を表します
InstalledExtensionState	インストールされている拡張機能の状態
InstalledExtensionStateIssue	インストールの問題を表します
InstalledExtensionStateIssueType	インストールの問題の種類 (警告、エラー)
JObject	JSON オブジェクトを表します。
LicensingOverride	ライセンス動作へのコントリビューションをマップする

Contribution

拡張機能によって行われた個々の貢献

名前	型	説明
constraints	ContributionConstraint[]	このコントリビューションの可用性に適用する必要がある制約 (フィルター) の一覧
description	string	コントリビューション/タイプの説明
id	string	コントリビューション/型の完全修飾識別子
includes	string[]	Includes は、このコントリビューションをターゲットリストに含める必要がある一連のコントリビューションです。
properties	JObject	このコントリビューションのプロパティ/属性
restrictedTo	string[]	ユーザーがこの投稿 (匿名、パブリック、メンバーなど) を表示するために要求された要求の一覧。
targets	string[]	このコントリビューションの対象となるコントリビューションの ID。 (親コントリビューション)
type	string	コントリビューションの種類の ID
visibleTo	string[]	VisibleTo を使用して、特定のコントリビューション/型を参照できるユーザーを制限できます。この値は、パブリッシャーまたは拡張機能のアクセスも制限されているリストである必要があります。例: "ms" - "ms" パブリッシャーのみがこれを参照できることを意味します。 "ms.vss-web" - "ms" パブリッシャーからの "vss-web" 拡張機能のみがこれを参照できることを意味します。

ContributionConstraint

特定のコントリビューションを動的に含める/除外するために使用できる制約を指定します

名前	型	説明
group	integer	制約をグループ化するために指定できる省略可能なプロパティ。グループ内のすべての制約は AND で結合されます (コントリビューションを含めるためには、すべて True に評価する必要があります)。制約の異なるグループは OR'd です (コントリビューションを含めるために評価する必要があるグループは 1 つだけです)。
id	string	共有制約の完全修飾識別子
inverse	boolean	true の場合、フィルターの結果を否定します (適用されたフィルターが true ではなく false を返す場合は、コントリビューションを含めます)
name	string	IContributionFilter プラグインの名前
properties	JObject	コントリビューションフィルタークラスにフィードされるプロパティ
relationships	string[]	必要に応じて、コントリビューションで定義されている 1 つ以上のリレーションシップに制約を適用できます。リレーションシップが定義されていない場合、すべてのリレーションシップが制約に関連付けられます。これは、制約が適用されている場合、既定の動作によってツリーからの寄与が完全に排除されることを意味します。

ContributionLicensingBehaviorType

ライセンスに基づいてこのコントリビューションを含める方法

名前	型	説明
alwaysInclude	string	ユーザーが拡張機能のライセンスを取得しているかどうかに関係なく、常にコントリビューションを含めます
onlyIfLicensed	string	既定値 - ユーザーが拡張機能のライセンスを取得している場合にのみコントリビューションを含めます
onlyIfUnlicensed	string	ユーザーが拡張機能のライセンスを取得していない場合にのみ、コントリビューションを含める

ContributionPropertyDescription

コントリビューション型のプロパティに関する説明

名前	型	説明
description	string	プロパティの説明
name	string	プロパティ名
required	boolean	このプロパティが必要な場合は True
type	ContributionPropertyType	このプロパティに使用される値の型

ContributionPropertyType

このプロパティに使用される値の型

名前	型	説明
array	string	値は配列です
boolean	string	値が True または False である
dateTime	string	値は 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	string	コントリビューション/タイプの説明
id	string	コントリビューション/型の完全修飾識別子
indexed	boolean	この型のコントリビューションにクエリのインデックスを作成するかどうかを制御します。これにより、クライアントは、この種類のコントリビューションを持つすべての拡張機能を検索できます。注: インデックス付きコントリビューションの種類を指定できるのは TrustedPartners のみです。
name	string	コントリビューション/タイプのフレンドリ名
properties	<string, ContributionPropertyDescription>	このコントリビューションの種類で許可されるプロパティについて説明します
visibleTo	string[]	VisibleTo を使用して、特定のコントリビューション/型を参照できるユーザーを制限できます。この値は、パブリッシャーまたは拡張機能のアクセスも制限されているリストである必要があります。例: "ms" - "ms" パブリッシャーのみがこれを参照できることを意味します。 "ms.vss-web" - "ms" パブリッシャーからの "vss-web" 拡張機能のみがこれを参照できることを意味します。

ExtensionEventCallback

拡張機能のイベントコールバックの基本クラス

名前	型	説明
uri	string	イベントが発生したときにヒットするエンドポイントの URI

ExtensionEventCallbackCollection

イベントコールバックのコレクション - 特定の拡張イベントが発生したときに呼び出されるエンドポイント。

名前	型	説明
postDisable	ExtensionEventCallback	省略可能。拡張機能の無効化が発生したことを通知するために POST 要求を介して呼び出されるエンドポイントを定義します。
postEnable	ExtensionEventCallback	省略可能。拡張機能の有効化が発生したことを通知するために POST 要求を介して呼び出されるエンドポイントを定義します。
postInstall	ExtensionEventCallback	省略可能。拡張機能のインストールが完了したことを通知するために POST 要求を介して呼び出されるエンドポイントを定義します。
postUninstall	ExtensionEventCallback	省略可能。拡張機能のアンインストールが発生したことを通知するために POST 要求を介して呼び出されるエンドポイントを定義します。
postUpdate	ExtensionEventCallback	省略可能。拡張機能の更新が発生したことを通知するために POST 要求を介して呼び出されるエンドポイントを定義します。
preInstall	ExtensionEventCallback	省略可能。拡張機能のインストールが行われようとしていることを通知するために POST 要求を介して呼び出されるエンドポイントを定義します。応答は、続行するか中止するかを示します。
versionCheck	ExtensionEventCallback	複数バージョンの拡張機能の場合は、OPTIONS 要求を介して呼び出されるエンドポイントを定義して、使用する拡張機能の特定のバージョンを決定します

ExtensionFile

名前	型	説明
assetType	string
language	string
source	string

ExtensionFlags

コントリビューションコンシューマーに関連する拡張機能フラグ

名前	型	説明
builtIn	string	既定では、すべての VSTS アカウントに対して組み込みの拡張機能がインストールされます
trusted	string	この拡張機能は、完全に信頼された発行元から提供されます

ExtensionLicensing

ライセンスに基づくコントリビューションを含む拡張機能の処理方法

名前	型	説明
overrides	LicensingOverride[]	既定のライセンス動作から逸脱したコントリビューションの一覧

ExtensionStateFlags

インストールされている拡張機能の状態

名前	型	説明
autoUpgradeError	string	自動アップグレードの実行中にエラーが発生しました。たとえば、新しいバージョンにサポートされていない要求がある場合、拡張機能を自動アップグレードすることはできません。
builtIn	string	拡張機能は組み込み
disabled	string	拡張機能が無効になっている
error	string	拡張機能は現在エラー状態です
multiVersion	string	拡張機能には複数のバージョンがあります
needsReauthorization	string	拡張機能のスコープが変更され、拡張機能に再承認が必要です
none	string	フラグの設定なし
trusted	string	信頼できる拡張機能は、特別な機能が提供される拡張機能です。これらは Microsoft から提供される傾向があり、一般のユーザーが公開することはできません。注: BuiltIn 拡張機能は常に信頼されます。
unInstalled	string	拡張機能がインストールされていません。これは組み込みの拡張機能専用であり、それ以外の場合は設定できません。
versionCheckError	string	バージョンチェックの実行中にエラーが発生しました
warning	string	拡張機能は現在警告状態であり、エクスペリエンスが低下する可能性があります。エクスペリエンスの低下は、たとえば、暗黙的な要求がサポートされていないなど、一部のインストールの問題が検出された場合に発生する可能性があります。