Installed Extensions - List
列出帐户/项目集合中已安装的扩展。
GET https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensions?api-version=7.1-preview.1
GET https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensions?includeDisabledExtensions={includeDisabledExtensions}&includeErrors={includeErrors}&assetTypes={assetTypes}&includeInstallationIssues={includeInstallationIssues}&api-version=7.1-preview.1
URI 参数
名称 | 在 | 必需 | 类型 | 说明 |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 组织的名称。 |
api-version
|
query | True |
string |
要使用的 API 版本。 应将其设置为“7.1-preview.1”才能使用此版本的 API。 |
asset
|
query |
string array (string) |
确定文件数组中返回的文件。 提供通配符“*”以返回所有文件,或提供冒号分隔列表以检索具有特定资产类型的文件。 |
|
include
|
query |
boolean |
如果 true (默认) ,请在结果中包含禁用的扩展。 |
|
include
|
query |
boolean |
如果为 true,则包含错误的已安装扩展。 |
|
include
|
query |
boolean |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
成功的操作 |
安全性
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 | 授予读取已安装扩展的权限。 |
示例
示例请求
GET https://extmgmt.dev.azure.com/fabrikam/_apis/extensionmanagement/installedextensions?api-version=7.1-preview.1
示例响应
{
"count": 6,
"value": [
{
"extensionId": "hockeyapp",
"extensionName": "HockeyApp",
"publisherId": "ms",
"publisherName": "Microsoft",
"version": "1.125.0",
"registrationId": "03ff233f-b47d-44d2-af59-dca309104a70",
"manifestVersion": 1,
"baseUri": "https://ms.gallerycdn.vsassets.io/extensions/ms/hockeyapp/1.125.0/1507569990176",
"scopes": [
"vso.build_execute",
"vso.serviceendpoint_manage"
],
"contributions": [
{
"id": "ms.hockeyapp.hockeyapp-endpoint-type",
"description": "HockeyAppprovidesanalyticsformobileapp.",
"type": "ms.vss-endpoint.service-endpoint-type",
"targets": [
"ms.vss-endpoint.endpoint-types"
],
"properties": {
"name": "hockeyapp",
"displayName": "HockeyApp",
"url": "https://rink.hockeyapp.net/api/2/apps/",
"inputDescriptors": [],
"authenticationSchemes": [
{
"type": "ms.vss-endpoint.endpoint-auth-scheme-basic",
"inputDescriptors": [
{
"id": "username",
"name": "Username",
"description": "Username",
"inputMode": "textbox",
"isConfidential": false,
"validation": {
"isRequired": false,
"dataType": "string"
},
"values": {
"inputId": "usernameInput",
"defaultValue": "",
"isDisabled": true
}
},
{
"id": "password",
"name": "API Token",
"description": "API token to connect to HockeyApp account can be created <a href=\"https://rink.hockeyapp.net/manage/auth_tokens\" target=\"_blank\">here</a>.",
"inputMode": "textbox",
"isConfidential": false,
"validation": {
"isRequired": true,
"dataType": "string"
}
}
]
}
],
"::Attributes": 16,
"::Version": "1.125.0"
}
},
{
"id": "ms.hockeyapp.sonoma-endpoint-type",
"description": "Endpoint for mobile app",
"type": "ms.vss-endpoint.service-endpoint-type",
"targets": [
"ms.vss-endpoint.endpoint-types"
],
"properties": {
"name": "sonoma",
"displayName": "Zamboni",
"url": "https://api.mobile.azure.com/v0.1",
"inputDescriptors": [],
"authenticationSchemes": [
{
"type": "ms.vss-endpoint.endpoint-auth-scheme-basic",
"inputDescriptors": [
{
"id": "username",
"name": "Username",
"description": "Username",
"inputMode": "textbox",
"isConfidential": false,
"validation": {
"isRequired": false,
"dataType": "string"
},
"values": {
"inputId": "usernameInput",
"defaultValue": "",
"isDisabled": true
}
},
{
"id": "password",
"name": "API Token",
"description": "API token.",
"inputMode": "textbox",
"isConfidential": true,
"validation": {
"isRequired": true,
"dataType": "string"
}
}
]
}
],
"::Attributes": 16,
"::Version": "1.125.0"
}
},
{
"id": "ms.hockeyapp.sonomaupload-task",
"type": "ms.vss-distributed-task.task",
"targets": [
"ms.vss-distributed-task.tasks"
],
"properties": {
"name": "SonomaUpload",
"::Attributes": 16,
"::Version": "1.125.0"
}
},
{
"id": "ms.hockeyapp.hockeyapp-task",
"type": "ms.vss-distributed-task.task",
"targets": [
"ms.vss-distributed-task.tasks"
],
"properties": {
"name": "HockeyAppTask",
"::Attributes": 16,
"::Version": "1.125.0"
}
},
{
"id": "ms.hockeyapp.HockeyAppWidget",
"type": "ms.vss-dashboards-web.widget",
"targets": [
"ms.vss-dashboards-web.widget-catalog",
"ms.hockeyapp.HockeyAppWidget.Configuration"
],
"properties": {
"name": "HockeyApp Widget",
"description": "Provides links to the HockeyApp overview information, crash reports and a link to download the app.",
"previewImageUrl": "HockeyAppWidget/img/preview.png",
"catalogIconUrl": "HockeyAppWidget/img/catalogIcon.png",
"loadingImageUrl": "HockeyAppWidget/img/loading.png",
"uri": "HockeyAppWidget/widget.htm",
"isVisibleFromCatalog": true,
"isNameConfigurable": true,
"configurationRequired": true,
"supportedSizes": [
{
"rowSpan": 1,
"columnSpan": 2
}
],
"supportedScopes": [
"project_team"
],
"::Attributes": 16,
"::Version": "1.125.0"
}
},
{
"id": "ms.hockeyapp.HockeyAppWidget.Configuration",
"type": "ms.vss-dashboards-web.widget-configuration",
"targets": [
"ms.vss-dashboards-web.widget-configuration"
],
"properties": {
"name": "HockeyApp Configuration",
"description": "Configures HockeyApp",
"uri": "HockeyAppWidget/configuration.htm",
"::Attributes": 16,
"::Version": "1.125.0"
}
}
],
"installState": {
"flags": "none",
"lastUpdated": "2017-10-09T18:01:19.407Z"
},
"contributionTypes": [],
"lastPublished": "2017-10-09T17:26:30.177Z",
"files": []
},
{
"extensionId": "vss-analytics",
"extensionName": "Analytics",
"publisherId": "ms",
"publisherName": "Microsoft",
"version": "16.126.6.663368523",
"flags": "trusted",
"manifestVersion": 1,
"baseUri": "https://ms.gallerycdn.vsassets.io/extensions/ms/vss-analytics/16.126.6.663368523/1512083885110",
"scopes": [],
"contributions": [
{
"id": "ms.vss-analytics.analytics-basic-demand",
"description": "Demand for basic analytics services (this demand is a placeholder, installing the extension provides this naturally)",
"type": "ms.vss-analytics.analytics-demand",
"properties": {
"::Attributes": 94,
"::Version": "16.126.6.663368523",
"::ServiceInstanceType": "0000003c-0000-8888-8000-000000000000"
}
}
],
"installState": {
"flags": "multiVersion, trusted",
"lastUpdated": "2017-12-01T01:26:30.38Z"
},
"contributionTypes": [
{
"id": "ms.vss-analytics.analytics-demand",
"name": "Demand for Analytics",
"description": "Demand type for analytics services"
}
],
"lastPublished": "2017-11-30T23:18:05.093Z",
"serviceInstanceType": "0000003c-0000-8888-8000-000000000000",
"files": []
},
{
"extensionId": "vss-code-search",
"extensionName": "Code Search",
"publisherId": "ms",
"publisherName": "Microsoft",
"version": "0.0.123.8",
"flags": "trusted",
"manifestVersion": 1,
"baseUri": "https://ms.gallerycdn.vsassets.io/extensions/ms/vss-code-search/0.0.123.8/1511933743977",
"scopes": [],
"contributions": [
{
"id": "ms.vss-code-search.code-entity-type",
"description": "Search capability across code entities.",
"type": "ms.vss-search-platform.entity-type",
"targets": [
"ms.vss-search-platform.entity-type-collection"
],
"properties": {
"displayName": "Code",
"order": 0,
"::Attributes": 82,
"::Version": "0.0.123.8",
"::ServiceInstanceType": "00000010-0000-8888-8000-000000000000"
}
},
{
"id": "ms.vss-code-search.code-search-page-data-provider-contribution",
"description": "Search capability across code entities.",
"type": "",
"targets": [
"ms.vss-search-platform.search-collection-page-hub",
"ms.vss-search-platform.search-project-page-hub"
],
"properties": {
"::Attributes": 82,
"::Version": "0.0.123.8",
"::ServiceInstanceType": "00000010-0000-8888-8000-000000000000"
},
"constraints": [
{
"name": "QueryParameters",
"properties": {
"filters": {
"type": "code"
}
}
}
]
},
{
"id": "ms.vss-code-search.code-search-page-viewmodel-data-provider",
"description": "Data for search page.",
"type": "ms.vss-web.data-provider",
"targets": [
"ms.vss-code-search.code-search-page-data-provider-contribution"
],
"properties": {
"name": "Search.Code.ViewModel",
"serviceInstanceType": "00000010-0000-8888-8000-000000000000",
"resolution": "Server",
"::Attributes": 82,
"::Version": "0.0.123.8",
"::ServiceInstanceType": "00000010-0000-8888-8000-000000000000"
},
"constraints": [
{
"name": "FeatureFlag",
"properties": {
"featureName": "WebAccess.Search.Hub.UseTfsDataProvider"
},
"inverse": true
}
]
}
],
"installState": {
"flags": "multiVersion, trusted",
"lastUpdated": "2017-11-29T06:43:56.873Z"
},
"contributionTypes": [],
"lastPublished": "2017-11-29T05:35:43.917Z",
"serviceInstanceType": "00000010-0000-8888-8000-000000000000",
"files": []
},
{
"extensionId": "vss-plans",
"extensionName": "Delivery Plans",
"publisherId": "ms",
"publisherName": "Microsoft",
"version": "16.126.0.1807114869",
"flags": "trusted",
"manifestVersion": 1,
"baseUri": "https://ms.gallerycdn.vsassets.io/extensions/ms/vss-plans/16.126.0.1807114869/1512102285396",
"scopes": [],
"contributions": [
{
"id": "ms.vss-plans.vss-plans-hub",
"description": "Adds the Plans hub to the Work hub group.",
"type": "ms.vss-web.hub",
"targets": [
"ms.vss-work-web.work-hub-group"
],
"properties": {
"name": "Plans",
"order": 30,
"icon": "bowtie-icon bowtie-plan",
"defaultRoute": "ms.vss-plans.vss-plans-route",
"content": {
"require": [
"ScaledAgile/Scripts/Extension/PlansHub"
],
"initialize": "plans.plansHub"
},
"::Attributes": 82,
"::Version": "16.126.0.1807114869"
},
"constraints": [
{
"name": "Stakeholder",
"inverse": true
}
]
},
{
"id": "ms.vss-plans.vss-plans-new-page-route",
"type": "ms.vss-web.route",
"targets": [
"ms.vss-plans.vss-plans-hub"
],
"properties": {
"hostType": "ProjectCollection",
"routeTemplates": [
"{project}/{team}/_plans",
"{project}/_plans",
"{project}/{team}/_plans/{parameters}",
"{project}/_plans/{parameters}"
],
"defaults": {
"controller": "Apps",
"action": "ContributedHub"
},
"constraints": {
"parameters": "new"
},
"::Attributes": 82,
"::Version": "16.126.0.1807114869"
},
"constraints": [
{
"name": "FeatureFlag",
"properties": {
"featureName": "WebAccess.ScaledAgile.Plans.DeliveryTimeline.Route"
}
}
],
"includes": [
"ms.vss-plans.plans-request-handler"
]
},
{
"id": "ms.vss-plans.vss-plans-directory-page-route",
"type": "ms.vss-web.route",
"targets": [
"ms.vss-plans.vss-plans-hub"
],
"properties": {
"hostType": "ProjectCollection",
"routeTemplates": [
"{project}/{team}/_plans",
"{project}/_plans",
"{project}/{team}/_plans/{parameters}",
"{project}/_plans/{parameters}"
],
"defaults": {
"controller": "Apps",
"action": "ContributedHub"
},
"constraints": {
"parameters": "all|favorites"
},
"::Attributes": 82,
"::Version": "16.126.0.1807114869"
},
"constraints": [
{
"name": "FeatureFlag",
"properties": {
"featureName": "WebAccess.ScaledAgile.Plans.DeliveryTimeline.Route"
}
}
],
"includes": [
"ms.vss-plans.plans-request-handler"
]
},
{
"id": "ms.vss-plans.vss-plans-route",
"type": "ms.vss-web.route",
"targets": [
"ms.vss-plans.vss-plans-hub"
],
"properties": {
"hostType": "ProjectCollection",
"routeTemplates": [
"{project}/{team}/_plans",
"{project}/_plans",
"{project}/{team}/_plans/{parameters}",
"{project}/_plans/{parameters}"
],
"defaults": {
"controller": "Apps",
"action": "ContributedHub"
},
"::Attributes": 82,
"::Version": "16.126.0.1807114869"
},
"includes": [
"ms.vss-plans.plans-request-handler"
]
},
{
"id": "ms.vss-plans.plans-request-handler",
"type": "ms.vss-web.request-handler",
"properties": {
"name": "plans.requestHandler",
"::Attributes": 82,
"::Version": "16.126.0.1807114869"
}
},
{
"id": "ms.vss-plans.vss-plans-hub-tab-group",
"description": "Tab group contributing to plan hub.",
"type": "ms.vss-web.tab-group",
"targets": [
"ms.vss-plans.vss-plans-hub"
],
"properties": {
"::Attributes": 82,
"::Version": "16.126.0.1807114869"
}
},
{
"id": "ms.vss-plans.vss-plans-hub-favorites-tab",
"description": "Favorites tab contributing to plans hub.",
"type": "ms.vss-web.tab",
"targets": [
"ms.vss-plans.vss-plans-hub-tab-group"
],
"properties": {
"name": "Favorites",
"action": "favorites",
"content": {
"require": [
"ScaledAgile/Scripts/Extension/Tabs"
],
"initialize": "plans.tab.favorites"
},
"::Attributes": 82,
"::Version": "16.126.0.1807114869"
}
},
{
"id": "ms.vss-plans.vss-plans-hub-all-tab",
"description": "All tabs contributing to plans hub.",
"type": "ms.vss-web.tab",
"targets": [
"ms.vss-plans.vss-plans-hub-tab-group"
],
"properties": {
"name": "All",
"action": "all",
"content": {
"require": [
"ScaledAgile/Scripts/Extension/Tabs"
],
"initialize": "plans.tab.all"
},
"::Attributes": 82,
"::Version": "16.126.0.1807114869"
}
},
{
"id": "ms.vss-plans.plans-hub-data-provider",
"description": "Provides data needed for the Plans hub.",
"type": "ms.vss-web.data-provider",
"targets": [
"ms.vss-plans.vss-plans-hub"
],
"properties": {
"name": "PlansHubDataProvider",
"serviceInstanceType": "00025394-6065-48CA-87D9-7F5672854EF7",
"::Attributes": 82,
"::Version": "16.126.0.1807114869"
}
},
{
"id": "ms.vss-plans.work-plan-favorite",
"type": "ms.vss-favorites.favorite-provider",
"properties": {
"artifactType": "Microsoft.TeamFoundation.Work.Plans",
"serviceInstanceType": "00025394-6065-48CA-87D9-7F5672854EF7",
"pluralName": "Plans",
"order": 40,
"content": {
"require": [
"ScaledAgile/Scripts/Extension/FavoritedPlanRenderer"
],
"initialize": "accounthome.planfavoriteitem-init"
},
"::Attributes": 82,
"::Version": "16.126.0.1807114869"
}
}
],
"installState": {
"flags": "multiVersion, trusted",
"lastUpdated": "2017-12-01T04:48:30.17Z"
},
"contributionTypes": [],
"lastPublished": "2017-12-01T04:24:45.397Z",
"files": []
},
{
"extensionId": "team-calendar",
"extensionName": "Team Calendar",
"publisherId": "ms-devlabs",
"publisherName": "Microsoft DevLabs",
"version": "0.5.94",
"registrationId": "9ff7e19d-2f92-4dfc-a71d-afcc3f851014",
"manifestVersion": 1,
"baseUri": "https://ms-devlabs.gallerycdn.vsassets.io/extensions/ms-devlabs/team-calendar/0.5.94/1510691968879",
"scopes": [
"vso.work_write"
],
"contributions": [
{
"id": "ms-devlabs.team-calendar.calendar-has-moved-banner",
"description": "Banner points out that the Calendar has moved to the Work hub.",
"type": "ms.vss-web.global-message-banner",
"targets": [
"ms.vss-web.home-hub-group"
],
"properties": {
"message": "The Calendar has moved! You may now find it under the Work menu.",
"level": "info",
"::Attributes": 16,
"::Version": "0.5.94"
}
},
{
"id": "ms-devlabs.team-calendar.calendar",
"description": "Calendar hub in the Work hub group.",
"type": "ms.vss-web.hub",
"targets": [
"ms.vss-work-web.work-hub-group"
],
"properties": {
"name": "Calendar",
"order": 22,
"uri": "static/calendar.html",
"::Attributes": 16,
"::Version": "0.5.94"
}
},
{
"id": "ms-devlabs.team-calendar.calendar-event-sources",
"description": "Target for calendar event sources",
"type": "ms-devlabs.team-calendar.calendar-event-source-collection",
"targets": [
"ms-devlabs.team-calendar.calendar"
],
"properties": {
"::Attributes": 16,
"::Version": "0.5.94"
}
},
{
"id": "ms-devlabs.team-calendar.freeForm",
"description": "Calendar event source for free-form events. Enables users to add their own events to the calendar.",
"type": "ms-devlabs.team-calendar.calendar-event-source",
"targets": [
"ms-devlabs.team-calendar.calendar-event-sources"
],
"properties": {
"uri": "static/calendarServices.html",
"::Attributes": 16,
"::Version": "0.5.94"
}
},
{
"id": "ms-devlabs.team-calendar.add-freeform-control",
"description": "",
"type": "ms.vss-web.control",
"targets": [
"ms-devlabs.team-calendar.calendar"
],
"properties": {
"uri": "static/freeFormControls.html",
"::Attributes": 16,
"::Version": "0.5.94"
}
},
{
"id": "ms-devlabs.team-calendar.daysOff",
"description": "Calendar event source for team and personal days off.",
"type": "ms-devlabs.team-calendar.calendar-event-source",
"targets": [
"ms-devlabs.team-calendar.calendar-event-sources"
],
"properties": {
"uri": "static/calendarServices.html",
"::Attributes": 16,
"::Version": "0.5.94"
}
},
{
"id": "ms-devlabs.team-calendar.add-daysoff-control",
"description": "",
"type": "ms.vss-web.control",
"targets": [
"ms-devlabs.team-calendar.calendar"
],
"properties": {
"uri": "static/daysOffControls.html",
"::Attributes": 16,
"::Version": "0.5.94"
}
},
{
"id": "ms-devlabs.team-calendar.iterations",
"description": "Calendar event source for sprints/iterations.",
"type": "ms-devlabs.team-calendar.calendar-event-source",
"targets": [
"ms-devlabs.team-calendar.calendar-event-sources"
],
"properties": {
"uri": "static/calendarServices.html",
"::Attributes": 16,
"::Version": "0.5.94"
}
}
],
"installState": {
"flags": "none",
"lastUpdated": "2017-11-30T21:15:35.717Z"
},
"contributionTypes": [
{
"id": "ms-devlabs.team-calendar.calendar-event-source-collection",
"name": "Calendar event source collection",
"description": "A collection of calendar event sources."
},
{
"id": "ms-devlabs.team-calendar.calendar-event-source",
"name": "Calendar event source",
"description": "A provider of calendar events.",
"properties": {
"uri": {
"name": null,
"description": "URI to the (background/hidden) HTML content which registers the calendar event source object.",
"required": true,
"type": "string"
}
}
}
],
"lastPublished": "2017-11-14T20:39:28.8Z",
"files": []
},
{
"extensionId": "cordova-extension",
"extensionName": "Cordova Build",
"publisherId": "ms-vsclient",
"publisherName": "Microsoft",
"version": "1.3.18",
"registrationId": "270bdcc7-0938-4e8f-9909-1d01bd49ef15",
"manifestVersion": 1,
"baseUri": "https://ms-vsclient.gallerycdn.vsassets.io/extensions/ms-vsclient/cordova-extension/1.3.18/1494392257328",
"scopes": [],
"contributions": [
{
"id": "ms-vsclient.cordova-extension.cordovabuildtask",
"type": "ms.vss-distributed-task.task",
"targets": [
"ms.vss-distributed-task.tasks"
],
"properties": {
"name": "Tasks/CordovaBuild",
"::Attributes": 16,
"::Version": "1.3.18"
}
},
{
"id": "ms-vsclient.cordova-extension.cordovacommandtask",
"type": "ms.vss-distributed-task.task",
"targets": [
"ms.vss-distributed-task.tasks"
],
"properties": {
"name": "Tasks/CordovaCommand",
"::Attributes": 16,
"::Version": "1.3.18"
}
},
{
"id": "ms-vsclient.cordova-extension.ioniccommandtask",
"type": "ms.vss-distributed-task.task",
"targets": [
"ms.vss-distributed-task.tasks"
],
"properties": {
"name": "Tasks/IonicCommand",
"::Attributes": 16,
"::Version": "1.3.18"
}
},
{
"id": "ms-vsclient.cordova-extension.phonegapcommandtask",
"type": "ms.vss-distributed-task.task",
"targets": [
"ms.vss-distributed-task.tasks"
],
"properties": {
"name": "Tasks/PhoneGapCommand",
"::Attributes": 16,
"::Version": "1.3.18"
}
}
],
"installState": {
"flags": "none",
"lastUpdated": "2017-05-10T08:29:16.307Z"
},
"contributionTypes": [],
"lastPublished": "2017-05-10T04:57:38.423Z",
"files": []
}
]
}
定义
名称 | 说明 |
---|---|
Contribution |
扩展的个人贡献 |
Contribution |
指定可用于动态包含/排除给定贡献的约束 |
Contribution |
此贡献的包含应如何根据许可而变化 |
Contribution |
有关贡献类型的属性的说明 |
Contribution |
用于此属性的值的类型 |
Contribution |
贡献类型,由 json 架构提供 |
Extension |
扩展的事件回调的基类 |
Extension |
事件回调的集合 - 发生特定扩展事件时调用的终结点。 |
Extension |
|
Extension |
与贡献使用者相关的扩展标志 |
Extension |
扩展应如何处理基于许可的包括贡献 |
Extension |
已安装扩展的状态 |
Installed |
表示 VSTS 扩展及其安装状态 |
Installed |
已安装扩展的状态 |
Installed |
表示安装问题 |
Installed |
安装问题类型 (警告、错误) |
JObject |
表示 JSON 对象。 |
Licensing |
将贡献映射到许可行为 |
Contribution
扩展的个人贡献
名称 | 类型 | 说明 |
---|---|---|
constraints |
应应用于此贡献可用性的约束 (筛选器) 列表 |
|
description |
string |
贡献/类型的说明 |
id |
string |
贡献/类型的完全限定标识符 |
includes |
string[] |
Include 是一组贡献,应将此贡献包含在其目标列表中。 |
properties |
此贡献的属性/属性 |
|
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 (只有一个组需要评估为 True,才能将贡献包含在) 。 |
id |
string |
共享约束的完全限定标识符 |
inverse |
boolean |
如果为 true,则否定筛选器的结果, (如果应用的筛选器返回 false 而不是 true,则包括贡献) |
name |
string |
IContributionFilter 插件的名称 |
properties |
馈送给贡献筛选器类的属性 |
|
relationships |
string[] |
可以选择性地将约束应用于贡献中定义的一个或多个关系。 如果未定义任何关系,则所有关系都与约束相关联。 这意味着,如果应用约束,默认行为将完全消除树的贡献。 |
ContributionLicensingBehaviorType
此贡献的包含应如何根据许可而变化
值 | 说明 |
---|---|
alwaysInclude |
无论用户是否获得扩展许可,始终包括贡献 |
onlyIfLicensed |
默认值 - 仅当用户获得扩展许可时,才包括贡献 |
onlyIfUnlicensed |
仅当用户未获得扩展许可时,才包括贡献 |
ContributionPropertyDescription
有关贡献类型的属性的说明
名称 | 类型 | 说明 |
---|---|---|
description |
string |
属性的说明 |
name |
string |
属性的名称 |
required |
boolean |
如果此属性是必需的,则为 True |
type |
用于此属性的值的类型 |
ContributionPropertyType
用于此属性的值的类型
值 | 说明 |
---|---|
array |
值是数组 |
boolean |
值为 True 或 False |
dateTime |
Value 是 DateTime 对象 |
dictionary |
值是泛型 Dictionary/JObject/property 包 |
double |
值是双精度值 |
guid |
值是 GUID |
integer |
值是整数 |
object |
值是任意/自定义对象 |
string |
值是字符串 |
unknown |
贡献类型未知 (值可以是任何) |
uri |
值是 URI |
ContributionType
贡献类型,由 json 架构提供
名称 | 类型 | 说明 |
---|---|---|
description |
string |
贡献/类型的说明 |
id |
string |
贡献/类型的完全限定标识符 |
indexed |
boolean |
控制此类型的贡献是否为查询编制了类型索引。 这允许客户端查找具有此类型贡献的所有扩展。 注意:仅允许 TrustedPartners 指定索引贡献类型。 |
name |
string |
贡献/类型的友好名称 |
properties |
<string,
Contribution |
描述此贡献类型的允许属性 |
visibleTo |
string[] |
VisibleTo 可用于限制谁可以引用给定的贡献/类型。 此值应为发布者列表,或者扩展访问也受到限制。 示例:“ms”- 表示只有“ms”发布者可以引用此。 “ms.vss-web” - 表示只有“ms”发布者的“vss-web”扩展可以引用此内容。 |
ExtensionEventCallback
扩展的事件回调的基类
名称 | 类型 | 说明 |
---|---|---|
uri |
string |
事件发生时命中的终结点的 URI |
ExtensionEventCallbackCollection
事件回调的集合 - 发生特定扩展事件时调用的终结点。
名称 | 类型 | 说明 |
---|---|---|
postDisable |
可选。 定义一个终结点,该终结点通过 POST 请求调用,以通知扩展禁用已发生。 |
|
postEnable |
可选。 定义一个终结点,该终结点通过 POST 请求调用,以通知已启用扩展。 |
|
postInstall |
可选。 定义一个终结点,该终结点通过 POST 请求调用,以通知扩展安装已完成。 |
|
postUninstall |
可选。 定义一个终结点,该终结点通过 POST 请求调用,以通知扩展卸载已发生。 |
|
postUpdate |
可选。 定义通过 POST 请求调用的终结点,以通知扩展更新已发生。 |
|
preInstall |
可选。 定义通过 POST 请求调用的终结点,以通知即将进行扩展安装。 响应指示是继续还是中止。 |
|
versionCheck |
对于多版本扩展,定义通过 OPTIONS 请求调用的终结点,以确定要使用的扩展的特定版本 |
ExtensionFile
名称 | 类型 | 说明 |
---|---|---|
assetType |
string |
|
language |
string |
|
source |
string |
ExtensionFlags
与贡献使用者相关的扩展标志
值 | 说明 |
---|---|
builtIn |
默认情况下,为所有 VSTS 帐户安装内置扩展 |
trusted |
扩展来自完全受信任的发布者 |
ExtensionLicensing
扩展应如何处理基于许可的包括贡献
名称 | 类型 | 说明 |
---|---|---|
overrides |
与默认许可行为不同的贡献列表 |
ExtensionStateFlags
已安装扩展的状态
值 | 说明 |
---|---|
autoUpgradeError |
执行自动升级时出错。 例如,如果新版本要求不支持该扩展,则无法自动升级。 |
builtIn |
扩展是内置的 |
disabled |
扩展已禁用 |
error |
扩展当前处于错误状态 |
multiVersion |
扩展具有多个版本 |
needsReauthorization |
扩展范围已更改,扩展需要重新授权 |
none |
未设置标志 |
trusted |
受信任的扩展是具有特殊功能的扩展。 这些内容往往来自 Microsoft,不能由公众发布。 注意:内置扩展始终受信任。 |
unInstalled |
未安装扩展。 这仅适用于内置扩展,否则无法进行设置。 |
versionCheckError |
执行版本检查时出错 |
warning |
扩展当前处于警告状态,这可能会导致体验降级。 降级的体验可能是由检测到的某些安装问题(例如不支持的隐式需求)引起的。 |
InstalledExtension
表示 VSTS 扩展及其安装状态
名称 | 类型 | 说明 |
---|---|---|
baseUri |
string |
用作扩展中定义的其他相对 URI 的基的 URI |
constraints |
此扩展定义的共享约束列表 |
|
contributionTypes |
此扩展定义的贡献类型列表 |
|
contributions |
此扩展所做的贡献列表 |
|
demands |
string[] |
此扩展所需的显式要求列表 |
eventCallbacks |
发生特定扩展事件时调用的终结点的集合 |
|
extensionId |
string |
此扩展的友好扩展 ID - 对于给定发布者是唯一的。 |
extensionName |
string |
扩展的显示名称。 |
fallbackBaseUri |
string |
可用作扩展中定义的其他相对 URI 的基位置的辅助位置 |
files |
这是扩展中可用的一组文件。 |
|
flags |
与贡献使用者相关的扩展标志 |
|
installState |
有关扩展的此特定安装的信息 |
|
language |
string |
由库设置的语言区域性名称 |
lastPublished |
string |
这表示上次在库中更新扩展的日期/时间。 这并不意味着此版本已更新, 值表示对扩展的任何和所有版本的更改。 |
licensing |
此扩展在许可方面的行为方式 |
|
manifestVersion |
number |
扩展清单格式/内容的版本 |
publisherId |
string |
此扩展的发布者的唯一 ID |
publisherName |
string |
发布者的显示名称 |
registrationId |
string |
此扩展的唯一 ID (同一 ID 用于单个扩展的所有版本) |
restrictedTo |
string[] |
默认用户声明应用于所有贡献 (,但已指定受限的用户声明显式) 以控制贡献的可见性。 |
scopes |
string[] |
此扩展所需的所有 oauth 范围的列表 |
serviceInstanceType |
string |
VSTS 服务的 ServiceInstanceType (Guid) ,该服务必须可供帐户使用才能安装扩展 |
version |
string |
此扩展的版本 |
InstalledExtensionState
已安装扩展的状态
名称 | 类型 | 说明 |
---|---|---|
flags |
已安装扩展的状态 |
|
installationIssues |
安装问题列表 |
|
lastUpdated |
string |
上次更新此安装的时间 |
InstalledExtensionStateIssue
表示安装问题
名称 | 类型 | 说明 |
---|---|---|
message |
string |
错误消息 |
source |
string |
安装问题的来源,例如“需求” |
type |
安装问题类型 (警告、错误) |
InstalledExtensionStateIssueType
安装问题类型 (警告、错误)
值 | 说明 |
---|---|
error |
表示安装错误,例如不支持的显式需求 |
warning |
表示安装警告,例如不支持的隐式需求 |
JObject
表示 JSON 对象。
名称 | 类型 | 说明 |
---|---|---|
item |
string |
|
type |
string |
获取此 JToken 的节点类型。 |
LicensingOverride
将贡献映射到许可行为
名称 | 类型 | 说明 |
---|---|---|
behavior |
此贡献的包含应如何根据许可而变化 |
|
id |
string |
要为其定义许可行为的完全限定贡献 ID |