Condividi tramite

Endpoints - Create

  • Riferimento
Servizio:
Service Endpoint
Versione API:
7.1

Crea un nuovo endpoint di servizio

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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
organization
 path True

string

Nome dell'organizzazione di Azure DevOps.
api-version
 query True

string

Versione dell'API da usare. Deve essere impostato su '7.1' per usare questa versione dell'API.

Corpo della richiesta

Nome Tipo Descrizione
administratorsGroup

IdentityRef

Si tratta di un campo deprecato.
authorization

EndpointAuthorization

Ottiene o imposta i dati di autorizzazione per comunicare con l'endpoint.
createdBy

IdentityRef

Ottiene o imposta il riferimento all'identità per l'utente che ha creato l'endpoint del servizio.
data

object

description

string

Ottiene o imposta la descrizione dell'endpoint.
groupScopeId

string (uuid)

Si tratta di un campo deprecato.
id

string (uuid)

Ottiene o imposta l'identificatore dell'endpoint.
isReady

boolean

Indicatore di stato endpoint
isShared

boolean

Indica se l'endpoint di servizio è condiviso con altri progetti o meno.
name

string

Ottiene o imposta il nome descrittivo dell'endpoint.
operationStatus

JObject

Messaggio di errore durante la creazione/eliminazione dell'endpoint
owner

string

Il proprietario dei valori supportati dell'endpoint è "library", "agentcloud"
readersGroup

IdentityRef

Ottiene o imposta il riferimento all'identità per il gruppo di lettori dell'endpoint del servizio.
serviceEndpointProjectReferences

ServiceEndpointProjectReference[]

Tutti gli altri riferimenti al progetto in cui è condiviso l'endpoint del servizio.
type

string

Ottiene o imposta il tipo dell'endpoint.
url

string

Ottiene o imposta l'URL dell'endpoint.

Risposte

Nome Tipo Descrizione
200 OK

ServiceEndpoint

operazione riuscita

Sicurezza

oauth2

Tipo: oauth2
Flow: accessCode
URL di autorizzazione: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL 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

Ambiti

Nome Descrizione
vso.serviceendpoint_manage Concede la possibilità di leggere, eseguire query e gestire gli endpoint di servizio.

Esempio

Create Azure RM service endpoint
Create service endpoint

Create Azure RM service endpoint

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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

Esempio di richiesta

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

Risposta di esempio

Codice di stato:
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"
    }
  ]
}

Definizioni

Nome Descrizione
EndpointAuthorization

Rappresenta l'autorizzazione utilizzata per l'endpoint di servizio.
IdentityRef
JObject

Rappresenta un oggetto JSON.
JToken

Rappresenta un token JSON astratto.
ProjectReference
ReferenceLinks

Classe per rappresentare una raccolta di collegamenti di riferimento REST.
ServiceEndpoint

Rappresenta un endpoint che può essere utilizzato da un processo di orchestrazione.
ServiceEndpointProjectReference

EndpointAuthorization

Object

Rappresenta l'autorizzazione utilizzata per l'endpoint di servizio.

Nome Tipo Descrizione
parameters

object

Ottiene o imposta i parametri per lo schema di autorizzazione selezionato.
scheme

string

Ottiene o imposta lo schema utilizzato per l'autenticazione dell'endpoint di servizio.

IdentityRef

Object
Nome Tipo Descrizione
_links

ReferenceLinks

Questo campo contiene zero o più collegamenti interessanti sull'oggetto grafico. Questi collegamenti possono essere richiamati per ottenere relazioni aggiuntive o informazioni più dettagliate sull'oggetto grafico.
descriptor

string

Il descrittore è il modo principale per fare riferimento all'oggetto del grafo mentre il sistema è in esecuzione. Questo campo identificherà in modo univoco lo stesso soggetto del grafico in account e organizzazioni.
directoryAlias

string

Deprecato: può essere recuperato eseguendo una query sull'utente graph a cui si fa riferimento nella voce "self" del dizionario IdentityRef "_links"
displayName

string

Si tratta del nome visualizzato non univoco dell'oggetto del grafico. Per modificare questo campo, è necessario modificarne il valore nel provider di origine.
id

