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 매개 변수

Name	In(다음 안에)	필수	형식	Description
endpointId	path	True	string uuid	업데이트할 엔드포인트의 엔드포인트 ID
organization	path	True	string	Azure DevOps 조직의 이름입니다.
api-version	query	True	string	사용할 API의 버전입니다. 이 버전의 API를 사용하려면 '7.1-preview.4'로 설정해야 합니다.
operation	query		string	작업 유형

요청 본문

Name	형식	Description
administratorsGroup	IdentityRef	더 이상 사용되지 않는 필드입니다.
authorization	EndpointAuthorization	엔드포인트와 통신하기 위한 권한 부여 데이터를 가져오거나 설정합니다.
createdBy	IdentityRef	서비스 엔드포인트를 만든 사용자의 ID 참조를 가져오거나 설정합니다.
data	object
description	string	엔드포인트에 대한 설명을 가져오거나 설정합니다.
groupScopeId	string	더 이상 사용되지 않는 필드입니다.
id	string	이 엔드포인트의 식별자를 가져오거나 설정합니다.
isReady	boolean	엔드포인트 상태 표시기
isShared	boolean	서비스 엔드포인트가 다른 프로젝트와 공유되는지 여부를 나타냅니다.
name	string	엔드포인트의 이름을 가져오거나 설정합니다.
operationStatus	JObject	엔드포인트를 만들/삭제하는 동안 오류 메시지
owner	string	엔드포인트의 소유자가 지원되는 값은 "library", "agentcloud"입니다.
readersGroup	IdentityRef	서비스 엔드포인트의 판독기 그룹에 대한 ID 참조를 가져오거나 설정합니다.
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	서비스 엔드포인트가 공유되는 다른 모든 프로젝트 참조입니다.
type	string	엔드포인트 유형을 가져오거나 설정합니다.
url	string	엔드포인트의 URL을 가져오거나 설정합니다.

응답

Name	형식	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

Name	Description
vso.serviceendpoint_manage	서비스 엔드포인트를 읽고 쿼리하고 관리하는 기능을 부여합니다.

예제

Update service endpoint

Sample Request

HTTP

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"
    }
  ]
}

정의

Name	Description
EndpointAuthorization	서비스 엔드포인트에 사용되는 권한 부여를 나타냅니다.
IdentityRef
JObject	JSON 개체를 나타냅니다.
JToken	추상 JSON 토큰을 나타냅니다.
ProjectReference
ReferenceLinks	REST 참조 링크의 컬렉션을 나타내는 클래스입니다.
ServiceEndpoint	오케스트레이션 작업에서 사용할 수 있는 엔드포인트를 나타냅니다.
ServiceEndpointProjectReference

EndpointAuthorization

서비스 엔드포인트에 사용되는 권한 부여를 나타냅니다.

Name	형식	Description
parameters	object	선택한 권한 부여 체계에 대한 매개 변수를 가져오거나 설정합니다.
scheme	string	서비스 엔드포인트 인증에 사용되는 체계를 가져오거나 설정합니다.

IdentityRef

Name	형식	Description
_links	ReferenceLinks	이 필드에는 그래프 제목에 대한 0개 이상의 흥미로운 링크가 포함되어 있습니다. 이러한 링크를 호출하여 이 그래프 제목에 대한 추가 관계 또는 자세한 정보를 얻을 수 있습니다.
descriptor	string	설명자는 시스템이 실행되는 동안 그래프 제목을 참조하는 기본 방법입니다. 이 필드는 계정과 조직 모두에서 동일한 그래프 제목을 고유하게 식별합니다.
directoryAlias	string	사용되지 않음 - IdentityRef "_links" 사전의 "자체" 항목에서 참조된 Graph 사용자를 쿼리하여 검색할 수 있습니다.
displayName	string	그래프 주체의 고유하지 않은 표시 이름입니다. 이 필드를 변경하려면 원본 공급자에서 해당 값을 변경해야 합니다.
id	string
imageUrl	string	사용되지 않음 - IdentityRef "_links" 사전의 "아바타" 항목에서 사용할 수 있습니다.
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 개체를 나타냅니다.

Name	형식	Description
item	JToken	추상 JSON 토큰을 나타냅니다.
type	string	이 JToken의 노드 형식을 가져옵니다.

JToken

추상 JSON 토큰을 나타냅니다.

Name	형식	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

Name	형식	Description
id	string
name	string

ReferenceLinks

REST 참조 링크의 컬렉션을 나타내는 클래스입니다.

Name	형식	Description
links	object	링크의 읽기 전용 보기입니다. 참조 링크는 읽기 전용이므로 읽기 전용으로만 노출하려고 합니다.

ServiceEndpoint

오케스트레이션 작업에서 사용할 수 있는 엔드포인트를 나타냅니다.

Name	형식	Description
administratorsGroup	IdentityRef	더 이상 사용되지 않는 필드입니다.
authorization	EndpointAuthorization	엔드포인트와 통신하기 위한 권한 부여 데이터를 가져오거나 설정합니다.
createdBy	IdentityRef	서비스 엔드포인트를 만든 사용자의 ID 참조를 가져오거나 설정합니다.
data	object
description	string	엔드포인트에 대한 설명을 가져오거나 설정합니다.
groupScopeId	string	더 이상 사용되지 않는 필드입니다.
id	string	이 엔드포인트의 식별자를 가져오거나 설정합니다.
isReady	boolean	엔드포인트 상태 표시기
isShared	boolean	서비스 엔드포인트가 다른 프로젝트와 공유되는지 여부를 나타냅니다.
name	string	엔드포인트의 이름을 가져오거나 설정합니다.
operationStatus	JObject	엔드포인트를 만들/삭제하는 동안 오류 메시지
owner	string	엔드포인트의 소유자가 지원되는 값은 "library", "agentcloud"입니다.
readersGroup	IdentityRef	서비스 엔드포인트의 판독기 그룹에 대한 ID 참조를 가져오거나 설정합니다.
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	서비스 엔드포인트가 공유되는 다른 모든 프로젝트 참조입니다.
type	string	엔드포인트 유형을 가져오거나 설정합니다.
url	string	엔드포인트의 URL을 가져오거나 설정합니다.

ServiceEndpointProjectReference

Name	형식	Description
description	string	서비스 엔드포인트에 대한 설명을 가져오거나 설정합니다.
name	string	서비스 엔드포인트의 이름을 가져오거나 설정합니다.
projectReference	ProjectReference	서비스 엔드포인트의 프로젝트 참조를 가져오거나 설정합니다.

다음을 통해 공유