Backend - Update

Referensi

Layanan:: API Management

Versi API:: 2024-05-01

Memperbarui backend yang ada.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}?api-version=2024-05-01

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
backendId	path	True	string minLength: 1 maxLength: 80	Pengidentifikasi entitas Backend. Harus unik dalam instans layanan API Management saat ini.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nama layanan API Management.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus UUID.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
If-Match	True	string	ETag Entitas. ETag harus cocok dengan status entitas saat ini dari respons header permintaan GET atau harus * untuk pembaruan tanpa syarat.

Isi Permintaan

Nama	Jenis	Deskripsi
properties.circuitBreaker	BackendCircuitBreaker	Konfigurasi Pemutus Sirkuit Backend
properties.credentials	BackendCredentialsContract	Properti Kontrak Kredensial Backend
properties.description	string minLength: 1 maxLength: 2000	Deskripsi Backend.
properties.pool	Pool
properties.properties	BackendProperties	Kontrak Properti Backend
properties.protocol	BackendProtocol	Protokol komunikasi backend.
properties.proxy	BackendProxyContract	Properti Kontrak gateway backend
properties.resourceId	string minLength: 1 maxLength: 2000	Uri Manajemen Sumber Daya dalam Sistem Eksternal. URL ini dapat menjadi Id Sumber Daya Arm dari Logic Apps, Aplikasi Fungsi, atau Aplikasi API.
properties.title	string minLength: 1 maxLength: 300	Judul Backend.
properties.tls	BackendTlsProperties	Properti TLS Ujung Belakang
properties.type	BackendType	Jenis backend. Backend dapat berupa Tunggal atau Kumpulan.
properties.url	string minLength: 1 maxLength: 2000	Runtime Url of the Backend.

Respons

Nama	Jenis	Deskripsi
200 OK	BackendContract	Backend yang ada berhasil diperbarui. Header ETag: string
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Nama

Jenis

Deskripsi

200 OK

BackendContract

Backend yang ada berhasil diperbarui.

Header

ETag: string

Other Status Codes

ErrorResponse

Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementUpdateBackend

Permintaan sampel

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend?api-version=2024-05-01


{
  "properties": {
    "description": "description5308",
    "tls": {
      "validateCertificateChain": false,
      "validateCertificateName": true
    }
  }
}

Respon sampel

Kode status:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "proxybackend",
  "properties": {
    "description": "description5308",
    "url": "https://backendname2644/",
    "protocol": "http",
    "credentials": {
      "query": {
        "sv": [
          "xx",
          "bb",
          "cc"
        ]
      },
      "header": {
        "x-my-1": [
          "val1",
          "val2"
        ]
      },
      "authorization": {
        "scheme": "Basic",
        "parameter": "opensesma"
      }
    },
    "proxy": {
      "url": "http://192.168.1.1:8080",
      "username": "Contoso\\admin",
      "password": "<password>"
    },
    "tls": {
      "validateCertificateChain": false,
      "validateCertificateName": true
    }
  }
}

Definisi

Nama	Deskripsi
BackendAuthorizationHeaderCredentials	Informasi header otorisasi.
BackendCircuitBreaker	Konfigurasi pemutus sirkuit backend
BackendContract	Detail backend.
BackendCredentialsContract	Detail Kredensial yang digunakan untuk menyambungkan ke Backend.
BackendPoolItem	Informasi layanan kumpulan backend
BackendProperties	Properti khusus untuk Jenis Backend.
BackendProtocol	Protokol komunikasi backend.
BackendProxyContract	Detail Server WebProxy Backend untuk digunakan dalam Permintaan ke Backend.
BackendServiceFabricClusterProperties	Properti Backend Jenis Service Fabric.
BackendTlsProperties	Properti yang mengontrol Validasi Sertifikat TLS.
BackendType	Jenis backend. Backend dapat berupa Tunggal atau Kumpulan.
BackendUpdateParameters	Parameter pembaruan backend.
CircuitBreakerFailureCondition	Kondisi perjalanan pemutus sirkuit
CircuitBreakerRule	Konfigurasi aturan untuk melakukan perjalanan backend.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
FailureStatusCodeRange	Rentang kode status http gagal
Pool
X509CertificateName	Properti server X509Names.

BackendAuthorizationHeaderCredentials

Objek

Informasi header otorisasi.

