Endpoints - Get

Reference

Služba:: Service Endpoint

Verze rozhraní API:: 7.1

Získejte podrobnosti o koncovém bodu služby.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpointId	path	True	string (uuid)	ID koncového bodu služby.
organization	path	True	string	Název organizace Azure DevOps.
project	path	True	string	ID projektu nebo název projektu
api-version	query	True	string	Verze rozhraní API, která se má použít. Pokud chcete použít tuto verzi rozhraní API, měla by být nastavená na hodnotu 7.1.
actionFilter	query		ServiceEndpointActionFilter	Filtr akcí pro připojení služby Určuje akci, kterou lze provést u připojení služby.

Odpovědi

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

Zabezpečení

oauth2

Typ: oauth2
Tok: accessCode
URL autorizace: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL tokenu: 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

Rozsahy

Name	Description
vso.serviceendpoint	Uděluje možnost číst koncové body služby.

Příklady

Get service endpoint details

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 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": "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",
      "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 používat úloha orchestrace.
ServiceEndpointActionFilter	Filtr akcí pro připojení služby Určuje akci, kterou lze provést u připojení služby.
ServiceEndpointProjectReference

EndpointAuthorization

Objekt

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žité pro ověřování koncového bodu služby.

IdentityRef

Objekt

Name	Typ	Description
_links	ReferenceLinks	Toto pole obsahuje nula nebo zajímavější odkazy 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 tématu grafu.
descriptor	string	Popisovač je primární způsob, jak odkazovat na předmět grafu, když je systém spuštěný. Toto pole jednoznačně identifikuje stejné téma grafu v rámci účtů i organizací.
directoryAlias	string	Zastaralé – Je možné načíst dotazováním uživatele Graphu, na který odkazuje položka "self" slovníku IdentityRef "_links".
displayName	string	Toto je ne jedinečný zobrazovaný název předmětu grafu. Pokud chcete toto pole změnit, musíte změnit jeho hodnotu ve zdrojovém zprostředkovateli.
id	string
imageUrl	string	Zastaralé – k dispozici v položce avatar ve slovníku IdentityRef "_links"
inactive	boolean	Zastaralé – Lze načíst dotazem na stav členství v grafu odkazovaném v položce "membershipState" slovníku GraphUser "_links"
isAadIdentity	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Zastaralé – lze odvodit z typu předmětu popisovače (Popisovač.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Zastaralé – nepoužívá se ve většině existujících implementací ToIdentityRef
uniqueName	string	Zastaralé – místo toho použijte Domain+PrincipalName.
url	string	Tato adresa URL je úplná trasa ke zdrojovému prostředku tohoto předmětu grafu.

JObject

Objekt

Představuje objekt JSON.

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

JToken

Objekt

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 tento token má 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 (JContainer)	Získá nebo nastaví nadřazený objekt.
path	string	Získá cestu tokenu JSON.
previous	JToken	Získá předchozí token na stejné úrovni tohoto uzlu.
root	JToken	Získá kořenový JToken tohoto JTokenu.
type	string (JTokenType)	Získá typ uzlu pro tento JToken.

ProjectReference

Objekt

Name	Typ	Description
id	string (uuid)
name	string

ReferenceLinks

Objekt

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

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

ServiceEndpoint

Objekt

Představuje koncový bod, který může používat úloha 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 (uuid)	Toto je zastaralé pole.
id	string (uuid)	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 podporovaných hodnot koncového bodu 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í odkazy na projekt, kde je koncový bod služby sdílený.
type	string	Získá nebo nastaví typ koncového bodu.
url	string	Získá nebo nastaví adresu URL koncového bodu.

ServiceEndpointActionFilter

Výčet

Filtr akcí pro připojení služby Určuje akci, kterou lze provést u připojení služby.

Hodnota	Description
manage
none
use
view

ServiceEndpointProjectReference

Objekt

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 - Get

Parametry identifikátoru URI

Odpovědi

Zabezpečení

oauth2

Rozsahy

Příklady

Get service endpoint details

Ukázkový požadavek

Ukázková odpověď

Definice

EndpointAuthorization

IdentityRef

JObject

JToken

ProjectReference

ReferenceLinks

ServiceEndpoint

ServiceEndpointActionFilter

ServiceEndpointProjectReference

Další materiály