Endpoints - Get Service Endpoints By Names

Ссылка

Service:: Service Endpoint

API Version:: 7.1-preview.4

Получение конечных точек службы по имени.

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

With optional parameters:

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
project	path	True	string	Идентификатор или имя проекта
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.4.
endpointNames	query	True	string array (string)	Имена конечных точек службы.
authSchemes	query		string array (string)	Схемы авторизации, используемые для конечных точек службы.
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 by names

Sample Request

HTTP

GET https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?endpointNames=MyNewServiceEndpoint&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	Представляет конечную точку, которая может использоваться заданием оркестрации.
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	Не рекомендуется использовать вместо него домен+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-адрес конечной точки.

ServiceEndpointProjectReference

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

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