Compartir a través de

Endpoints - Create

  • Referencia
Servicio:
Service Endpoint
Versión de la API:
7.1

Crea un nuevo punto de conexión de servicio.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
organization
 path True

string

Nombre de la organización de Azure DevOps.
api-version
 query True

string

Versión de la API que se va a usar. Debe establecerse en "7.1" para usar esta versión de la API.

Cuerpo de la solicitud

Nombre Tipo Description
administratorsGroup

IdentityRef

Se trata de un campo en desuso.
authorization

EndpointAuthorization

Obtiene o establece los datos de autorización para comunicarse con el punto de conexión.
createdBy

IdentityRef

Obtiene o establece la referencia de identidad para el usuario que creó el punto de conexión de servicio.
data

object

description

string

Obtiene o establece la descripción del punto de conexión.
groupScopeId

string (uuid)

Se trata de un campo en desuso.
id

string (uuid)

Obtiene o establece el identificador de este punto de conexión.
isReady

boolean

Indicador de estado de EndPoint
isShared

boolean

Indica si el punto de conexión de servicio se comparte con otros proyectos o no.
name

string

Obtiene o establece el nombre descriptivo del punto de conexión.
operationStatus

JObject

Mensaje de error durante la creación o eliminación del punto de conexión
owner

string

El propietario de los valores admitidos del punto de conexión son "library", "agentcloud"
readersGroup

IdentityRef

Obtiene o establece la referencia de identidad para el grupo de lectores del punto de conexión de servicio.
serviceEndpointProjectReferences

ServiceEndpointProjectReference[]

Todas las demás referencias de proyecto en las que se comparte el punto de conexión de servicio.
type

string

Obtiene o establece el tipo del punto de conexión.
url

string

Obtiene o establece la dirección URL del punto de conexión.

Respuestas

Nombre Tipo Description
200 OK

ServiceEndpoint

operación correcta

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del token: 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

Ámbitos

Nombre Description
vso.serviceendpoint_manage Concede la capacidad de leer, consultar y administrar puntos de conexión de servicio.

Ejemplos

Create Azure RM service endpoint
Create service endpoint

Create Azure RM service endpoint

Solicitud de ejemplo

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

Respuesta de muestra

status code:
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

Solicitud de ejemplo

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

Respuesta de muestra

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

Definiciones

Nombre Description
EndpointAuthorization

Representa la autorización usada para el punto de conexión de servicio.
IdentityRef
JObject

Representa un objeto JSON.
JToken

Representa un token JSON abstracto.
ProjectReference
ReferenceLinks

Clase que representa una colección de vínculos de referencia rest.
ServiceEndpoint

Representa un punto de conexión que puede usar un trabajo de orquestación.
ServiceEndpointProjectReference

EndpointAuthorization

Object

Representa la autorización usada para el punto de conexión de servicio.

Nombre Tipo Description
parameters

object

Obtiene o establece los parámetros del esquema de autorización seleccionado.
scheme

string

Obtiene o establece el esquema utilizado para la autenticación del punto de conexión de servicio.

IdentityRef

Object
Nombre Tipo Description
_links

ReferenceLinks

Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo.
descriptor

string

El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones.
directoryAlias

string

En desuso: se puede recuperar consultando al usuario de Graph al que se hace referencia en la entrada "self" del diccionario identityRef "_links".
displayName

string

Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen.
id

string

imageUrl

string

En desuso: disponible en la entrada "avatar" del diccionario "_links" identityRef
inactive

boolean

En desuso: se puede recuperar consultando el estado de pertenencia de Graph al que se hace referencia en la entrada "membershipState" del diccionario "_links" de GraphUser.
isAadIdentity

boolean

En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

En desuso: se puede deducir del tipo de sujeto del descriptor (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

En desuso: no en uso en la mayoría de las implementaciones preexistentes de ToIdentityRef
uniqueName

string

En desuso: use Domain+PrincipalName en su lugar.
url

string

Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

JObject

Object

Representa un objeto JSON.

Nombre Tipo Description
item

JToken

Representa un token JSON abstracto.
type

string (JTokenType)

Obtiene el tipo de nodo para este JToken.

JToken

Object

Representa un token JSON abstracto.

Nombre Tipo Description
first

JToken

Obtenga el primer token secundario de este token.
hasValues

boolean

Obtiene un valor que indica si este token tiene tokens secundarios.
item

JToken

Representa un token JSON abstracto.
last

JToken

Obtenga el último token secundario de este token.
next

JToken

Obtiene el siguiente token relacionado de este nodo.
parent

string (JContainer)

Obtiene o establece el elemento primario.
path

string

Obtiene la ruta de acceso del token JSON.
previous

JToken

Obtiene el token relacionado anterior de este nodo.
root

JToken

Obtiene el JToken raíz de este JToken.
type

string (JTokenType)

Obtiene el tipo de nodo para este JToken.

ProjectReference

Object
Nombre Tipo Description
id

string (uuid)

name

string

Object

Clase que representa una colección de vínculos de referencia rest.

Nombre Tipo Description
links

object

Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

ServiceEndpoint

Object

Representa un punto de conexión que puede usar un trabajo de orquestación.

Nombre Tipo Description
administratorsGroup

IdentityRef

Se trata de un campo en desuso.
authorization

EndpointAuthorization

Obtiene o establece los datos de autorización para comunicarse con el punto de conexión.
createdBy

IdentityRef

Obtiene o establece la referencia de identidad para el usuario que creó el punto de conexión de servicio.
data

object

description

string

Obtiene o establece la descripción del punto de conexión.
groupScopeId

string (uuid)

Se trata de un campo en desuso.
id

string (uuid)

Obtiene o establece el identificador de este punto de conexión.
isReady

boolean

Indicador de estado de EndPoint
isShared

boolean

Indica si el punto de conexión de servicio se comparte con otros proyectos o no.
name

string

Obtiene o establece el nombre descriptivo del punto de conexión.
operationStatus

JObject

Mensaje de error durante la creación o eliminación del punto de conexión
owner

string

El propietario de los valores admitidos del punto de conexión son "library", "agentcloud"
readersGroup

IdentityRef

Obtiene o establece la referencia de identidad para el grupo de lectores del punto de conexión de servicio.
serviceEndpointProjectReferences

ServiceEndpointProjectReference[]

Todas las demás referencias de proyecto en las que se comparte el punto de conexión de servicio.
type

string

Obtiene o establece el tipo del punto de conexión.
url

string

Obtiene o establece la dirección URL del punto de conexión.

ServiceEndpointProjectReference

Object
Nombre Tipo Description
description

string

Obtiene o establece la descripción del punto de conexión de servicio.
name

string

Obtiene o establece el nombre del punto de conexión de servicio.
projectReference

ProjectReference

Obtiene o establece la referencia del proyecto del punto de conexión de servicio.