Endpoints - Create

Référence

Service:: Service Endpoint

Version d'API:: 7.1

Crée un point de terminaison de service

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1 » pour utiliser cette version de l’API.

Corps de la demande

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 communiquer 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 (uuid)	Il s’agit d’un champ déconseillé.
id	string (uuid)	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	Le propriétaire des valeurs prises en charge par le point de terminaison est « 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.

Réponses

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

Sécurité

oauth2

Type: oauth2
Flux: accessCode
URL d’autorisation: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton: 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

Étendues

Nom	Description
vso.serviceendpoint_manage	Accorde la possibilité de lire, d’interroger et de gérer les points de terminaison de service.

Exemples

Create Azure RM service endpoint

Create service endpoint

Create Azure RM service endpoint

Exemple de requête

HTTP

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

{
  "data": {
    "subscriptionId": "1272a66f-e2e8-4e88-ab43-487409186c3f",
    "subscriptionName": "subscriptionName",
    "environment": "AzureCloud",
    "scopeLevel": "Subscription",
    "creationMode": "Manual"
  },
  "name": "MyNewARMServiceEndpoint",
  "type": "AzureRM",
  "url": "https://management.azure.com/",
  "authorization": {
    "parameters": {
      "tenantid": "1272a66f-e2e8-4e88-ab43-487409186c3f",
      "serviceprincipalid": "1272a66f-e2e8-4e88-ab43-487409186c3f",
      "authenticationType": "spnKey",
      "serviceprincipalkey": "SomePassword"
    },
    "scheme": "ServicePrincipal"
  },
  "isShared": false,
  "isReady": true,
  "serviceEndpointProjectReferences": [
    {
      "projectReference": {
        "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
        "name": "TestProject"
      },
      "name": "MyNewARMServiceEndpoint"
    }
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "data": {
    "subscriptionId": "1272a66f-e2e8-4e88-ab43-487409186c3f",
    "subscriptionName": "subscriptionName",
    "environment": "AzureCloud",
    "scopeLevel": "Subscription",
    "creationMode": "Manual"
  },
  "id": "1dfdea68-9549-409e-abee-c5da69cfec5f",
  "name": "MyNewARMServiceEndpoint",
  "type": "AzureRM",
  "url": "https://management.azure.com/",
  "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": "anpuri@outlook-int.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll",
    "descriptor": "msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll"
  },
  "authorization": {
    "parameters": {
      "tenantid": "1272a66f-e2e8-4e88-ab43-487409186c3f",
      "serviceprincipalid": "1272a66f-e2e8-4e88-ab43-487409186c3f",
      "authenticationType": "spnKey",
      "serviceprincipalkey": null
    },
    "scheme": "ServicePrincipal"
  },
  "isShared": false,
  "isReady": true,
  "owner": "library",
  "serviceEndpointProjectReferences": [
    {
      "projectReference": {
        "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
        "name": "TestProject"
      },
      "name": "MyNewARMServiceEndpoint"
    }
  ]
}

Create service endpoint

Exemple de requête

HTTP

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

{
  "data": {},
  "name": "MyNewServiceEndpoint",
  "type": "Generic",
  "url": "https://myserver",
  "authorization": {
    "parameters": {
      "username": "myusername",
      "password": "mysecretpassword"
    },
    "scheme": "UsernamePassword"
  },
  "isShared": false,
  "isReady": true,
  "serviceEndpointProjectReferences": [
    {
      "projectReference": {
        "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
        "name": "TestProject"
      },
      "name": "MyNewServiceEndpoint"
    }
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "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": "4adb1680-0eac-6149-b5ee-fc8b4f6ca227",
    "uniqueName": "fabfiber@outlook.com",
    "imageUrl": "https://dev.azure.com/fabrikam/_apis/GraphProfile/MemberAvatars/msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll",
    "descriptor": "msa.ZTE4YTFmMGEtYjExMi03N2ZkLWE5ZTAtZTNiYjA4MWRhNDll"
  },
  "authorization": {
    "parameters": {
      "username": "myusername",
      "password": null
    },
    "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 à 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.
ServiceEndpointProjectReference

EndpointAuthorization

Object

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

Object

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 graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique sur 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 complet non unique de l’objet 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é : utiliser Domain+PrincipalName à la place
url	string	Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphe.

JObject

Object

Représente un objet JSON.

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

JToken

Object

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 (JContainer)	Obtient ou définit le parent.
path	string	Obtient le chemin d’accès 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 (JTokenType)	Obtient le type de nœud de ce JToken.

ProjectReference

Object

Nom	Type	Description
id	string (uuid)
name	string

ReferenceLinks

Object

Classe à 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

Object

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 communiquer 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 (uuid)	Il s’agit d’un champ déconseillé.
id	string (uuid)	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	Le propriétaire des valeurs prises en charge par le point de terminaison est « 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.

ServiceEndpointProjectReference

Object

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 la référence du projet du point de terminaison de service.

Partager via

Endpoints - Create

Paramètres URI

Corps de la demande

Réponses

Sécurité

oauth2

Étendues

Exemples

Create Azure RM service endpoint

Exemple de requête

Exemple de réponse

Create service endpoint

Exemple de requête

Exemple de réponse

Définitions

EndpointAuthorization

IdentityRef

JObject

JToken

ProjectReference

ReferenceLinks

ServiceEndpoint

ServiceEndpointProjectReference