Nama	Jenis	Deskripsi
parameter	string minLength: 1 maxLength: 300	Nilai Parameter Autentikasi.
scheme	string minLength: 1 maxLength: 100	Nama Skema autentikasi.

BackendCircuitBreaker

Objek

Konfigurasi pemutus sirkuit backend

Nama	Jenis	Deskripsi
rules	CircuitBreakerRule[]	Aturan untuk tersandung backend.

BackendContract

Objek

Detail backend.

Nama	Jenis	Deskripsi
id	string	ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nama sumber daya
properties.circuitBreaker	BackendCircuitBreaker	Konfigurasi Pemutus Sirkuit Backend
properties.credentials	BackendCredentialsContract	Properti Kontrak Kredensial Backend
properties.description	string minLength: 1 maxLength: 2000	Deskripsi Backend.
properties.pool	Pool
properties.properties	BackendProperties	Kontrak Properti Backend
properties.protocol	BackendProtocol	Protokol komunikasi backend.
properties.proxy	BackendProxyContract	Properti Kontrak gateway backend
properties.resourceId	string minLength: 1 maxLength: 2000	Uri Manajemen Sumber Daya dalam Sistem Eksternal. URL ini dapat menjadi Id Sumber Daya Arm dari Logic Apps, Aplikasi Fungsi, atau Aplikasi API.
properties.title	string minLength: 1 maxLength: 300	Judul Backend.
properties.tls	BackendTlsProperties	Properti TLS Ujung Belakang
properties.type	BackendType	Jenis backend. Backend dapat berupa Tunggal atau Kumpulan.
properties.url	string minLength: 1 maxLength: 2000	Runtime Url of the Backend.
type	string	Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Objek

Detail Kredensial yang digunakan untuk menyambungkan ke Backend.

Nama	Jenis	Deskripsi
authorization	BackendAuthorizationHeaderCredentials	Autentikasi header otorisasi
certificate	string[]	Daftar Thumbprint Sertifikat Klien. Akan diabaikan jika certificatesIds disediakan.
certificateIds	string[]	Daftar Id Sertifikat Klien.
header	object	Deskripsi Parameter Header.
query	object	Deskripsi Parameter Kueri.

BackendPoolItem

Objek

Informasi layanan kumpulan backend

Nama	Jenis	Deskripsi
id	string (arm-id)	Id ARM unik dari entitas backend. Id ARM harus merujuk ke entitas backend yang sudah ada.
priority	integer (int32) minimum: 0 maximum: 100	Prioritas entitas backend di kumpulan backend. Harus antara 0 dan 100. Ini juga dapat null jika nilai tidak ditentukan.
weight	integer (int32) minimum: 0 maximum: 100	Berat entitas backend di kumpulan backend. Harus antara 0 dan 100. Ini juga dapat null jika nilai tidak ditentukan.

BackendProperties

Objek

Properti khusus untuk Jenis Backend.

Nama	Jenis	Deskripsi
serviceFabricCluster	BackendServiceFabricClusterProperties	Properti Kluster Backend Service Fabric

BackendProtocol

Enumeration

Protokol komunikasi backend.

Nilai	Deskripsi
http	Backend adalah layanan RESTful.
soap	Backend adalah layanan SOAP.

BackendProxyContract

Objek

Detail Server WebProxy Backend untuk digunakan dalam Permintaan ke Backend.

Nama	Jenis	Deskripsi
password	string	Kata sandi untuk menyambungkan ke Server WebProxy
url	string minLength: 1 maxLength: 2000	Properti WebProxy Server AbsoluteUri yang mencakup seluruh URI yang disimpan dalam instans Uri, termasuk semua fragmen dan string kueri.
username	string	Nama pengguna untuk menyambungkan ke server WebProxy

BackendServiceFabricClusterProperties

Objek

Properti Backend Jenis Service Fabric.

Nama	Jenis	Deskripsi
clientCertificateId	string	Id sertifikat klien untuk titik akhir manajemen.
clientCertificatethumbprint	string	Thumbprint sertifikat klien untuk titik akhir manajemen. Akan diabaikan jika certificatesIds disediakan
managementEndpoints	string[]	Titik akhir manajemen kluster.
maxPartitionResolutionRetries	integer (int32)	Jumlah maksimum percobaan ulang saat mencoba menyelesaikan partisi.
serverCertificateThumbprints	string[]	Thumbprints layanan manajemen kluster sertifikat digunakan untuk komunikasi tls
serverX509Names	X509CertificateName[]	Kumpulan Nama Sertifikat Server X509

