Endpoints - Update Service Endpoint

Referenz

Dienst:: Service Endpoint

API-Version:: 7.1

Aktualisieren des Dienstendpunkts

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpointId	path	True	string (uuid)	Endpunkt-ID des zu aktualisierenden Endpunkts
organization	path	True	string	Der Name der Azure DevOps-Organisation.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden.
operation	query		string	Vorgangstyp

Anforderungstext

Name	Typ	Beschreibung
administratorsGroup	IdentityRef	Dies ist ein veraltetes Feld.
authorization	EndpointAuthorization	Ruft die Autorisierungsdaten für die Kommunikation mit dem Endpunkt ab oder legt sie fest.
createdBy	IdentityRef	Ruft den Identitätsverweis für den Benutzer ab, der den Dienstendpunkt erstellt hat, oder legt den Identitätsverweis fest.
data	object
description	string	Ruft die Beschreibung des Endpunkts ab oder legt sie fest.
groupScopeId	string (uuid)	Dies ist ein veraltetes Feld.
id	string (uuid)	Dient zum Abrufen oder Festlegen des Bezeichners dieses Endpunkts.
isReady	boolean	EndPoint-Statusindikator
isShared	boolean	Gibt an, ob der Dienstendpunkt für andere Projekte freigegeben wird oder nicht.
name	string	Dient zum Abrufen oder Festlegen des Anzeigenamens des Endpunkts.
operationStatus	JObject	Fehlermeldung beim Erstellen/Löschen des Endpunkts
owner	string	Besitzer des Endpunkts Unterstützte Werte sind "library", "agentcloud"
readersGroup	IdentityRef	Dient zum Abrufen oder Festlegen der Identitätsreferenz für die Lesergruppe des Dienstendpunkts.
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	Alle anderen Projektverweise, in denen der Dienstendpunkt gemeinsam genutzt wird.
type	string	Dient zum Abrufen oder Festlegen des Typs des Endpunkts.
url	string	Ruft die URL des Endpunkts ab oder legt sie fest.

Antworten

Name	Typ	Beschreibung
200 OK	ServiceEndpoint	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name	Beschreibung
vso.serviceendpoint_manage	Gewährt die Möglichkeit zum Lesen, Abfragen und Verwalten von Dienstendpunkten.

Beispiele

Update service endpoint

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

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

Definitionen

Name	Beschreibung
EndpointAuthorization	Stellt die Autorisierung dar, die für den Dienstendpunkt verwendet wird.
IdentityRef
JObject	Stellt ein JSON-Objekt dar.
JToken	Stellt ein abstraktes JSON-Token dar.
ProjectReference
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.
ServiceEndpoint	Stellt einen Endpunkt dar, der von einem Orchestrierungsauftrag verwendet werden kann.
ServiceEndpointProjectReference

EndpointAuthorization

Objekt

Stellt die Autorisierung dar, die für den Dienstendpunkt verwendet wird.

Name	Typ	Beschreibung
parameters	object	Ruft die Parameter für das ausgewählte Autorisierungsschema ab oder legt diese fest.
scheme	string	Ruft das Schema ab, das für die Dienstendpunktauthentifizierung verwendet wird, oder legt es fest.

IdentityRef

