Udostępnij za pośrednictwem

Endpoints - Get Service Endpoints

  • Odwołanie
Service:
Service Endpoint
API Version:
7.1-preview.4

Pobierz punkty końcowe usługi.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
organization
 path True

string

Nazwa organizacji usługi Azure DevOps.
project
 path True

string

Identyfikator projektu lub nazwa projektu
api-version
 query True

string

Wersja interfejsu API do użycia. Ta wersja interfejsu API powinna być ustawiona na wartość "7.1-preview.4".
actionFilter
 query

ServiceEndpointActionFilter

Parametr "actionFilter" umożliwia użytkownikom ocenę uprawnień osoby żądającej i pobranie listy punktów końcowych spełniających określone warunki, zapewniając, że zwracane są tylko odpowiednie punkty końcowe na podstawie ich uprawnień
authSchemes
 query

string

array (string)

Schematy autoryzacji używane dla punktów końcowych usługi.
endpointIds
 query

string

array (uuid)

Identyfikatory punktów końcowych usługi.
includeDetails
 query

boolean

Flaga w celu uwzględnienia dodatkowych szczegółów dotyczących punktów końcowych usługi. Dotyczy to tylko użytku wewnętrznego, a flaga będzie traktowana jako fałsz dla wszystkich innych żądań
includeFailed
 query

boolean

Flaga niepowodzenia dla punktów końcowych usługi.
owner
 query

string

Właściciel punktów końcowych usługi.
type
 query

string

Typ punktów końcowych usługi.

Odpowiedzi

Nazwa Typ Opis
200 OK

ServiceEndpoint[]

operacja zakończona powodzeniem

Zabezpieczenia

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

Nazwa Opis
vso.serviceendpoint Umożliwia odczytywanie punktów końcowych usługi.

Przykłady

Get service endpoints

Sample Request

GET https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?type=Generic&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"
        }
      ]
    }
  ]
}

Definicje

Nazwa Opis
EndpointAuthorization

Reprezentuje autoryzację używaną dla punktu końcowego usługi.
IdentityRef
JObject

Reprezentuje obiekt JSON.
JToken

Reprezentuje abstrakcyjny token JSON.
ProjectReference
ReferenceLinks

Klasa reprezentująca kolekcję linków referencyjnych REST.
ServiceEndpoint

Reprezentuje punkt końcowy, który może być używany przez zadanie orkiestracji.
ServiceEndpointActionFilter

Parametr "actionFilter" umożliwia użytkownikom ocenę uprawnień osoby żądającej i pobranie listy punktów końcowych spełniających określone warunki, zapewniając, że zwracane są tylko odpowiednie punkty końcowe na podstawie ich uprawnień
ServiceEndpointProjectReference

EndpointAuthorization

Reprezentuje autoryzację używaną dla punktu końcowego usługi.

Nazwa Typ Opis
parameters

object

Pobiera lub ustawia parametry dla wybranego schematu autoryzacji.
scheme

string

Pobiera lub ustawia schemat używany do uwierzytelniania punktu końcowego usługi.

IdentityRef

Nazwa Typ Opis
_links

ReferenceLinks

To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor

string

Deskryptor jest podstawowym sposobem odwołowania się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias

string

Przestarzałe — można pobrać, wysyłając zapytanie do użytkownika programu Graph przywoływanego w wpisie "self" słownika IdentityRef "_links"
displayName

string

Jest to unikatowa nazwa wyświetlana tematu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
id

string

imageUrl

string

Przestarzałe — dostępne w wpisie "avatar" słownika IdentityRef "_links"
inactive

boolean

Przestarzałe — można pobrać, wysyłając zapytanie do stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links"
isAadIdentity

boolean

Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

Przestarzałe — nie jest używane w większości istniejących implementacji toIdentityRef
uniqueName

string

Przestarzałe — zamiast tego użyj nazwy Domain+PrincipalName
url

string

Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

JObject

Reprezentuje obiekt JSON.

Nazwa Typ Opis
item

JToken

Reprezentuje abstrakcyjny token JSON.
type

string

Pobiera typ węzła dla tego zestawu JToken.

JToken

Reprezentuje abstrakcyjny token JSON.

Nazwa Typ Opis
first

JToken

Pobierz pierwszy token podrzędny tego tokenu.
hasValues

boolean

Pobiera wartość wskazującą, czy ten token ma tokeny podrzędne.
item

JToken

Reprezentuje abstrakcyjny token JSON.
last

JToken

Pobierz ostatni token podrzędny tego tokenu.
next

JToken

Pobiera następny token równorzędny tego węzła.
parent

string

Pobiera lub ustawia element nadrzędny.
path

string

Pobiera ścieżkę tokenu JSON.
previous

JToken

Pobiera poprzedni token równorzędny tego węzła.
root

JToken

Pobiera główny zestaw JToken tego zestawu JToken.
type

string

Pobiera typ węzła dla tego zestawu JToken.

ProjectReference

Nazwa Typ Opis
id

string

name

string

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa Typ Opis
links

object

Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu.

ServiceEndpoint

Reprezentuje punkt końcowy, który może być używany przez zadanie orkiestracji.

Nazwa Typ Opis
administratorsGroup

IdentityRef

Jest to przestarzałe pole.
authorization

EndpointAuthorization

Pobiera lub ustawia dane autoryzacji na potrzeby rozmowy z punktem końcowym.
createdBy

IdentityRef

Pobiera lub ustawia odwołanie do tożsamości użytkownika, który utworzył punkt końcowy usługi.
data

object

description

string

Pobiera lub ustawia opis punktu końcowego.
groupScopeId

string

Jest to przestarzałe pole.
id

string

Pobiera lub ustawia identyfikator tego punktu końcowego.
isReady

boolean

Wskaźnik stanu punktu końcowego
isShared

boolean

Wskazuje, czy punkt końcowy usługi jest współużytkowany z innymi projektami, czy nie.
name

string

Pobiera lub ustawia przyjazną nazwę punktu końcowego.
operationStatus

JObject

Komunikat o błędzie podczas tworzenia/usuwania punktu końcowego
owner

string

Właściciel obsługiwanych wartości punktu końcowego to "biblioteka", "agentcloud"
readersGroup

IdentityRef

Pobiera lub ustawia odwołanie do tożsamości dla grupy czytelników punktu końcowego usługi.
serviceEndpointProjectReferences

ServiceEndpointProjectReference[]

Wszystkie inne odwołania do projektu, w którym jest współużytkowany punkt końcowy usługi.
type

string

Pobiera lub ustawia typ punktu końcowego.
url

string

Pobiera lub ustawia adres URL punktu końcowego.

ServiceEndpointActionFilter

Parametr "actionFilter" umożliwia użytkownikom ocenę uprawnień osoby żądającej i pobranie listy punktów końcowych spełniających określone warunki, zapewniając, że zwracane są tylko odpowiednie punkty końcowe na podstawie ich uprawnień

Nazwa Typ Opis
manage

string

none

string

use

string

view

string

ServiceEndpointProjectReference

Nazwa Typ Opis
description

string

Pobiera lub ustawia opis punktu końcowego usługi.
name

string

Pobiera lub ustawia nazwę punktu końcowego usługi.
projectReference

ProjectReference

Pobiera lub ustawia odwołanie do projektu punktu końcowego usługi.