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 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
project	path	True	string	項目識別碼或項目名稱
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)	服務端點的標識碼。
includeDetails	query		boolean	旗標，以包含服務端點的詳細數據。這是僅供內部使用，而且所有其他要求都會將旗標視為 false
includeFailed	query		boolean	服務端點的失敗旗標。
owner	query		string	服務端點的擁有者。
type	query		string	服務端點的類型。

回應

名稱	類型	Description
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

名稱	Description
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"
        }
      ]
    }
  ]
}

定義

名稱	Description
EndpointAuthorization	表示用於服務端點的授權。
IdentityRef
JObject	表示 JSON 物件。
JToken	表示抽象 JSON 令牌。
ProjectReference
ReferenceLinks	表示 REST 參考連結集合的類別。
ServiceEndpoint	表示協調流程作業可能使用的端點。
ServiceEndpointActionFilter	“actionFilter” 參數可讓用戶評估要求者許可權，並擷取符合指定條件的端點清單，確保只會根據其許可權傳回相關的端點
ServiceEndpointProjectReference

EndpointAuthorization

表示用於服務端點的授權。

名稱	類型	Description
parameters	object	取得或設定所選授權配置的參數。
scheme	string	取得或設定用於服務端點驗證的配置。

IdentityRef

名稱	類型	Description
_links	ReferenceLinks	此欄位包含有關圖表主旨的零個或多個有趣連結。您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。
descriptor	string	描述項是在系統執行時參考圖形主旨的主要方式。此欄位可唯一識別帳戶和組織之間的相同圖表主旨。
directoryAlias	string	已淘汰 - 藉由查詢 IdentityRef “_links” 字典之 “self” 項目中參考的 Graph 使用者，即可擷取
displayName	string	這是圖表主旨的非唯一顯示名稱。若要變更此欄位，您必須在來源提供者中變更其值。
id	string
imageUrl	string	已淘汰 - 可在 IdentityRef “_links” 字典的 “avatar” 專案中使用
inactive	boolean	已淘汰 - 您可以查詢 GraphUser “_links” 字典的 “membershipState” 專案中參考的 Graph 成員資格狀態來擷取
isAadIdentity	boolean	已被取代 - 可以從描述元的主旨類型推斷 (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	已被取代 - 可以從描述元的主旨類型推斷 (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	已淘汰 - 不在 ToIdentityRef 的大多數既有實作中使用
uniqueName	string	已淘汰 - 請改用 Domain+PrincipalName
url	string	此 URL 是此圖表主體來源資源的完整路由。

JObject

表示 JSON 物件。

名稱	類型	Description
item	JToken	表示抽象 JSON 令牌。
type	string	取得這個 JToken 的節點類型。

JToken

表示抽象 JSON 令牌。

名稱	類型	Description
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

名稱	類型	Description
id	string
name	string

ReferenceLinks

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的只讀檢視。因為參考連結是只讀的，所以我們只想要將它們公開為只讀。

ServiceEndpoint

表示協調流程作業可能使用的端點。

名稱	類型	Description
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” 參數可讓用戶評估要求者許可權，並擷取符合指定條件的端點清單，確保只會根據其許可權傳回相關的端點

名稱	類型	Description
manage	string
none	string
use	string
view	string

ServiceEndpointProjectReference

名稱	類型	Description
description	string	取得或設定服務端點的描述。
name	string	取得或設定服務端點的名稱。
projectReference	ProjectReference	取得或設定服務端點的項目參考。

共用方式為