string

imageUrl

string

Deprecato : disponibile nella voce "avatar" del dizionario IdentityRef "_links"
inactive

boolean

Deprecato: può essere recuperato eseguendo una query sullo stato di appartenenza graph a cui si fa riferimento nella voce "membershipState" del dizionario "_links" GraphUser
isAadIdentity

boolean

Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer

boolean

Deprecato: può essere dedotto dal tipo di soggetto del descrittore (Descriptor.IsGroupType)
isDeletedInOrigin

boolean

profileUrl

string

Deprecato: non in uso nella maggior parte delle implementazioni preesistenti di ToIdentityRef
uniqueName

string

Deprecato: usare invece Domain+PrincipalName
url

string

Questo URL è la route completa alla risorsa di origine di questo oggetto grafico.

JObject

Object

Rappresenta un oggetto JSON.

Nome Tipo Descrizione
item

JToken

Rappresenta un token JSON astratto.
type

string (JTokenType)

Ottiene il tipo di nodo per questo JToken.

JToken

Object

Rappresenta un token JSON astratto.

Nome Tipo Descrizione
first

JToken

Ottenere il primo token figlio di questo token.
hasValues

boolean

Ottiene un valore che indica se il token dispone di token figlio.
item

JToken

Rappresenta un token JSON astratto.
last

JToken

Ottenere l'ultimo token figlio di questo token.
next

JToken

Ottiene il token di pari livello successivo di questo nodo.
parent

string (JContainer)

Ottiene o imposta l'elemento padre.
path

string

Ottiene il percorso del token JSON.
previous

JToken

Ottiene il token di pari livello precedente di questo nodo.
root

JToken

Ottiene il JToken radice di questo JToken.
type

string (JTokenType)

Ottiene il tipo di nodo per questo JToken.

ProjectReference

Object
Nome Tipo Descrizione
id

string (uuid)

name

string

Object

Classe per rappresentare una raccolta di collegamenti di riferimento REST.

Nome Tipo Descrizione
links

object

Visualizzazione di sola lettura dei collegamenti. Poiché i collegamenti di riferimento sono di sola lettura, è consigliabile esporli solo come di sola lettura.

ServiceEndpoint

Object

Rappresenta un endpoint che può essere utilizzato da un processo di orchestrazione.

Nome Tipo Descrizione
administratorsGroup

IdentityRef

Si tratta di un campo deprecato.
authorization

EndpointAuthorization

Ottiene o imposta i dati di autorizzazione per comunicare con l'endpoint.
createdBy

IdentityRef

Ottiene o imposta il riferimento all'identità per l'utente che ha creato l'endpoint del servizio.
data

object

description

string

Ottiene o imposta la descrizione dell'endpoint.
groupScopeId

string (uuid)

Si tratta di un campo deprecato.
id

string (uuid)

Ottiene o imposta l'identificatore dell'endpoint.
isReady

boolean

Indicatore di stato endpoint
isShared

boolean

Indica se l'endpoint di servizio è condiviso con altri progetti o meno.
name

string

Ottiene o imposta il nome descrittivo dell'endpoint.
operationStatus

JObject

Messaggio di errore durante la creazione/eliminazione dell'endpoint
owner

string

Il proprietario dei valori supportati dell'endpoint è "library", "agentcloud"
readersGroup

IdentityRef

Ottiene o imposta il riferimento all'identità per il gruppo di lettori dell'endpoint del servizio.
serviceEndpointProjectReferences

ServiceEndpointProjectReference[]

Tutti gli altri riferimenti al progetto in cui è condiviso l'endpoint del servizio.
type

string

Ottiene o imposta il tipo dell'endpoint.
url

string

Ottiene o imposta l'URL dell'endpoint.

ServiceEndpointProjectReference

Object
Nome Tipo Descrizione
description

string

Ottiene o imposta la descrizione dell'endpoint del servizio.
name

string

Ottiene o imposta il nome dell'endpoint del servizio.
projectReference

ProjectReference

Ottiene o imposta il riferimento al progetto dell'endpoint del servizio.