Endpoints - Create

Odwołanie

Usługa:: Service Endpoint

Wersja interfejsu API:: 7.1

Tworzy nowy punkt końcowy usługi

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
api-version	query	True	string	Wersja interfejsu API do użycia. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
administratorsGroup	IdentityRef	Jest to przestarzałe pole.
authorization	EndpointAuthorization	Pobiera lub ustawia dane autoryzacji do rozmowy z punktem końcowym.
createdBy	IdentityRef	Pobiera lub ustawia odwołanie do tożsamości użytkownika, który utworzył punkt końcowy usługi.
data	object
description	string	Pobiera lub ustawia opis punktu końcowego.
groupScopeId	string (uuid)	Jest to przestarzałe pole.
id	string (uuid)	Pobiera lub ustawia identyfikator tego punktu końcowego.
isReady	boolean	Wskaźnik stanu punktu końcowego
isShared	boolean	Wskazuje, czy punkt końcowy usługi jest udostępniany innym projektom, czy nie.
name	string	Pobiera lub ustawia przyjazną nazwę punktu końcowego.
operationStatus	JObject	Komunikat o błędzie podczas tworzenia/usuwania punktu końcowego
owner	string	Właścicielem obsługiwanych wartości punktu końcowego są "biblioteka", "agentcloud"
readersGroup	IdentityRef	Pobiera lub ustawia odwołanie tożsamości dla grupy czytelników punktu końcowego usługi.
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	Wszystkie inne odwołania do projektu, w którym jest udostępniany punkt końcowy usługi.
type	string	Pobiera lub ustawia typ punktu końcowego.
url	string	Pobiera lub ustawia adres URL punktu końcowego.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	ServiceEndpoint	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa	Opis
vso.serviceendpoint_manage	Umożliwia odczytywanie punktów końcowych usługi, wykonywanie zapytań i zarządzanie nimi.

Przykłady

Create Azure RM service endpoint

Create service endpoint

Create Azure RM service endpoint

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  ]
}

Definicje

Nazwa	Opis
EndpointAuthorization	Reprezentuje autoryzację używaną dla punktu końcowego usługi.
IdentityRef
JObject	Reprezentuje obiekt JSON.
JToken	Reprezentuje abstrakcyjny token JSON.
ProjectReference
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
ServiceEndpoint	Reprezentuje punkt końcowy, który może być używany przez zadanie aranżacji.
ServiceEndpointProjectReference

EndpointAuthorization

Objekt

Reprezentuje autoryzację używaną dla punktu końcowego usługi.

Nazwa	Typ	Opis
parameters	object	Pobiera lub ustawia parametry dla wybranego schematu autoryzacji.
scheme	string	Pobiera lub ustawia schemat używany do uwierzytelniania punktu końcowego usługi.

IdentityRef

Objekt

Nazwa	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor	string	Deskryptor jest podstawowym sposobem odwołowania się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias	string	Przestarzałe — można go pobrać, wykonując zapytanie względem użytkownika programu Graph, do których odwołuje się wpis "self" słownika IdentityRef "_links"
displayName	string	Jest to unikatowa nazwa wyświetlana podmiotu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
id	string
imageUrl	string	Przestarzałe — dostępne we wpisie "avatar" słownika IdentityRef "_links"
inactive	boolean	Przestarzałe — można pobrać, wykonując zapytanie dotyczące stanu członkostwa programu Graph, do których odwołuje się wpis "membershipState" słownika GraphUser "_links"
isAadIdentity	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Przestarzałe — można wywnioskować z typu podmiotu deskryptora (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Przestarzałe — nie jest używane w większości istniejących implementacji elementu ToIdentityRef
uniqueName	string	Przestarzałe — zamiast tego użyj nazwy głównej i domeny
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

JObject

Objekt

Reprezentuje obiekt JSON.

Nazwa	Typ	Opis
item	JToken	Reprezentuje abstrakcyjny token JSON.
type	string (JTokenType)	Pobiera typ węzła dla tego tokenu JToken.

JToken

Objekt

Reprezentuje abstrakcyjny token JSON.

Nazwa	Typ	Opis
first	JToken	Pobierz pierwszy podrzędny token tego tokenu.
hasValues	boolean	Pobiera wartość wskazującą, czy ten token ma tokeny podrzędne.
item	JToken	Reprezentuje abstrakcyjny token JSON.
last	JToken	Pobierz ostatni podrzędny token tego tokenu.
next	JToken	Pobiera następny token równorzędny tego węzła.
parent	string (JContainer)	Pobiera lub ustawia element nadrzędny.
path	string	Pobiera ścieżkę tokenu JSON.
previous	JToken	Pobiera poprzedni token równorzędny tego węzła.
root	JToken	Pobiera główny element JToken tego tokenu JToken.
type	string (JTokenType)	Pobiera typ węzła dla tego tokenu JToken.

ProjectReference

Objekt

Nazwa	Typ	Opis
id	string (uuid)
name	string

ReferenceLinks

Objekt

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Czytelny widok linków. Ponieważ linki odwołania są tylko do odczytu, chcemy uwidocznić je tylko jako tylko do odczytu.

ServiceEndpoint

Objekt

Reprezentuje punkt końcowy, który może być używany przez zadanie aranżacji.

Nazwa	Typ	Opis
administratorsGroup	IdentityRef	Jest to przestarzałe pole.
authorization	EndpointAuthorization	Pobiera lub ustawia dane autoryzacji do rozmowy z punktem końcowym.
createdBy	IdentityRef	Pobiera lub ustawia odwołanie do tożsamości użytkownika, który utworzył punkt końcowy usługi.
data	object
description	string	Pobiera lub ustawia opis punktu końcowego.
groupScopeId	string (uuid)	Jest to przestarzałe pole.
id	string (uuid)	Pobiera lub ustawia identyfikator tego punktu końcowego.
isReady	boolean	Wskaźnik stanu punktu końcowego
isShared	boolean	Wskazuje, czy punkt końcowy usługi jest udostępniany innym projektom, czy nie.
name	string	Pobiera lub ustawia przyjazną nazwę punktu końcowego.
operationStatus	JObject	Komunikat o błędzie podczas tworzenia/usuwania punktu końcowego
owner	string	Właścicielem obsługiwanych wartości punktu końcowego są "biblioteka", "agentcloud"
readersGroup	IdentityRef	Pobiera lub ustawia odwołanie tożsamości dla grupy czytelników punktu końcowego usługi.
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	Wszystkie inne odwołania do projektu, w którym jest udostępniany punkt końcowy usługi.
type	string	Pobiera lub ustawia typ punktu końcowego.
url	string	Pobiera lub ustawia adres URL punktu końcowego.

ServiceEndpointProjectReference

Objekt

Nazwa	Typ	Opis
description	string	Pobiera lub ustawia opis punktu końcowego usługi.
name	string	Pobiera lub ustawia nazwę punktu końcowego usługi.
projectReference	ProjectReference	Pobiera lub ustawia odwołanie do projektu punktu końcowego usługi.

Udostępnij przez

Endpoints - Create

Parametry identyfikatora URI

Treść żądania

Odpowiedzi

Zabezpieczenia

oauth2

Zakresy

Przykłady

Create Azure RM service endpoint

Przykładowe żądanie

Przykładowa odpowiedź

Create service endpoint

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

EndpointAuthorization

IdentityRef

JObject

JToken

ProjectReference

ReferenceLinks

ServiceEndpoint

ServiceEndpointProjectReference