Objekt

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Thema Diagramm. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Diagrammbetreff zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Diagrammbetreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird dasselbe Diagrammthema sowohl in Firmen als auch in Organisationen eindeutig identifiziert.
directoryAlias	string	Veraltet – Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im "Self"-Eintrag des IdentityRef -Wörterbuchs "_links" verwiesen wird
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammbetreffs. Um dieses Feld zu ändern, müssen Sie den Wert im Quellanbieter ändern.
id	string
imageUrl	string	Veraltet – Verfügbar im "Avatar"-Eintrag des IdentityRef-Wörterbuchs "_links"
inactive	boolean	Veraltet – Kann abgerufen werden, indem der Graph-Mitgliedschaftsstatus abgefragt wird, auf den im Eintrag "membershipState" des GraphUser-Wörterbuchs "_links" verwiesen wird.
isAadIdentity	boolean	Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Veraltet – Kann vom Betrefftyp des Deskriptors abgeleitet werden (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Veraltet – nicht in den meisten bereits vorhandenen Implementierungen von ToIdentityRef verwendet
uniqueName	string	Veraltet – Verwenden Sie stattdessen "Domain+PrincipalName".
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

JObject

Objekt

Stellt ein JSON-Objekt dar.

Name	Typ	Beschreibung
item	JToken	Stellt ein abstraktes JSON-Token dar.
type	string (JTokenType)	Ruft den Knotentyp für dieses JToken ab.

JToken

Objekt

Stellt ein abstraktes JSON-Token dar.

Name	Typ	Beschreibung
first	JToken	Rufen Sie das erste untergeordnete Token dieses Tokens ab.
hasValues	boolean	Ruft einen Wert ab, der angibt, ob dieses Token über untergeordnete Token verfügt.
item	JToken	Stellt ein abstraktes JSON-Token dar.
last	JToken	Rufen Sie das letzte untergeordnete Token dieses Tokens ab.
next	JToken	Ruft das nächste gleichgeordnete Token dieses Knotens ab.
parent	string (JContainer)	Dient zum Abrufen oder Festlegen des übergeordneten Elements.
path	string	Ruft den Pfad des JSON-Tokens ab.
previous	JToken	Ruft das vorherige gleichgeordnete Token dieses Knotens ab.
root	JToken	Ruft das Stamm-JToken dieses JToken ab.
type	string (JTokenType)	Ruft den Knotentyp für dieses JToken ab.

ProjectReference

Objekt

Name	Typ	Beschreibung
id	string (uuid)
name	string

ReferenceLinks

Objekt

Die Klasse, die eine Auflistung von REST-Referenzverknüpfungslinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Referenzlinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

ServiceEndpoint

Objekt

Stellt einen Endpunkt dar, der von einem Orchestrierungsauftrag verwendet werden kann.

Name	Typ	Beschreibung
administratorsGroup	IdentityRef	Dies ist ein veraltetes Feld.
authorization	EndpointAuthorization	Ruft die Autorisierungsdaten für die Kommunikation mit dem Endpunkt ab oder legt sie fest.
createdBy	IdentityRef	Ruft den Identitätsverweis für den Benutzer ab, der den Dienstendpunkt erstellt hat, oder legt den Identitätsverweis fest.
data	object
description	string	Ruft die Beschreibung des Endpunkts ab oder legt sie fest.
groupScopeId	string (uuid)	Dies ist ein veraltetes Feld.
id	string (uuid)	Dient zum Abrufen oder Festlegen des Bezeichners dieses Endpunkts.
isReady	boolean	EndPoint-Statusindikator
isShared	boolean	Gibt an, ob der Dienstendpunkt für andere Projekte freigegeben wird oder nicht.
name	string	Dient zum Abrufen oder Festlegen des Anzeigenamens des Endpunkts.
operationStatus	JObject	Fehlermeldung beim Erstellen/Löschen des Endpunkts
owner	string	Besitzer des Endpunkts Unterstützte Werte sind "library", "agentcloud"
readersGroup	IdentityRef	Dient zum Abrufen oder Festlegen der Identitätsreferenz für die Lesergruppe des Dienstendpunkts.
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	Alle anderen Projektverweise, in denen der Dienstendpunkt gemeinsam genutzt wird.
type	string	Dient zum Abrufen oder Festlegen des Typs des Endpunkts.
url	string	Ruft die URL des Endpunkts ab oder legt sie fest.

ServiceEndpointProjectReference

Objekt

Name	Typ	Beschreibung
description	string	Ruft die Beschreibung des Dienstendpunkts ab oder legt diese fest.
name	string	Ruft den Namen des Dienstendpunkts ab oder legt den Namen fest.
projectReference	ProjectReference	Ruft den Projektverweis des Dienstendpunkts ab oder legt sie fest.

Freigeben über

Endpoints - Update Service Endpoint

URI-Parameter

Anforderungstext

Antworten

Sicherheit

oauth2

Bereiche

Beispiele

Update service endpoint

Beispielanforderung

Beispiel für eine Antwort

Definitionen

EndpointAuthorization

IdentityRef

JObject

JToken

ProjectReference

ReferenceLinks

ServiceEndpoint

ServiceEndpointProjectReference