Endpoints - Update Service Endpoint

Referensi

Layanan:: Service Endpoint

Versi API:: 7.1

Memperbarui titik akhir layanan

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

Dengan parameter opsional:

PUT https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints/{endpointId}?operation={operation}&api-version=7.1

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpointId	path	True	string (uuid)	Id Titik Akhir titik akhir yang akan diperbarui
organization	path	True	string	Nama organisasi Azure DevOps.
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.1' untuk menggunakan versi api ini.
operation	query		string	jenis operasi

Isi Permintaan

Nama	Jenis	Deskripsi
administratorsGroup	IdentityRef	Ini adalah bidang yang tidak digunakan lagi.
authorization	EndpointAuthorization	Mendapatkan atau mengatur data otorisasi untuk berbicara dengan titik akhir.
createdBy	IdentityRef	Mendapatkan atau mengatur referensi identitas untuk pengguna yang membuat titik akhir Layanan.
data	object
description	string	Mendapatkan atau mengatur deskripsi titik akhir.
groupScopeId	string (uuid)	Ini adalah bidang yang tidak digunakan lagi.
id	string (uuid)	Mendapatkan atau mengatur pengidentifikasi titik akhir ini.
isReady	boolean	Indikator status Titik Akhir
isShared	boolean	Menunjukkan apakah titik akhir layanan dibagikan dengan proyek lain atau tidak.
name	string	Mendapatkan atau mengatur nama titik akhir yang mudah diingat.
operationStatus	JObject	Pesan kesalahan selama pembuatan/penghapusan titik akhir
owner	string	Pemilik titik akhir Nilai yang didukung adalah "library", "agentcloud"
readersGroup	IdentityRef	Mendapatkan atau mengatur referensi identitas untuk grup pembaca titik akhir layanan.
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	Semua referensi proyek lainnya tempat titik akhir layanan dibagikan.
type	string	Mendapatkan atau mengatur jenis titik akhir.
url	string	Mendapatkan atau mengatur url titik akhir.

Respons

Nama	Jenis	Deskripsi
200 OK	ServiceEndpoint	operasi berhasil

Keamanan

oauth2

Jenis: oauth2
Alur: accessCode
URL Otorisasi: 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

Cakupan

Nama	Deskripsi
vso.serviceendpoint_manage	Memberikan kemampuan untuk membaca, mengkueri, dan mengelola titik akhir layanan.

Contoh

Update service endpoint

Permintaan sampel

HTTP

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

{
  "data": {},
  "id": "5e47a0d8-c745-44f8-8f93-784f18ff31c4",
  "name": "UpdatedServiceEndpoint",
  "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": "myupdatedusername",
      "password": "myupdatedpassword"
    },
    "scheme": "UsernamePassword"
  },
  "isShared": false,
  "isReady": true,
  "owner": "Library",
  "serviceEndpointProjectReferences": [
    {
      "projectReference": {
        "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
        "name": "TestProject"
      },
      "name": "MyNewServiceEndpoint"
    }
  ]
}

Respon sampel

Kode status:: 200

{
  "data": {},
  "id": "5e47a0d8-c745-44f8-8f93-784f18ff31c4",
  "name": "UpdatedServiceEndpoint",
  "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": "myupdatedusername",
      "password": null
    },
    "scheme": "UsernamePassword"
  },
  "isShared": false,
  "isReady": true,
  "owner": "Library",
  "serviceEndpointProjectReferences": [
    {
      "projectReference": {
        "id": "c7e5f0b3-71fa-4429-9fb3-3321963a7c06",
        "name": "TestProject"
      },
      "name": "MyNewServiceEndpoint"
    }
  ]
}

Definisi

Nama	Deskripsi
EndpointAuthorization	Mewakili otorisasi yang digunakan untuk titik akhir layanan.
IdentityRef
JObject	Mewakili objek JSON.
JToken	Mewakili token JSON abstrak.
ProjectReference
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
ServiceEndpoint	Mewakili titik akhir yang dapat digunakan oleh pekerjaan orkestrasi.
ServiceEndpointProjectReference

EndpointAuthorization

Objek

Mewakili otorisasi yang digunakan untuk titik akhir layanan.

Nama	Jenis	Deskripsi
parameters	object	Mendapatkan atau mengatur parameter untuk skema otorisasi yang dipilih.
scheme	string	Mendapatkan atau mengatur skema yang digunakan untuk autentikasi titik akhir layanan.

IdentityRef

