Installed Extensions - List
Listet die installierten Erweiterungen in der Konto-/Projektsammlung auf.
GET https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensions?api-version=6.0-preview.1
GET https://extmgmt.dev.azure.com/{organization}/_apis/extensionmanagement/installedextensions?includeDisabledExtensions={includeDisabledExtensions}&includeErrors={includeErrors}&assetTypes={assetTypes}&includeInstallationIssues={includeInstallationIssues}&api-version=6.0-preview.1
URI-Parameter
Name | In | Erforderlich | Typ | Beschreibung |
---|---|---|---|---|
organization
|
path | True |
string |
Der Name der Azure DevOps-Organisation. |
api-version
|
query | True |
string |
Version der zu verwendenden API. Dies sollte auf "6.0-preview.1" festgelegt werden, um diese Version der API zu verwenden. |
asset
|
query |
string array (string) |
||
include
|
query |
boolean |
Wenn true (Standard), schließen Sie deaktivierte Erweiterungen in die Ergebnisse ein. |
|
include
|
query |
boolean |
Wenn true, schließen Sie installierte Erweiterungen mit Fehlern ein. |
|
include
|
query |
boolean |
Antworten
Name | Typ | Beschreibung |
---|---|---|
200 OK |
Erfolgreicher Vorgang |
Sicherheit
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
Name | Beschreibung |
---|---|
vso.extension | Gewährt die Möglichkeit, installierte Erweiterungen zu lesen. |
Beispiele
Sample Request
GET https://extmgmt.dev.azure.com/fabrikam/_apis/extensionmanagement/installedextensions?api-version=6.0-preview.1
Sample Response
{
"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": []
}
]
}
Definitionen
Name | Beschreibung |
---|---|
Contribution |
Ein individueller Beitrag durch eine Erweiterung |
Contribution |
Gibt eine Einschränkung an, die verwendet werden kann, um einen bestimmten Beitrag dynamisch einzu-/ausschließen. |
Contribution |
Wie sich die Einbeziehung dieses Beitrags basierend auf der Lizenzierung ändern sollte |
Contribution |
Beschreibung einer Eigenschaft eines Beitragstyps |
Contribution |
Der Typ des Werts, der für diese Eigenschaft verwendet wird |
Contribution |
Ein Beitragstyp, der von einem JSON-Schema angegeben wird |
Extension |
Basisklasse für einen Ereignisrückruf für eine Erweiterung |
Extension |
Sammlung von Ereignisrückrufen: Endpunkte, die aufgerufen werden, wenn bestimmte Erweiterungsereignisse auftreten. |
Extension |
|
Extension |
Erweiterungsflags, die für Beitragsverbraucher relevant sind |
Extension |
Wie eine Erweiterung behandelt werden sollte, einschließlich Beiträge basierend auf der Lizenzierung |
Extension |
Zustände einer installierten Erweiterung |
Installed |
Stellt eine VSTS-Erweiterung zusammen mit ihrem Installationsstatus dar. |
Installed |
Der Status einer installierten Erweiterung |
Installed |
Stellt ein Installationsproblem dar. |
Installed |
Installationsproblemtyp (Warnung, Fehler) |
JObject |
Stellt ein JSON-Objekt dar. |
Licensing |
Ordnet einen Beitrag zu einem Lizenzierungsverhalten zu |
Contribution
Ein individueller Beitrag durch eine Erweiterung
Name | Typ | Beschreibung |
---|---|---|
constraints |
Liste der Einschränkungen (Filter), die auf die Verfügbarkeit dieses Beitrags angewendet werden sollen |
|
description |
string |
Beschreibung des Beitrags/Typs |
id |
string |
Vollqualifizierter Bezeichner des Beitrags/Typs |
includes |
string[] |
Includes ist eine Reihe von Beiträge, für die dieser Beitrag in der Zielliste enthalten sein sollte. |
properties |
Eigenschaften/Attribute dieses Beitrags |
|
restrictedTo |
string[] |
Liste der geforderten Ansprüche, damit der Benutzer diesen Beitrag sehen kann (z. B. anonym, öffentlich, Mitglied...). |
targets |
string[] |
Die IDs der Beiträge, auf die dieser Beitrag abzielt. (übergeordnete Beiträge) |
type |
string |
ID des Beitragstyps |
visibleTo |
string[] |
VisibleTo kann verwendet werden, um einzuschränken, wer auf einen bestimmten Beitrag/Typ verweisen kann. Dieser Wert sollte eine Liste von Herausgebern sein, oder der Zugriff auf Erweiterungen ist ebenfalls eingeschränkt. Beispiele: "ms": Bedeutet, dass nur der Herausgeber "ms" darauf verweisen kann. "ms.vss-web": Bedeutet, dass nur die Erweiterung "vss-web" des Herausgebers "ms" darauf verweisen kann. |
ContributionConstraint
Gibt eine Einschränkung an, die verwendet werden kann, um einen bestimmten Beitrag dynamisch einzu-/ausschließen.
Name | Typ | Beschreibung |
---|---|---|
group |
integer |
Eine optionale Eigenschaft, die zum Gruppieren von Einschränkungen angegeben werden kann. Alle Einschränkungen innerhalb einer Gruppe sind AND'd zusammen (alle müssen als True ausgewertet werden, damit der Beitrag eingeschlossen wird). Verschiedene Gruppen von Einschränkungen sind OR'd (nur eine Gruppe muss als True ausgewertet werden, damit der Beitrag eingeschlossen wird). |
id |
string |
Vollqualifizierter Bezeichner einer freigegebenen Einschränkung |
inverse |
boolean |
Wenn true, negieren Sie das Ergebnis des Filters (schließen Sie den Beitrag ein, wenn der angewendete Filter false anstelle von true zurückgibt). |
name |
string |
Name des IContributionFilter-Plug-Ins |
properties |
Eigenschaften, die der Beitragsfilterklasse zugeführt werden |
|
relationships |
string[] |
Einschränkungen können optional auf eine oder mehrere der im Beitrag definierten Beziehungen angewendet werden. Wenn keine Beziehungen definiert sind, werden alle Beziehungen der Einschränkung zugeordnet. Dies bedeutet, dass der Beitrag aus der Struktur durch das Standardverhalten vollständig entfernt wird, wenn die Einschränkung angewendet wird. |
ContributionLicensingBehaviorType
Wie sich die Einbeziehung dieses Beitrags basierend auf der Lizenzierung ändern sollte
Name | Typ | Beschreibung |
---|---|---|
alwaysInclude |
string |
Schließen Sie den Beitrag immer ein, unabhängig davon, ob der Benutzer für die Erweiterung lizenziert ist oder nicht. |
onlyIfLicensed |
string |
Standardwert: Schließen Sie den Beitrag nur ein, wenn der Benutzer für die Erweiterung lizenziert ist. |
onlyIfUnlicensed |
string |
Schließen Sie den Beitrag nur ein, wenn der Benutzer NICHT für die Erweiterung lizenziert ist. |
ContributionPropertyDescription
Beschreibung einer Eigenschaft eines Beitragstyps
Name | Typ | Beschreibung |
---|---|---|
description |
string |
Beschreibung der Eigenschaft |
name |
string |
Name der Eigenschaft |
required |
boolean |
True, wenn diese Eigenschaft erforderlich ist |
type |
Der Typ des Werts, der für diese Eigenschaft verwendet wird |
ContributionPropertyType
Der Typ des Werts, der für diese Eigenschaft verwendet wird
Name | Typ | Beschreibung |
---|---|---|
array |
string |
Der Wert ist ein Array. |
boolean |
string |
Der Wert ist True oder False. |
dateTime |
string |
Value ist ein DateTime-Objekt. |
dictionary |
string |
Value ist ein generischer Wörterbuch-/JObject-/Eigenschaftsbehälter. |
double |
string |
Der Wert ist ein Double |
guid |
string |
Wert ist eine GUID |
integer |
string |
Value ist eine ganze Zahl. |
object |
string |
Der Wert ist ein beliebiges/benutzerdefiniertes Objekt. |
string |
string |
Value ist eine Zeichenfolge |
unknown |
string |
Der Beitragstyp ist unbekannt (Der Wert kann ein beliebiger Wert sein) |
uri |
string |
Der Wert ist ein URI. |
ContributionType
Ein Beitragstyp, der von einem JSON-Schema angegeben wird
Name | Typ | Beschreibung |
---|---|---|
description |
string |
Beschreibung des Beitrags/Typs |
id |
string |
Vollqualifizierter Bezeichner des Beitrags/Typs |
indexed |
boolean |
Steuert, ob Beiträge dieses Typs den Typ für Abfragen indiziert haben. Dadurch können Clients alle Erweiterungen finden, die einen Beitrag dieses Typs haben. HINWEIS: Nur TrustedPartners dürfen indizierte Beitragstypen angeben. |
name |
string |
Anzeigename des Beitrags/Typs |
properties |
<string,
Contribution |
Beschreibt die zulässigen Eigenschaften für diesen Beitragstyp. |
visibleTo |
string[] |
VisibleTo kann verwendet werden, um einzuschränken, wer auf einen bestimmten Beitrag/Typ verweisen kann. Dieser Wert sollte eine Liste von Herausgebern sein, oder der Zugriff auf Erweiterungen ist ebenfalls eingeschränkt. Beispiele: "ms": Bedeutet, dass nur der Herausgeber "ms" darauf verweisen kann. "ms.vss-web": Bedeutet, dass nur die Erweiterung "vss-web" des Herausgebers "ms" darauf verweisen kann. |
ExtensionEventCallback
Basisklasse für einen Ereignisrückruf für eine Erweiterung
Name | Typ | Beschreibung |
---|---|---|
uri |
string |
Der URI des Endpunkts, der beim Auftreten eines Ereignisses getroffen wird |
ExtensionEventCallbackCollection
Sammlung von Ereignisrückrufen: Endpunkte, die aufgerufen werden, wenn bestimmte Erweiterungsereignisse auftreten.
Name | Typ | Beschreibung |
---|---|---|
postDisable |
Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass eine Erweiterung deaktiviert wurde. |
|
postEnable |
Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass eine Erweiterung aktiviert wurde. |
|
postInstall |
Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass eine Erweiterungsinstallation abgeschlossen wurde. |
|
postUninstall |
Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass eine Erweiterung deinstalliert wurde. |
|
postUpdate |
Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass ein Erweiterungsupdate erfolgt ist. |
|
preInstall |
Optional. Definiert einen Endpunkt, der über eine POST-Anforderung aufgerufen wird, um zu benachrichtigen, dass eine Erweiterungsinstallation stattfindet. Antwort gibt an, ob fortgesetzt oder abgebrochen werden soll. |
|
versionCheck |
Definiert für Multiversionserweiterungen einen Endpunkt, der über eine OPTIONS-Anforderung aufgerufen wird, um die bestimmte Version der zu verwendenden Erweiterung zu bestimmen. |
ExtensionFile
Name | Typ | Beschreibung |
---|---|---|
assetType |
string |
|
language |
string |
|
source |
string |
ExtensionFlags
Erweiterungsflags, die für Beitragsverbraucher relevant sind
Name | Typ | Beschreibung |
---|---|---|
builtIn |
string |
Standardmäßig wird für alle VSTS-Konten eine integrierte Erweiterung installiert. |
trusted |
string |
Die Erweiterung stammt von einem voll vertrauenswürdigen Herausgeber. |
ExtensionLicensing
Wie eine Erweiterung behandelt werden sollte, einschließlich Beiträge basierend auf der Lizenzierung
Name | Typ | Beschreibung |
---|---|---|
overrides |
Eine Liste der Beiträge, die vom Standardlizenzierungsverhalten abweichen |
ExtensionStateFlags
Zustände einer installierten Erweiterung
Name | Typ | Beschreibung |
---|---|---|
autoUpgradeError |
string |
Fehler beim Ausführen des automatischen Upgrades. Wenn die neue Version beispielsweise Anforderungen aufweist, die nicht unterstützt werden, kann die Erweiterung nicht automatisch aktualisiert werden. |
builtIn |
string |
Die Erweiterung ist ein integriertes |
disabled |
string |
Erweiterung ist deaktiviert |
error |
string |
Die Erweiterung befindet sich derzeit in einem Fehlerzustand. |
multiVersion |
string |
Die Erweiterung verfügt über mehrere Versionen |
needsReauthorization |
string |
Erweiterungsbereiche wurden geändert, und die Erweiterung erfordert eine erneute Autorisierung. |
none |
string |
Keine Flags festgelegt |
trusted |
string |
Vertrauenswürdige Erweiterungen sind solche, die spezielle Funktionen erhalten. Diese stammen in der Regel von Microsoft und können nicht von der öffentlichkeit veröffentlicht werden. Hinweis: Integrierte Erweiterungen sind immer vertrauenswürdig. |
unInstalled |
string |
Die Erweiterung ist nicht installiert. Dies gilt nur für integrierte Erweiterungen und kann andernfalls nicht festgelegt werden. |
versionCheckError |
string |
Fehler bei der Versionsüberprüfung |
warning |
string |
Die Erweiterung befindet sich derzeit in einem Warnzustand, der zu einer beeinträchtigten Erfahrung führen kann. Die beeinträchtigte Erfahrung kann z. B. durch einige erkannte Installationsprobleme verursacht werden, z. B. implizite Anforderungen, die nicht unterstützt werden. |
InstalledExtension
Stellt eine VSTS-Erweiterung zusammen mit ihrem Installationsstatus dar.
Name | Typ | Beschreibung |
---|---|---|
baseUri |
string |
URI, der als Basis für andere relative URIs verwendet wird, die in der Erweiterung definiert sind |
constraints |
Liste der von dieser Erweiterung definierten freigegebenen Einschränkungen |
|
contributionTypes |
Liste der von dieser Erweiterung definierten Beitragstypen |
|
contributions |
Liste der von dieser Erweiterung vorgenommenen Beiträge |
|
demands |
string[] |
Liste der expliziten Anforderungen, die für diese Erweiterung erforderlich sind |
eventCallbacks |
Sammlung von Endpunkten, die aufgerufen werden, wenn bestimmte Erweiterungsereignisse auftreten |
|
extensionId |
string |
Die benutzerfreundliche Erweiterungs-ID für diese Erweiterung – eindeutig für einen bestimmten Herausgeber. |
extensionName |
string |
Der Anzeigename der Erweiterung. |
fallbackBaseUri |
string |
Sekundärer Speicherort, der als Basis für andere relative URIs verwendet werden kann, die in der Erweiterung definiert sind |
files |
Dies ist der Satz von Dateien, die über die Erweiterung verfügbar sind. |
|
flags |
Erweiterungsflags, die für Beitragsverbraucher relevant sind |
|
installState |
Informationen zu dieser speziellen Installation der Erweiterung |
|
language |
string |
Vom Katalog festgelegter Name der Sprachkultur |
lastPublished |
string |
Dies stellt das Datum/die Uhrzeit der letzten Aktualisierung der Erweiterungen im Katalog dar. Dies bedeutet nicht, dass diese Version aktualisiert wurde. Der Wert stellt Änderungen an allen Versionen der Erweiterung dar. |
licensing |
Verhalten dieser Erweiterung in Bezug auf die Lizenzierung |
|
manifestVersion |
number |
Version des Erweiterungsmanifestformats/-inhalts |
publisherId |
string |
Eindeutige ID des Herausgebers dieser Erweiterung |
publisherName |
string |
Der Anzeigename des Herausgebers |
registrationId |
string |
Eindeutige ID für diese Erweiterung (dieselbe ID wird für alle Versionen einer einzelnen Erweiterung verwendet) |
restrictedTo |
string[] |
Standardbenutzeransprüche, die auf alle Beiträge angewendet werden (mit Ausnahme derer, die explizit restrictedTo angegeben wurden), um die Sichtbarkeit eines Beitrags zu steuern. |
scopes |
string[] |
Liste aller Oauth-Bereiche, die für diese Erweiterung erforderlich sind |
serviceInstanceType |
string |
Der ServiceInstanceType(Guid) des VSTS-Diensts, der für ein Konto verfügbar sein muss, damit die Erweiterung installiert werden kann. |
version |
string |
Version dieser Erweiterung |
InstalledExtensionState
Der Status einer installierten Erweiterung
Name | Typ | Beschreibung |
---|---|---|
flags |
Zustände einer installierten Erweiterung |
|
installationIssues |
Liste der Installationsprobleme |
|
lastUpdated |
string |
Der Zeitpunkt, zu dem diese Installation zuletzt aktualisiert wurde |
InstalledExtensionStateIssue
Stellt ein Installationsproblem dar.
Name | Typ | Beschreibung |
---|---|---|
message |
string |
Die Fehlermeldung |
source |
string |
Ursache des Installationsproblems, z. B. "Anforderungen" |
type |
Installationsproblemtyp (Warnung, Fehler) |
InstalledExtensionStateIssueType
Installationsproblemtyp (Warnung, Fehler)
Name | Typ | Beschreibung |
---|---|---|
error |
string |
Stellt einen Installationsfehler dar, z. B. eine explizite Anforderung, die nicht unterstützt wird. |
warning |
string |
Stellt eine Installationswarnung dar, z. B. eine implizite Anforderung, die nicht unterstützt wird. |
JObject
Stellt ein JSON-Objekt dar.
Name | Typ | Beschreibung |
---|---|---|
item |
string |
|
type |
string |
Ruft den Knotentyp für dieses JToken ab. |
LicensingOverride
Ordnet einen Beitrag zu einem Lizenzierungsverhalten zu
Name | Typ | Beschreibung |
---|---|---|
behavior |
Wie sich die Einbeziehung dieses Beitrags basierend auf der Lizenzierung ändern sollte |
|
id |
string |
Vollqualifizierte Beitrags-ID, für die das Lizenzierungsverhalten definiert werden soll |
Feedback
https://aka.ms/ContentUserFeedback.
Bald verfügbar: Im Laufe des Jahres 2024 werden wir GitHub-Issues stufenweise als Feedbackmechanismus für Inhalte abbauen und durch ein neues Feedbacksystem ersetzen. Weitere Informationen finden Sie unterFeedback senden und anzeigen für