Endpoints - Get Service Endpoints

参考

Service:: Service Endpoint

API Version:: 7.1-preview.4

获取服务终结点。

GET https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?api-version=7.1-preview.4

With optional parameters:

GET https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?type={type}&authSchemes={authSchemes}&endpointIds={endpointIds}&owner={owner}&includeFailed={includeFailed}&includeDetails={includeDetails}&actionFilter={actionFilter}&api-version=7.1-preview.4

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
project	path	True	string	项目 ID 或项目名称
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1-preview.4”才能使用此版本的 API。
actionFilter	query		ServiceEndpointActionFilter	“actionFilter”参数允许用户评估请求者权限并检索与指定条件匹配的终结点列表，确保仅根据其权限返回相关终结点
authSchemes	query		string array (string)	用于服务终结点的授权方案。
endpointIds	query		string array (uuid)	服务终结点的 ID。
includeDetails	query		boolean	用于包含服务终结点的更多详细信息的标志。这仅供内部使用，对于所有其他请求，标志将被视为 false
includeFailed	query		boolean	服务终结点的失败标志。
owner	query		string	服务终结点的所有者。
type	query		string	服务终结点的类型。

响应

名称	类型	说明
200 OK	ServiceEndpoint[]	成功的操作

安全性

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.serviceendpoint	授予读取服务终结点的能力。

示例

Get service endpoints

Sample Request

HTTP

GET https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?type=Generic&api-version=7.1-preview.4

Sample Response

Status code:: 200

{
  "count": 1,
  "value": [
    {
      "data": {},
      "id": "5e47a0d8-c745-44f8-8f93-784f18ff31c4",
      "name": "MyNewServiceEndpoint",
      "type": "Generic",
      "url": "https://myserver",
      "createdBy": {
        "displayName": "Chuck Reinhart",
        "url": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/e18a1f0a-b112-67fd-a9e0-e3bb081da49e",
        "_links": {
          "avatar": {
            "href": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll"
          }
        },
        "id": "e18a1f0a-b112-67fd-a9e0-e3bb081da49e",
        "uniqueName": "fabfiber@outlook.com",
        "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll",
        "descriptor": "msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll"
      },
      "description": "",
      "authorization": {
        "parameters": {
          "username": "myusername"
        },
        "scheme": "UsernamePassword"
      },
      "isShared": false,
      "isReady": true,
      "owner": "Library",
      "serviceEndpointProjectReferences": [
        {
          "projectReference": {
            "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
            "name": "TestProject"
          },
          "name": "MyNewServiceEndpoint"
        }
      ]
    }
  ]
}

定义

名称	说明
EndpointAuthorization	表示用于服务终结点的授权。
IdentityRef
JObject	表示 JSON 对象。
JToken	表示抽象 JSON 令牌。
ProjectReference
ReferenceLinks	表示 REST 引用链接集合的类。
ServiceEndpoint	表示可由业务流程作业使用的终结点。
ServiceEndpointActionFilter	“actionFilter”参数允许用户评估请求者权限并检索与指定条件匹配的终结点列表，确保仅根据其权限返回相关终结点
ServiceEndpointProjectReference

EndpointAuthorization

表示用于服务终结点的授权。

名称	类型	说明
parameters	object	获取或设置所选授权方案的参数。
scheme	string	获取或设置用于服务终结点身份验证的方案。

IdentityRef

名称	类型	说明
_links	ReferenceLinks	此字段包含零个或多个有关图形主题的有趣链接。可以调用这些链接来获取有关此图主题的其他关系或更详细的信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方法。此字段将唯一标识帐户和组织中的同一图形主题。
directoryAlias	string	已弃用 - 可通过查询 IdentityRef“_links”字典的“self”条目中引用的 Graph 用户来检索
displayName	string	这是图形主题的非唯一显示名称。若要更改此字段，必须在源提供程序中更改其值。
id	string
imageUrl	string	已弃用 - 在 IdentityRef“_links”字典的“头像”条目中可用
inactive	boolean	已弃用 - 可通过查询 GraphUser“_links”字典的“membershipState”条目中引用的 Graph 成员身份状态来检索
isAadIdentity	boolean	已弃用 - 可以从描述符的主题类型推断 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已弃用 - 可以从描述符的主题类型推断 (描述符.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已弃用 - 未在 ToIdentityRef 的大多数预先存在的实现中使用
uniqueName	string	已弃用 - 改用 Domain+PrincipalName
url	string	此 URL 是指向此图主题的源资源的完整路由。

JObject

表示 JSON 对象。

名称	类型	说明
item	JToken	表示抽象 JSON 令牌。
type	string	获取此 JToken 的节点类型。

JToken

表示抽象 JSON 令牌。

名称	类型	说明
first	JToken	获取此令牌的第一个子令牌。
hasValues	boolean	获取一个值，该值指示此令牌是否具有子标记。
item	JToken	表示抽象 JSON 令牌。
last	JToken	获取此令牌的最后一个子令牌。
next	JToken	获取此节点的下一个同级标记。
parent	string	获取或设置父对象。
path	string	获取 JSON 令牌的路径。
previous	JToken	获取此节点的上一个同级标记。
root	JToken	获取此 JToken 的根 JToken。
type	string	获取此 JToken 的节点类型。

ProjectReference

名称	类型	说明
id	string
name	string

ReferenceLinks

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读。

ServiceEndpoint

表示可由业务流程作业使用的终结点。

名称	类型	说明
administratorsGroup	IdentityRef	这是一个已弃用的字段。
authorization	EndpointAuthorization	获取或设置用于与终结点通信的授权数据。
createdBy	IdentityRef	获取或设置创建服务终结点的用户的标识引用。
data	object
description	string	获取或设置终结点的说明。
groupScopeId	string	这是一个已弃用的字段。
id	string	获取或设置此终结点的标识符。
isReady	boolean	EndPoint 状态指示器
isShared	boolean	指示服务终结点是否与其他项目共享。
name	string	获取或设置终结点的友好名称。
operationStatus	JObject	创建/删除终结点期间出现错误消息
owner	string	终结点的所有者支持的值为“library”、“agentcloud”
readersGroup	IdentityRef	获取或设置服务终结点的读取器组的标识引用。
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	共享服务终结点的所有其他项目引用。
type	string	获取或设置端点的类型。
url	string	获取或设置终结点的 URL。

ServiceEndpointActionFilter

“actionFilter”参数允许用户评估请求者权限并检索与指定条件匹配的终结点列表，确保仅根据其权限返回相关终结点

名称	类型	说明
manage	string
none	string
use	string
view	string

ServiceEndpointProjectReference

名称	类型	说明
description	string	获取或设置服务终结点的说明。
name	string	获取或设置服务终结点的名称。
projectReference	ProjectReference	获取或设置服务终结点的项目引用。

通过