BackendTlsProperties

Objek

Properti yang mengontrol Validasi Sertifikat TLS.

Nama	Jenis	Nilai default	Deskripsi
validateCertificateChain	boolean	True	Bendera yang menunjukkan apakah validasi rantai sertifikat SSL harus dilakukan saat menggunakan sertifikat yang ditandatangani sendiri untuk host backend ini.
validateCertificateName	boolean	True	Bendera yang menunjukkan apakah validasi nama sertifikat SSL harus dilakukan saat menggunakan sertifikat yang ditandatangani sendiri untuk host backend ini.

BackendType

Enumeration

Jenis backend. Backend dapat berupa Tunggal atau Kumpulan.

Nilai	Deskripsi
Pool	mendukung backend kumpulan
Single	mendukung backend tunggal

BackendUpdateParameters

Objek

Parameter pembaruan backend.

Nama	Jenis	Deskripsi
properties.circuitBreaker	BackendCircuitBreaker	Konfigurasi Pemutus Sirkuit Backend
properties.credentials	BackendCredentialsContract	Properti Kontrak Kredensial Backend
properties.description	string minLength: 1 maxLength: 2000	Deskripsi Backend.
properties.pool	Pool
properties.properties	BackendProperties	Kontrak Properti Backend
properties.protocol	BackendProtocol	Protokol komunikasi backend.
properties.proxy	BackendProxyContract	Properti Kontrak gateway backend
properties.resourceId	string minLength: 1 maxLength: 2000	Uri Manajemen Sumber Daya dalam Sistem Eksternal. URL ini dapat menjadi Id Sumber Daya Arm dari Logic Apps, Aplikasi Fungsi, atau Aplikasi API.
properties.title	string minLength: 1 maxLength: 300	Judul Backend.
properties.tls	BackendTlsProperties	Properti TLS Ujung Belakang
properties.type	BackendType	Jenis backend. Backend dapat berupa Tunggal atau Kumpulan.
properties.url	string minLength: 1 maxLength: 2000	Runtime Url of the Backend.

CircuitBreakerFailureCondition

Objek

Kondisi perjalanan pemutus sirkuit

Nama	Jenis	Deskripsi
count	integer (int64)	Ambang batas untuk membuka sirkuit.
errorReasons	string[] maxLength: 200	Alasan kesalahan yang dianggap sebagai kegagalan.
interval	string (duration)	Interval di mana kegagalan dihitung.
percentage	integer (int64)	Ambang batas untuk membuka sirkuit.
statusCodeRanges	FailureStatusCodeRange[]	Rentang kode status yang dianggap gagal.

CircuitBreakerRule

Objek

Konfigurasi aturan untuk melakukan perjalanan backend.

Nama	Jenis	Deskripsi
acceptRetryAfter	boolean	bendera untuk menerima header Retry-After dari backend.
failureCondition	CircuitBreakerFailureCondition	Kondisi untuk tersandung pemutus sirkuit.
name	string	Nama aturan.
tripDuration	string (duration)	Durasi sirkuit akan tersandung.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

FailureStatusCodeRange

Objek

Rentang kode status http gagal

Nama	Jenis	Deskripsi
max	integer (int32) minimum: 200 maximum: 599	Kode status http maksimum.
min	integer (int32) minimum: 200 maximum: 599	Kode status http minimum.

Pool

Objek

Nama	Jenis	Deskripsi
services	BackendPoolItem[]	Daftar entitas backend milik kumpulan.

X509CertificateName

Objek

Properti server X509Names.

Nama	Jenis	Deskripsi
issuerCertificateThumbprint	string	Thumbprint untuk Penerbit Sertifikat.
name	string	Nama Umum Sertifikat.

Bagikan melalui

Backend - Update

Parameter URI

Header Permintaan

Isi Permintaan

Respons

Keamanan

azure_auth

Cakupan

Contoh

ApiManagementUpdateBackend

Permintaan sampel

Respon sampel

Definisi

BackendAuthorizationHeaderCredentials

BackendCircuitBreaker

BackendContract

BackendCredentialsContract

BackendPoolItem

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

BackendType

BackendUpdateParameters

CircuitBreakerFailureCondition

CircuitBreakerRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailureStatusCodeRange

Pool

X509CertificateName

Sumber Daya Tambahan: