共用方式為

Endpoints - Update Service Endpoint

  • 參考
Service:
Service Endpoint
API Version:
7.1-preview.4

更新服務端點

PUT https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints/{endpointId}?api-version=7.1-preview.4
With optional parameters: 
PUT https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints/{endpointId}?operation={operation}&api-version=7.1-preview.4

URI 參數

名稱 位於 必要 類型 Description
endpointId
 path True

string

uuid

要更新之端點的端點識別碼
organization
 path True

string

Azure DevOps 組織的名稱。
api-version
 query True

string

要使用的 API 版本。 這應該設定為 '7.1-preview.4'，以使用此版本的 API。
operation
 query

string

作業類型

要求本文

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

回應

名稱 類型 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_manage 授與讀取、查詢及管理服務端點的能力。

範例

Update service endpoint

Sample Request

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

{
  "data": {},
  "id": "5e47a0d8-c745-44f8-8f93-784f18ff31c4",
  "name": "UpdatedServiceEndpoint",
  "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": "myupdatedusername",
      "password": "myupdatedpassword"
    },
    "scheme": "UsernamePassword"
  },
  "isShared": false,
  "isReady": true,
  "owner": "Library",
  "serviceEndpointProjectReferences": [
    {
      "projectReference": {
        "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
        "name": "TestProject"
      },
      "name": "MyNewServiceEndpoint"
    }
  ]
}

Sample Response

Status code:
200 
{
  "data": {},
  "id": "5e47a0d8-c745-44f8-8f93-784f18ff31c4",
  "name": "UpdatedServiceEndpoint",
  "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": "myupdatedusername",
      "password": null
    },
    "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

表示協調流程作業可能使用的端點。
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

已被取代 - 可以從描述元的主旨類型推斷 (描述元.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

已被取代 - 可以從描述元的主旨類型推斷 (描述元.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

表示 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。

ServiceEndpointProjectReference

名稱 類型 Description
description

string

取得或設定服務端點的描述。
name

string

取得或設定服務端點的名稱。
projectReference

ProjectReference

取得或設定服務端點的專案參考。