Endpoints - Create

Reference

Service:: Service Endpoint

API Version:: 7.1-preview.4

Vytvoří nový koncový bod služby.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.4.

Text požadavku

Name	Typ	Description
administratorsGroup	IdentityRef	Toto je zastaralé pole.
authorization	EndpointAuthorization	Získá nebo nastaví autorizační data pro komunikaci s koncovým bodem.
createdBy	IdentityRef	Získá nebo nastaví odkaz na identitu pro uživatele, který vytvořil koncový bod služby.
data	object
description	string	Získá nebo nastaví popis koncového bodu.
groupScopeId	string	Toto je zastaralé pole.
id	string	Získá nebo nastaví identifikátor tohoto koncového bodu.
isReady	boolean	Indikátor stavu koncového bodu
isShared	boolean	Určuje, jestli se koncový bod služby sdílí s jinými projekty, nebo ne.
name	string	Získá nebo nastaví popisný název koncového bodu.
operationStatus	JObject	Chybová zpráva při vytváření nebo odstraňování koncového bodu
owner	string	Vlastník koncového bodu Podporované hodnoty jsou "library", "agentcloud".
readersGroup	IdentityRef	Získá nebo nastaví odkaz na identitu pro skupinu čtenářů koncového bodu služby.
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	Všechny ostatní projekty odkazují na sdílení koncového bodu služby.
type	string	Získá nebo nastaví typ koncového bodu.
url	string	Získá nebo nastaví adresu URL koncového bodu.

Odpovědi

Name	Typ	Description
200 OK	ServiceEndpoint	úspěšná operace

Zabezpečení

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	Uděluje možnost číst, dotazovat a spravovat koncové body služby.

Příklady

Create Azure RM service endpoint

Create service endpoint

Create Azure RM service endpoint

Sample Request

HTTP

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

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

Sample Response

Status code:: 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

Sample Request

HTTP

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

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

Sample Response

Status code:: 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"
    }
  ]
}

Definice

Name	Description
EndpointAuthorization	Představuje autorizaci použitou pro koncový bod služby.
IdentityRef
JObject	Představuje objekt JSON.
JToken	Představuje abstraktní token JSON.
ProjectReference
ReferenceLinks	Třída představující kolekci odkazů REST.
ServiceEndpoint	Představuje koncový bod, který může být použit úlohou orchestrace.
ServiceEndpointProjectReference

EndpointAuthorization

Představuje autorizaci použitou pro koncový bod služby.

Name	Typ	Description
parameters	object	Získá nebo nastaví parametry pro vybrané schéma autorizace.
scheme	string	Získá nebo nastaví schéma používané pro ověřování koncového bodu služby.

IdentityRef

Name	Typ	Description
_links	ReferenceLinks	Toto pole neobsahuje žádný nebo více zajímavých odkazů na téma grafu. Tyto odkazy mohou být vyvolány za účelem získání dalších relací nebo podrobnějších informací o tomto předmětu grafu.
descriptor	string	Popisovač je primárním způsobem, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejný předmět grafu v rámci účtů i organizací.
directoryAlias	string	Zastaralé – Dá se načíst dotazem na uživatele Graphu odkazovaného v položce "self" slovníku IdentityRef "_links"
displayName	string	Toto je jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém poskytovateli.
id	string
imageUrl	string	Zastaralé – k dispozici v položce "avatar" ve slovníku IdentityRef "_links"
inactive	boolean	Zastaralé – Můžete ho načíst dotazem na stav členství v Graphu, na který odkazuje položka membershipState slovníku _links GraphUser.
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Zastaralé – Lze odvodit z typu předmětu popisovače (Descriptor.IsGroupType).
isDeletedInOrigin	boolean
profileUrl	string	Zastaralé – nepoužívá se ve většině dříve existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL představuje úplnou trasu ke zdrojovému prostředku tohoto předmětu grafu.

JObject

Představuje objekt JSON.

Name	Typ	Description
item	JToken	Představuje abstraktní token JSON.
type	string	Získá typ uzlu pro tento JToken.

JToken

Představuje abstraktní token JSON.

Name	Typ	Description
first	JToken	Získejte první podřízený token tohoto tokenu.
hasValues	boolean	Získá hodnotu označující, zda má tento token podřízené tokeny.
item	JToken	Představuje abstraktní token JSON.
last	JToken	Získejte poslední podřízený token tohoto tokenu.
next	JToken	Získá další token na stejné úrovni tohoto uzlu.
parent	string	Získá nebo nastaví nadřazenou položku.
path	string	Získá cestu k tokenu JSON.
previous	JToken	Získá předchozí token na stejné úrovni tohoto uzlu.
root	JToken	Získá kořenový JToken tohoto JToken.
type	string	Získá typ uzlu pro tento JToken.

ProjectReference

Name	Typ	Description
id	string
name	string

ReferenceLinks

Třída představující kolekci odkazů REST.

Name	Typ	Description
links	object	Zobrazení odkazů jen pro čtení. Vzhledem k tomu, že odkazy jsou jen pro čtení, chceme je zveřejnit jenom jako odkazy jen pro čtení.

ServiceEndpoint

Představuje koncový bod, který může být použit úlohou orchestrace.

Name	Typ	Description
administratorsGroup	IdentityRef	Toto je zastaralé pole.
authorization	EndpointAuthorization	Získá nebo nastaví autorizační data pro komunikaci s koncovým bodem.
createdBy	IdentityRef	Získá nebo nastaví odkaz na identitu pro uživatele, který vytvořil koncový bod služby.
data	object
description	string	Získá nebo nastaví popis koncového bodu.
groupScopeId	string	Toto je zastaralé pole.
id	string	Získá nebo nastaví identifikátor tohoto koncového bodu.
isReady	boolean	Indikátor stavu koncového bodu
isShared	boolean	Určuje, jestli se koncový bod služby sdílí s jinými projekty, nebo ne.
name	string	Získá nebo nastaví popisný název koncového bodu.
operationStatus	JObject	Chybová zpráva při vytváření nebo odstraňování koncového bodu
owner	string	Vlastník koncového bodu Podporované hodnoty jsou "library", "agentcloud".
readersGroup	IdentityRef	Získá nebo nastaví odkaz na identitu pro skupinu čtenářů koncového bodu služby.
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	Všechny ostatní projekty odkazují na sdílení koncového bodu služby.
type	string	Získá nebo nastaví typ koncového bodu.
url	string	Získá nebo nastaví adresu URL koncového bodu.

ServiceEndpointProjectReference

Name	Typ	Description
description	string	Získá nebo nastaví popis koncového bodu služby.
name	string	Získá nebo nastaví název koncového bodu služby.
projectReference	ProjectReference	Získá nebo nastaví odkaz na projekt koncového bodu služby.

Sdílet prostřednictvím

Endpoints - Create

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

oauth2

Scopes

Příklady

Create Azure RM service endpoint

Sample Request

Sample Response

Create service endpoint

Sample Request

Sample Response

Definice

EndpointAuthorization

IdentityRef

JObject

JToken

ProjectReference

ReferenceLinks

ServiceEndpoint

ServiceEndpointProjectReference

Další materiály