Objek

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Bidang ini berisi nol atau lebih tautan menarik tentang subjek grafik. Tautan ini dapat dipanggil untuk mendapatkan hubungan tambahan atau informasi yang lebih rinci tentang subjek grafik ini.
descriptor	string	Deskriptor adalah cara utama untuk mereferensikan subjek grafik saat sistem sedang berjalan. Bidang ini akan mengidentifikasi subjek grafik yang sama secara unik di seluruh Akun dan Organisasi.
directoryAlias	string	Tidak digunakan lagi - Dapat diambil dengan mengkueri pengguna Graph yang direferensikan dalam entri "diri" kamus IdentityRef "_links"
displayName	string	Ini adalah nama tampilan subjek grafik yang tidak unik. Untuk mengubah bidang ini, Anda harus mengubah nilainya di penyedia sumber.
id	string
imageUrl	string	Tidak digunakan lagi - Tersedia dalam entri "avatar" kamus IdentityRef "_links"
inactive	boolean	Tidak digunakan lagi - Dapat diambil dengan mengkueri status keanggotaan Graph yang direferensikan dalam entri "membershipState" kamus "_links" GraphUser
isAadIdentity	boolean	Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)
isContainer	boolean	Tidak digunakan lagi - Dapat disimpulkan dari jenis subjek deskriptor (Descriptor.IsGroupType)
isDeletedInOrigin	boolean
profileUrl	string	Tidak digunakan lagi - tidak digunakan dalam sebagian besar implementasi ToIdentityRef yang sudah ada sebelumnya
uniqueName	string	Tidak digunakan lagi - gunakan Domain+PrincipalName sebagai gantinya
url	string	Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini.

JObject

Objek

Mewakili objek JSON.

Nama	Jenis	Deskripsi
item	JToken	Mewakili token JSON abstrak.
type	string (JTokenType)	Mendapatkan jenis node untuk JToken ini.

JToken

Objek

Mewakili token JSON abstrak.

Nama	Jenis	Deskripsi
first	JToken	Dapatkan token anak pertama dari token ini.
hasValues	boolean	Mendapatkan nilai yang menunjukkan apakah token ini memiliki token anak.
item	JToken	Mewakili token JSON abstrak.
last	JToken	Dapatkan token anak terakhir dari token ini.
next	JToken	Mendapatkan token saudara kandung berikutnya dari simpul ini.
parent	string (JContainer)	Mendapatkan atau mengatur induk.
path	string	Mendapatkan jalur token JSON.
previous	JToken	Mendapatkan token saudara kandung sebelumnya dari simpul ini.
root	JToken	Mendapatkan JToken akar dari JToken ini.
type	string (JTokenType)	Mendapatkan jenis node untuk JToken ini.

ProjectReference

Objek

Nama	Jenis	Deskripsi
id	string (uuid)
name	string

ReferenceLinks

Objek

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama	Jenis	Deskripsi
links	object	Tampilan tautan secara baca-saja. Karena tautan Referensi dibaca saja, kami hanya ingin mengeksposnya sebagai baca-saja.

ServiceEndpoint

Objek

Mewakili titik akhir yang dapat digunakan oleh pekerjaan orkestrasi.

Nama	Jenis	Deskripsi
administratorsGroup	IdentityRef	Ini adalah bidang yang tidak digunakan lagi.
authorization	EndpointAuthorization	Mendapatkan atau mengatur data otorisasi untuk berbicara dengan titik akhir.
createdBy	IdentityRef	Mendapatkan atau mengatur referensi identitas untuk pengguna yang membuat titik akhir Layanan.
data	object
description	string	Mendapatkan atau mengatur deskripsi titik akhir.
groupScopeId	string (uuid)	Ini adalah bidang yang tidak digunakan lagi.
id	string (uuid)	Mendapatkan atau mengatur pengidentifikasi titik akhir ini.
isReady	boolean	Indikator status Titik Akhir
isShared	boolean	Menunjukkan apakah titik akhir layanan dibagikan dengan proyek lain atau tidak.
name	string	Mendapatkan atau mengatur nama titik akhir yang mudah diingat.
operationStatus	JObject	Pesan kesalahan selama pembuatan/penghapusan titik akhir
owner	string	Pemilik titik akhir Nilai yang didukung adalah "library", "agentcloud"
readersGroup	IdentityRef	Mendapatkan atau mengatur referensi identitas untuk grup pembaca titik akhir layanan.
serviceEndpointProjectReferences	ServiceEndpointProjectReference[]	Semua referensi proyek lainnya tempat titik akhir layanan dibagikan.
type	string	Mendapatkan atau mengatur jenis titik akhir.
url	string	Mendapatkan atau mengatur url titik akhir.

ServiceEndpointProjectReference

Objek

Nama	Jenis	Deskripsi
description	string	Mendapatkan atau menetapkan deskripsi titik akhir layanan.
name	string	Mendapatkan atau menetapkan nama titik akhir layanan.
projectReference	ProjectReference	Mendapatkan atau menetapkan referensi proyek dari titik akhir layanan.

Bagikan melalui

Endpoints - Update Service Endpoint

Parameter URI

Isi Permintaan

Respons

Keamanan

oauth2

Cakupan

Contoh

Update service endpoint

Permintaan sampel

Respon sampel

Definisi

EndpointAuthorization

IdentityRef

JObject

JToken

ProjectReference

ReferenceLinks

ServiceEndpoint

ServiceEndpointProjectReference