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

Имя	В	Обязательно	Тип	Описание
endpointId	path	True	string uuid	Идентификатор конечной точки для обновления
organization	path	True	string	Название организации Azure DevOps.
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.4.
operation	query		string	Тип операции

Текст запроса

Имя	Тип	Описание
administratorsGroup	IdentityRef	Это нерекомендуемое поле.
authorization	EndpointAuthorization	Возвращает или задает данные авторизации для подключения к конечной точке.
createdBy	IdentityRef	Возвращает или задает ссылку на удостоверение для пользователя, создавшего конечную точку службы.
data	object
description	string	Возвращает или задает описание конечной точки.
groupScopeId	string	Это нерекомендуемое поле.
id	string	Возвращает или задает идентификатор этой конечной точки.
isReady	boolean	Индикатор состояния конечной точки
isShared	boolean	Указывает, используется ли конечная точка службы совместно с другими проектами.
name	string	Возвращает или задает понятное имя конечной точки.
operationStatus	JObject	Сообщение об ошибке при создании или удалении конечной точки
owner	string	Владелец конечной точки. Поддерживаются следующие значения: library, agentcloud.
readersGroup	IdentityRef	Возвращает или задает ссылку на удостоверение для группы читателей конечной точки службы.
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	Все остальные проекты ссылались на то, где используется общая конечная точка службы.
type	string	Возвращает или задает тип конечной точки.
url	string	Возвращает или задает URL-адрес конечной точки.

Ответы

Имя	Тип	Описание
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_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"
    }
  ]
}

Определения

Имя	Описание
EndpointAuthorization	Представляет авторизацию, используемую для конечной точки службы.
IdentityRef
JObject	Представляет объект JSON.
JToken	Представляет абстрактный токен JSON.
ProjectReference
ReferenceLinks	Класс, представляющий коллекцию ссылок REST.
ServiceEndpoint	Представляет конечную точку, которую может использовать задание оркестрации.
ServiceEndpointProjectReference

EndpointAuthorization

Представляет авторизацию, используемую для конечной точки службы.

Имя	Тип	Описание
parameters	object	Возвращает или задает параметры для выбранной схемы авторизации.
scheme	string	Возвращает или задает схему, используемую для проверки подлинности конечной точки службы.

IdentityRef

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит ноль или более интересных ссылок на тему графа. Эти ссылки можно вызвать для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на субъект графа во время работы системы. Это поле однозначно идентифицирует одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string	Нерекомендуемый — можно получить, запросив пользователя Graph, на который ссылается запись self словаря IdentityRef _links.
displayName	string	Это неуникальное отображаемое имя субъекта графа. Чтобы изменить это поле, необходимо изменить его значение в поставщике источника.
id	string
imageUrl	string	Не рекомендуется — доступно в записи "аватар" словаря IdentityRef "_links"
inactive	boolean	Не рекомендуется — можно получить, запросив состояние членства Graph, указанное в записи membershipState словаря GraphUser _links.
isAadIdentity	boolean	Не рекомендуется — может выводиться из типа субъекта дескриптора (descriptor.IsAadUserType/descriptor.IsAadGroupType).
isContainer	boolean	Не рекомендуется — может выводиться из типа субъекта дескриптора (Descriptor.IsGroupType).
isDeletedInOrigin	boolean
profileUrl	string	Нерекомендуемый — не используется в большинстве уже существовающих реализаций ToIdentityRef.
uniqueName	string	Нерекомендуемый — используйте вместо этого домен+имя_субъекта
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	Индикатор состояния конечной точки
isShared	boolean	Указывает, используется ли конечная точка службы совместно с другими проектами.
name	string	Возвращает или задает понятное имя конечной точки.
operationStatus	JObject	Сообщение об ошибке при создании или удалении конечной точки
owner	string	Владелец конечной точки. Поддерживаются следующие значения: library, agentcloud.
readersGroup	IdentityRef	Возвращает или задает ссылку на удостоверение для группы читателей конечной точки службы.
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	Все остальные проекты ссылались на то, где используется общая конечная точка службы.
type	string	Возвращает или задает тип конечной точки.
url	string	Возвращает или задает URL-адрес конечной точки.

ServiceEndpointProjectReference

Имя	Тип	Описание
description	string	Возвращает или задает описание конечной точки службы.
name	string	Возвращает или задает имя конечной точки службы.
projectReference	ProjectReference	Возвращает или задает ссылку на проект конечной точки службы.

Поделиться через