Endpoints - Create

Ссылка

Служба:: Service Endpoint

Версия API:: 7.1

Создает новую конечную точку службы

POST https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints?api-version=7.1

Параметры URI

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

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

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

Ответы

Имя	Тип	Описание
200 OK	ServiceEndpoint	успешная операция

Безопасность

oauth2

Тип: oauth2
Flow: accessCode
URL-адрес авторизации: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
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

Области

Имя	Описание
vso.serviceendpoint_manage	Предоставляет возможность читать, запрашивать конечные точки службы и управлять ими.

Примеры

Create Azure RM service endpoint

Create service endpoint

Create Azure RM service endpoint

Образец запроса

HTTP

POST https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints?api-version=7.1

{
  "data": {
    "subscriptionId": "1272a66f-e2e8-4e88-ab43-487409186c3f",
    "subscriptionName": "subscriptionName",
    "environment": "AzureCloud",
    "scopeLevel": "Subscription",
    "creationMode": "Manual"
  },
  "name": "MyNewARMServiceEndpoint",
  "type": "AzureRM",
  "url": "https://management.azure.com/",
  "authorization": {
    "parameters": {
      "tenantid": "1272a66f-e2e8-4e88-ab43-487409186c3f",
      "serviceprincipalid": "1272a66f-e2e8-4e88-ab43-487409186c3f",
      "authenticationType": "spnKey",
      "serviceprincipalkey": "SomePassword"
    },
    "scheme": "ServicePrincipal"
  },
  "isShared": false,
  "isReady": true,
  "serviceEndpointProjectReferences": [
    {
      "projectReference": {
        "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
        "name": "TestProject"
      },
      "name": "MyNewARMServiceEndpoint"
    }
  ]
}

Пример ответа

Код состояния:: 200

{
  "data": {
    "subscriptionId": "1272a66f-e2e8-4e88-ab43-487409186c3f",
    "subscriptionName": "subscriptionName",
    "environment": "AzureCloud",
    "scopeLevel": "Subscription",
    "creationMode": "Manual"
  },
  "id": "1dfdea68-9549-409e-abee-c5da69cfec5f",
  "name": "MyNewARMServiceEndpoint",
  "type": "AzureRM",
  "url": "https://management.azure.com/",
  "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": "anpuri@outlook-int.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll",
    "descriptor": "msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll"
  },
  "authorization": {
    "parameters": {
      "tenantid": "1272a66f-e2e8-4e88-ab43-487409186c3f",
      "serviceprincipalid": "1272a66f-e2e8-4e88-ab43-487409186c3f",
      "authenticationType": "spnKey",
      "serviceprincipalkey": null
    },
    "scheme": "ServicePrincipal"
  },
  "isShared": false,
  "isReady": true,
  "owner": "library",
  "serviceEndpointProjectReferences": [
    {
      "projectReference": {
        "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
        "name": "TestProject"
      },
      "name": "MyNewARMServiceEndpoint"
    }
  ]
}

Create service endpoint

Образец запроса

HTTP

POST https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints?api-version=7.1

{
  "data": {},
  "name": "MyNewServiceEndpoint",
  "type": "Generic",
  "url": "https://myserver",
  "authorization": {
    "parameters": {
      "username": "myusername",
      "password": "mysecretpassword"
    },
    "scheme": "UsernamePassword"
  },
  "isShared": false,
  "isReady": true,
  "serviceEndpointProjectReferences": [
    {
      "projectReference": {
        "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
        "name": "TestProject"
      },
      "name": "MyNewServiceEndpoint"
    }
  ]
}

Пример ответа

Код состояния:: 200

{
  "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": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll",
    "descriptor": "msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll"
  },
  "authorization": {
    "parameters": {
      "username": "myusername",
      "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

Object

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

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

IdentityRef

Object

Имя	Тип	Описание
_links	ReferenceLinks	Это поле содержит нулевые или более интересные ссылки на тему графа. Эти ссылки могут вызываться для получения дополнительных связей или более подробных сведений об этой теме графа.
descriptor	string	Дескриптор является основным способом ссылки на тему графа во время выполнения системы. Это поле однозначно определяет одну и ту же тему графа как в учетных записях, так и в организациях.
directoryAlias	string	Нерекомендуемое. Можно получить, запросив пользователя Graph, на который ссылается пользователь 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	Не рекомендуется — вместо этого используйте domain+PrincipalName
url	string	Этот URL-адрес является полным маршрутом к исходному ресурсу данного субъекта графа.

JObject

Object

Представляет объект JSON.

Имя	Тип	Описание
item	JToken	Представляет абстрактный токен JSON.
type	string (JTokenType)	Возвращает тип узла для этого JToken.

JToken

Object

Представляет абстрактный токен JSON.

Имя	Тип	Описание
first	JToken	Получите первый дочерний маркер этого токена.
hasValues	boolean	Возвращает значение, указывающее, имеет ли этот маркер дочерние маркеры.
item	JToken	Представляет абстрактный токен JSON.
last	JToken	Получите последний дочерний маркер этого токена.
next	JToken	Возвращает следующий одноуровневый маркер этого узла.
parent	string (JContainer)	Возвращает или задает родительский объект.
path	string	Возвращает путь маркера JSON.
previous	JToken	Возвращает предыдущий одноуровневый маркер этого узла.
root	JToken	Возвращает корневой JToken этого JToken объекта JToken.
type	string (JTokenType)	Возвращает тип узла для этого JToken.

ProjectReference

Object

Имя	Тип	Описание
id	string (uuid)
name	string

ReferenceLinks

Object

Класс, представляющий коллекцию ссылок REST.

Имя	Тип	Описание
links	object	Режим чтения ссылок. Так как ссылки ссылки доступны только для чтения, мы хотим предоставлять их только как доступные только для чтения.

ServiceEndpoint

Object

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

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

ServiceEndpointProjectReference

Object

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