Freigeben über

Endpoints - Update Service Endpoint

  • Referenz
Service:
Service Endpoint
API Version:
7.1-preview.4

Aktualisieren des Dienstendpunkts

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

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-preview.4" 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 diese 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

Dies ist ein veraltetes Feld.
id

string

Ruft den Bezeichner dieses Endpunkts ab oder legt diesen fest.
isReady

boolean

EndPoint-Statusindikator
isShared

boolean

Gibt an, ob der Dienstendpunkt für andere Projekte freigegeben wird.
name

string

Ruft den Anzeigenamen des Endpunkts ab oder legt den Anzeigenamen fest.
operationStatus

JObject

Fehlermeldung beim Erstellen/Löschen des Endpunkts
owner

string

Besitzer des Endpunkts Unterstützte Werte sind "library", "agentcloud"
readersGroup

IdentityRef

Ruft den Identitätsverweis für die Lesergruppe des Dienstendpunkts ab oder legt diese fest.
serviceEndpointProjectReferences

ServiceEndpointProjectReference[]

Alle anderen Projektverweise, bei denen der Dienstendpunkt gemeinsam verwendet wird.
type

string

Ruft den Typ des Endpunkts ab oder legt ihn fest.
url

string

Ruft die URL des Endpunkts ab oder legt sie fest.

Antworten

Name Typ Beschreibung
200 OK

ServiceEndpoint

Erfolgreicher Vorgang

Sicherheit

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 Beschreibung
vso.serviceendpoint_manage Ermöglicht das Lesen, Abfragen und Verwalten von Dienstendpunkten.

Beispiele

Update service endpoint

Sample Request

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

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-Verweislinks darstellt.
ServiceEndpoint

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

EndpointAuthorization

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 sie fest.
scheme

string

Ruft das für die Dienstendpunktauthentifizierung verwendete Schema ab oder legt es fest.

IdentityRef

Name Typ Beschreibung
_links

ReferenceLinks

Dieses Feld enthält null oder interessantere Links zum Graphthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graphthema zu erhalten.
descriptor

string

Der Deskriptor ist die primäre Methode, um auf den Graph-Betreff zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
directoryAlias

string

Veraltet: Kann abgerufen werden, indem der Graph-Benutzer abgefragt wird, auf den im Eintrag "self" des IdentityRef-Wörterbuchs "_links" verwiesen wird.
displayName

string

Dies ist der nicht eindeutige Anzeigename des Graph-Betreffs. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
id

string

imageUrl

string

Veraltet: Im Eintrag "avatar" des IdentityRef-Wörterbuchs "_links" verfügbar
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– wird in den meisten vorhandenen Implementierungen von ToIdentityRef nicht verwendet.
uniqueName

string

Veraltet: Verwenden Sie stattdessen Domain+PrincipalName.
url

string

Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

JObject

Stellt ein JSON-Objekt dar.

Name Typ Beschreibung
item

JToken

Stellt ein abstraktes JSON-Token dar.
type

string

Ruft den Knotentyp für dieses JToken ab.

JToken

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

Ruft das übergeordnete Element ab oder legt es fest.
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 JTokens ab.
type

string

Ruft den Knotentyp für dieses JToken ab.

ProjectReference

Name Typ Beschreibung
id

string

name

string

Die -Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name Typ Beschreibung
links

object

Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützter Sind, möchten wir sie nur als schreibgeschützter Link verfügbar machen.

ServiceEndpoint

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

Dies ist ein veraltetes Feld.
id

string

Ruft den Bezeichner dieses Endpunkts ab oder legt diesen fest.
isReady

boolean

EndPoint-Statusindikator
isShared

boolean

Gibt an, ob der Dienstendpunkt für andere Projekte freigegeben wird.
name

string

Ruft den Anzeigenamen des Endpunkts ab oder legt den Anzeigenamen fest.
operationStatus

JObject

Fehlermeldung beim Erstellen/Löschen des Endpunkts
owner

string

Besitzer des Endpunkts Unterstützte Werte sind "library", "agentcloud"
readersGroup

IdentityRef

Ruft den Identitätsverweis für die Lesergruppe des Dienstendpunkts ab oder legt diese fest.
serviceEndpointProjectReferences

ServiceEndpointProjectReference[]

Alle anderen Projektverweise, bei denen der Dienstendpunkt gemeinsam verwendet wird.
type

string

Ruft den Typ des Endpunkts ab oder legt ihn fest.
url

string

Ruft die URL des Endpunkts ab oder legt sie fest.

ServiceEndpointProjectReference

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 diese fest.