Endpoints - Update Service Endpoint

Odwołanie

Service:: Service Endpoint

API Version:: 7.1-preview.4

Aktualizowanie punktu końcowego usługi

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

With optional parameters:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpointId	path	True	string uuid	Identyfikator punktu końcowego do zaktualizowania
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
api-version	query	True	string	Wersja interfejsu API do użycia. Ta wartość powinna mieć wartość "7.1-preview.4", aby używać tej wersji interfejsu API.
operation	query		string	typ operacji

Treść żądania

Nazwa	Typ	Opis
administratorsGroup	IdentityRef	Jest to przestarzałe pole.
authorization	EndpointAuthorization	Pobiera lub ustawia dane autoryzacji do 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 punkt końcowy usługi jest współużytkowany.
type	string	Pobiera lub ustawia typ punktu końcowego.
url	string	Pobiera lub ustawia adres URL punktu końcowego.

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_manage	Umożliwia odczytywanie punktów końcowych usługi, wykonywanie zapytań i zarządzanie nimi.

Przykłady

Update service endpoint

Sample Request

HTTP

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

{
  "data": {},
  "id": "5e47a0d8-c745-44f8-8f93-784f18ff31c4",
  "name": "UpdatedServiceEndpoint",
  "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": "myupdatedusername",
      "password": "myupdatedpassword"
    },
    "scheme": "UsernamePassword"
  },
  "isShared": false,
  "isReady": true,
  "owner": "Library",
  "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": "UpdatedServiceEndpoint",
  "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": "myupdatedusername",
      "password": null
    },
    "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 aranżacji.
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ływanie 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 je pobrać, wykonując zapytanie względem użytkownika programu Graph, do których odwołuje się wpis "self" słownika IdentityRef "_links"
displayName	string	Jest to nieu unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, należy zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string	Przestarzałe — dostępne we wpisie "avatar" słownika IdentityRef "_links"
inactive	boolean	Przestarzałe — można pobrać, wykonując zapytanie dotyczące 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 elementu 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 tokenu 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 token JToken tego tokenu JToken.
type	string	Pobiera typ węzła dla tego tokenu JToken.

ProjectReference

Nazwa	Typ	Opis
id	string
name	string

ReferenceLinks

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

Nazwa	Typ	Opis
links	object	Widok linków w trybie tylko do odczytu. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

ServiceEndpoint

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

Nazwa	Typ	Opis
administratorsGroup	IdentityRef	Jest to przestarzałe pole.
authorization	EndpointAuthorization	Pobiera lub ustawia dane autoryzacji do 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 punkt końcowy usługi jest współużytkowany.
type	string	Pobiera lub ustawia typ punktu końcowego.
url	string	Pobiera lub ustawia adres URL punktu końcowego.

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.

Udostępnij za pośrednictwem