Endpoints - Update Service Endpoint

Reference

Service:: Service Endpoint

API Version:: 7.1-preview.4

Aktualizace koncového bodu služby

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 identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpointId	path	True	string uuid	ID koncového bodu, který se má aktualizovat
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.
operation	query		string	typ operace

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	Označ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áři 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.

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

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

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 vybraného autorizačního schématu.
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 obsahuje nula nebo více zajímavých odkazů o předmětu 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 napříč účty i organizacemi.
directoryAlias	string	Zastaralé – lze načíst dotazem uživatele Graphu, na který odkazuje položka "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é – lze načíst dotazem na stav členství graphu, na který odkazuje položka membershipState slovníku GraphUser "_links".
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ě 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

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 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	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 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 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	Označ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áři 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.

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 projektu koncového bodu služby.

Sdílet prostřednictvím