Endpoints - Get Service Endpoints

Référence

Service:: Service Endpoint

API Version:: 7.1-preview.4

Obtenez les points de terminaison de service.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
project	path	True	string	ID de projet ou nom du projet
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.4 » pour utiliser cette version de l’API.
actionFilter	query		ServiceEndpointActionFilter	Le paramètre « actionFilter » permet aux utilisateurs d’évaluer les autorisations du demandeur et de récupérer une liste de points de terminaison qui correspondent aux conditions spécifiées, en veillant à ce que seuls les points de terminaison pertinents soient retournés en fonction de leurs autorisations
authSchemes	query		string array (string)	Schémas d’autorisation utilisés pour les points de terminaison de service.
endpointIds	query		string array (uuid)	ID des points de terminaison de service.
includeDetails	query		boolean	Indicateur pour inclure plus de détails pour les points de terminaison de service. Il s’agit d’un usage interne uniquement et l’indicateur sera traité comme false pour toutes les autres demandes
includeFailed	query		boolean	Indicateur Échec pour les points de terminaison de service.
owner	query		string	Propriétaire des points de terminaison de service.
type	query		string	Type des points de terminaison de service.

Réponses

Nom	Type	Description
200 OK	ServiceEndpoint[]	opération réussie

Sécurité

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

Nom	Description
vso.serviceendpoint	Octroie la possibilité de lire les points de terminaison de service.

Exemples

Get service endpoints

Sample Request

HTTP

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

Définitions

Nom	Description
EndpointAuthorization	Représente l’autorisation utilisée pour le point de terminaison de service.
IdentityRef
JObject	Représente un objet JSON.
JToken	Représente un jeton JSON abstrait.
ProjectReference
ReferenceLinks	Classe pour représenter une collection de liens de référence REST.
ServiceEndpoint	Représente un point de terminaison qui peut être utilisé par un travail d’orchestration.
ServiceEndpointActionFilter	Le paramètre « actionFilter » permet aux utilisateurs d’évaluer les autorisations du demandeur et de récupérer une liste de points de terminaison qui correspondent aux conditions spécifiées, en veillant à ce que seuls les points de terminaison pertinents soient retournés en fonction de leurs autorisations
ServiceEndpointProjectReference

EndpointAuthorization

Représente l’autorisation utilisée pour le point de terminaison de service.

Nom	Type	Description
parameters	object	Obtient ou définit les paramètres du schéma d’autorisation sélectionné.
scheme	string	Obtient ou définit le schéma utilisé pour l’authentification du point de terminaison de service.

IdentityRef

Nom	Type	Description
_links	ReferenceLinks	Ce champ contient zéro ou plus de liens intéressants sur le sujet du graphe. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique.
descriptor	string	Le descripteur est le principal moyen de référencer l’objet du graphe pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphe pour les comptes et les organisations.
directoryAlias	string	Déconseillé : peut être récupéré en interrogeant l’utilisateur Graph référencé dans l’entrée « auto » du dictionnaire IdentityRef « _links »
displayName	string	Il s’agit du nom d’affichage non unique du sujet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.
id	string
imageUrl	string	Déconseillé : disponible dans l’entrée « avatar » du dictionnaire IdentityRef « _links »
inactive	boolean	Déconseillé : peut être récupéré en interrogeant l’état d’appartenance Graph référencé dans l’entrée « membershipState » du dictionnaire GraphUser « _links »
isAadIdentity	boolean	Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Déconseillé : peut être déduit du type d’objet du descripteur (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Déconseillé : non utilisé dans la plupart des implémentations préexistantes de ToIdentityRef
uniqueName	string	Déconseillé : utilisez Domain+PrincipalName à la place
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

JObject

Représente un objet JSON.

Nom	Type	Description
item	JToken	Représente un jeton JSON abstrait.
type	string	Obtient le type de nœud pour ce JToken.

JToken

Représente un jeton JSON abstrait.

Nom	Type	Description
first	JToken	Obtenez le premier jeton enfant de ce jeton.
hasValues	boolean	Obtient une valeur indiquant si ce jeton a des jetons enfants.
item	JToken	Représente un jeton JSON abstrait.
last	JToken	Obtenez le dernier jeton enfant de ce jeton.
next	JToken	Obtient le jeton frère suivant de ce nœud.
parent	string	Obtient ou définit le parent.
path	string	Obtient le chemin du jeton JSON.
previous	JToken	Obtient le jeton frère précédent de ce nœud.
root	JToken	Obtient le JToken racine de ce JToken.
type	string	Obtient le type de nœud pour ce JToken.

ProjectReference

Nom	Type	Description
id	string
name	string

ReferenceLinks

Classe pour représenter une collection de liens de référence REST.

Nom	Type	Description
links	object	Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

ServiceEndpoint

Représente un point de terminaison qui peut être utilisé par un travail d’orchestration.

Nom	Type	Description
administratorsGroup	IdentityRef	Il s’agit d’un champ déconseillé.
authorization	EndpointAuthorization	Obtient ou définit les données d’autorisation pour la conversation avec le point de terminaison.
createdBy	IdentityRef	Obtient ou définit la référence d’identité pour l’utilisateur qui a créé le point de terminaison de service.
data	object
description	string	Obtient ou définit la description du point de terminaison.
groupScopeId	string	Il s’agit d’un champ déconseillé.
id	string	Obtient ou définit l’identificateur de ce point de terminaison.
isReady	boolean	Indicateur d’état EndPoint
isShared	boolean	Indique si le point de terminaison de service est partagé avec d’autres projets ou non.
name	string	Obtient ou définit le nom convivial du point de terminaison.
operationStatus	JObject	Message d’erreur lors de la création/suppression du point de terminaison
owner	string	Propriétaire du point de terminaison Les valeurs prises en charge sont « library », « agentcloud »
readersGroup	IdentityRef	Obtient ou définit la référence d’identité pour le groupe de lecteurs du point de terminaison de service.
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	Toutes les autres références de projet où le point de terminaison de service est partagé.
type	string	Obtient ou définit le type du point de terminaison.
url	string	Obtient ou définit l’URL du point de terminaison.

ServiceEndpointActionFilter

Le paramètre « actionFilter » permet aux utilisateurs d’évaluer les autorisations du demandeur et de récupérer une liste de points de terminaison qui correspondent aux conditions spécifiées, en veillant à ce que seuls les points de terminaison pertinents soient retournés en fonction de leurs autorisations

Nom	Type	Description
manage	string
none	string
use	string
view	string

ServiceEndpointProjectReference

Nom	Type	Description
description	string	Obtient ou définit la description du point de terminaison de service.
name	string	Obtient ou définit le nom du point de terminaison de service.
projectReference	ProjectReference	Obtient ou définit les références de projet du point de terminaison de service.

Partager via