Aracılığıyla paylaş

Backend - Update

  • Başvuru
Hizmet:
API Management
API Sürümü:
2024-05-01

Mevcut bir arka ucu güncelleştirir.

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

URI Parametreleri

Name İçinde Gerekli Tür Description
backendId
 path True

string

minLength: 1
maxLength: 80

Arka uç varlığının tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

API Management hizmetinin adı.
subscriptionId
 path True

string (uuid)

Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version
 query True

string

minLength: 1

Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name Gerekli Tür Description
If-Match True

string

Varlığın ETag'i. ETag, GET isteğinin üst bilgi yanıtından geçerli varlık durumuyla eşleşmeli veya koşulsuz güncelleştirme için * olmalıdır.

İstek Gövdesi

Name Tür Description
properties.circuitBreaker

BackendCircuitBreaker

Arka Uç Devre Kesici Yapılandırması
properties.credentials

BackendCredentialsContract

Arka Uç Kimlik Bilgileri Sözleşme Özellikleri
properties.description

string

minLength: 1
maxLength: 2000

Arka Uç Açıklaması.
properties.pool

Pool

properties.properties

BackendProperties

Arka Uç Özellikleri sözleşmesi
properties.protocol

BackendProtocol

Arka uç iletişim protokolü.
properties.proxy

BackendProxyContract

Arka uç ağ geçidi Sözleşme Özellikleri
properties.resourceId

string

minLength: 1
maxLength: 2000

Dış Sistemdeki Kaynağın Yönetim Uri'si. Bu URL Logic Apps, İşlev Uygulamaları veya API Uygulamalarının Arm Kaynak Kimliği olabilir.
properties.title

string

minLength: 1
maxLength: 300

Arka Uç Başlığı.
properties.tls

BackendTlsProperties

Arka Uç TLS Özellikleri
properties.type

BackendType

Arka ucun türü. Arka uç Tek veya Havuz olabilir.
properties.url

string

minLength: 1
maxLength: 2000

Arka Ucun Çalışma Zamanı Url'si.

Yanıtlar

Name Tür Description
200 OK

BackendContract

Mevcut arka uç başarıyla güncelleştirildi.

Üst Bilgiler

ETag: string
Other Status Codes

ErrorResponse

İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name Description
user_impersonation kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementUpdateBackend

Örnek isteği

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

Örnek yanıt

Durum kodu:
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
    }
  }
}

Tanımlar

Name Description
BackendAuthorizationHeaderCredentials

Yetkilendirme üst bilgisi bilgileri.
BackendCircuitBreaker

Arka uç devre kesici yapılandırması
BackendContract

Arka uç ayrıntıları.
BackendCredentialsContract

Arka Uç'a bağlanmak için kullanılan Kimlik Bilgilerinin ayrıntıları.
BackendPoolItem

Arka uç havuzu hizmet bilgileri
BackendProperties

Arka Uç Türüne özgü özellikler.
BackendProtocol

Arka uç iletişim protokolü.
BackendProxyContract

Arka Uç İsteğinde kullanılacak Arka Uç WebProxy Sunucusunun ayrıntıları.
BackendServiceFabricClusterProperties

Service Fabric Türü Arka Ucu özellikleri.
BackendTlsProperties

TLS Sertifika Doğrulamasını denetleen özellikler.
BackendType

Arka ucun türü. Arka uç Tek veya Havuz olabilir.
BackendUpdateParameters

Arka uç güncelleştirme parametreleri.
CircuitBreakerFailureCondition

Devre kesicinin seyahat koşulları
CircuitBreakerRule

Arka ucu döndürmek için kural yapılandırması.
ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.
ErrorDetail

Hata ayrıntısı.
ErrorResponse

Hata yanıtı
FailureStatusCodeRange

Hata http durum kodu aralığı
Pool
X509CertificateName

X509Names sunucusunun özellikleri.

BackendAuthorizationHeaderCredentials

Object

Yetkilendirme üst bilgisi bilgileri.

Name Tür Description
parameter

string

minLength: 1
maxLength: 300

Kimlik Doğrulama Parametresi değeri.
scheme

string

minLength: 1
maxLength: 100

Kimlik Doğrulama Düzeni adı.

BackendCircuitBreaker

Object

Arka uç devre kesici yapılandırması

Name Tür Description
rules

CircuitBreakerRule[]

Arka ucu kopyalama kuralları.

BackendContract

Object

Arka uç ayrıntıları.

Name Tür Description
id

string

Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Kaynağın adı
properties.circuitBreaker

BackendCircuitBreaker

Arka Uç Devre Kesici Yapılandırması
properties.credentials

BackendCredentialsContract

Arka Uç Kimlik Bilgileri Sözleşme Özellikleri
properties.description

string

minLength: 1
maxLength: 2000

Arka Uç Açıklaması.
properties.pool

Pool

properties.properties

BackendProperties

Arka Uç Özellikleri sözleşmesi
properties.protocol

BackendProtocol

Arka uç iletişim protokolü.
properties.proxy

BackendProxyContract

Arka uç ağ geçidi Sözleşme Özellikleri
properties.resourceId

string

minLength: 1
maxLength: 2000

Dış Sistemdeki Kaynağın Yönetim Uri'si. Bu URL Logic Apps, İşlev Uygulamaları veya API Uygulamalarının Arm Kaynak Kimliği olabilir.
properties.title

string

minLength: 1
maxLength: 300

Arka Uç Başlığı.
properties.tls

BackendTlsProperties

Arka Uç TLS Özellikleri
properties.type

BackendType

Arka ucun türü. Arka uç Tek veya Havuz olabilir.
properties.url

string

minLength: 1
maxLength: 2000

Arka Ucun Çalışma Zamanı Url'si.
type

string

Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Object

Arka Uç'a bağlanmak için kullanılan Kimlik Bilgilerinin ayrıntıları.

Name Tür Description
authorization

BackendAuthorizationHeaderCredentials

Yetkilendirme üst bilgisi kimlik doğrulaması
certificate

string[]

İstemci Sertifikası Parmak İzleri Listesi. CertificatesId'ler sağlanırsa yoksayılır.
certificateIds

string[]

İstemci Sertifikası Kimliklerinin listesi.
header

object

Üst Bilgi Parametresi açıklaması.
query

object

Sorgu Parametresi açıklaması.

BackendPoolItem

Object

Arka uç havuzu hizmet bilgileri

Name Tür Description
id

string (arm-id)

Arka uç varlığının benzersiz ARM kimliği. ARM kimliği zaten var olan bir arka uç varlığına başvurmalıdır.
priority

integer (int32)

minimum: 0
maximum: 100

Arka uç havuzundaki arka uç varlığının önceliği. 0 ile 100 arasında olmalıdır. Değer belirtilmezse null da olabilir.
weight

integer (int32)

minimum: 0
maximum: 100

Arka uç havuzundaki arka uç varlığının ağırlığı. 0 ile 100 arasında olmalıdır. Değer belirtilmezse null da olabilir.

BackendProperties

Object

Arka Uç Türüne özgü özellikler.

Name Tür Description
serviceFabricCluster

BackendServiceFabricClusterProperties

Arka Uç Service Fabric Küme Özellikleri

BackendProtocol

Listeleme

Arka uç iletişim protokolü.

Değer Description
http

Arka uç bir RESTful hizmetidir.
soap

Arka uç bir SOAP hizmetidir.

BackendProxyContract

Object

Arka Uç İsteğinde kullanılacak Arka Uç WebProxy Sunucusunun ayrıntıları.

Name Tür Description
password

string

WebProxy Sunucusuna bağlanmak için parola
url

string

minLength: 1
maxLength: 2000

Tüm parçalar ve sorgu dizeleri dahil olmak üzere Uri örneğinde depolanan URI'nin tamamını içeren WebProxy Server AbsoluteUri özelliği.
username

string

WebProxy sunucusuna bağlanmak için kullanıcı adı

BackendServiceFabricClusterProperties

Object

Service Fabric Türü Arka Ucu özellikleri.

Name Tür Description
clientCertificateId

string

Yönetim uç noktası için istemci sertifika kimliği.
clientCertificatethumbprint

string

Yönetim uç noktası için istemci sertifikası parmak izi. CertificatesId'ler sağlanırsa yoksayılır
managementEndpoints

string[]

Küme yönetim uç noktası.
maxPartitionResolutionRetries

integer (int32)

Bölümü çözümlemeye çalışırken en fazla yeniden deneme sayısı.
serverCertificateThumbprints

string[]

Sertifika kümesi yönetim hizmetinin tls iletişimi için kullandığı parmak izleri
serverX509Names

X509CertificateName[]

Sunucu X509 Sertifika Adları Koleksiyonu

BackendTlsProperties

Object

TLS Sertifika Doğrulamasını denetleen özellikler.

Name Tür Default value Description
validateCertificateChain

boolean

True

Bu arka uç konağı için otomatik olarak imzalanan sertifikalar kullanılırken SSL sertifika zinciri doğrulamasının yapılıp yapılmayacağını gösteren bayrak.
validateCertificateName

boolean

True

Bu arka uç konağı için otomatik olarak imzalanan sertifikalar kullanılırken SSL sertifika adı doğrulamasının yapılıp yapılmayacağını gösteren bayrak.

BackendType

Listeleme

Arka ucun türü. Arka uç Tek veya Havuz olabilir.

Değer Description
Pool

havuz arka ucu destekler
Single

tek arka ucu destekler

BackendUpdateParameters

Object

Arka uç güncelleştirme parametreleri.

Name Tür Description
properties.circuitBreaker

BackendCircuitBreaker

Arka Uç Devre Kesici Yapılandırması
properties.credentials

BackendCredentialsContract

Arka Uç Kimlik Bilgileri Sözleşme Özellikleri
properties.description

string

minLength: 1
maxLength: 2000

Arka Uç Açıklaması.
properties.pool

Pool

properties.properties

BackendProperties

Arka Uç Özellikleri sözleşmesi
properties.protocol

BackendProtocol

Arka uç iletişim protokolü.
properties.proxy

BackendProxyContract

Arka uç ağ geçidi Sözleşme Özellikleri
properties.resourceId

string

minLength: 1
maxLength: 2000

Dış Sistemdeki Kaynağın Yönetim Uri'si. Bu URL Logic Apps, İşlev Uygulamaları veya API Uygulamalarının Arm Kaynak Kimliği olabilir.
properties.title

string

minLength: 1
maxLength: 300

Arka Uç Başlığı.
properties.tls

BackendTlsProperties

Arka Uç TLS Özellikleri
properties.type

BackendType

Arka ucun türü. Arka uç Tek veya Havuz olabilir.
properties.url

string

minLength: 1
maxLength: 2000

Arka Ucun Çalışma Zamanı Url'si.

CircuitBreakerFailureCondition

Object

Devre kesicinin seyahat koşulları

Name Tür Description
count

integer (int64)

Bağlantı hattını açma eşiği.
errorReasons

string[]

maxLength: 200

Hata olarak kabul edilen hata nedenleri.
interval

string (duration)

Hataların sayıldığı aralık.
percentage

integer (int64)

Bağlantı hattını açma eşiği.
statusCodeRanges

FailureStatusCodeRange[]

Hata olarak kabul edilen durum kodu aralıkları.

CircuitBreakerRule

Object

Arka ucu döndürmek için kural yapılandırması.

Name Tür Description
acceptRetryAfter

boolean

bayrağını kullanarak arka uçtan Retry-After üst bilgisini kabul edin.
failureCondition

CircuitBreakerFailureCondition

Devre kesiciyi sökme koşulları.
name

string

Kural adı.
tripDuration

string (duration)

Bağlantı hattının atlanacağı süre.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name Tür Description
info

object

Ek bilgiler.
type

string

Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name Tür Description
additionalInfo

ErrorAdditionalInfo[]

Hata ek bilgileri.
code

string

Hata kodu.
details

ErrorDetail[]

Hata ayrıntıları.
message

string

Hata iletisi.
target

string

Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name Tür Description
error

ErrorDetail

Hata nesnesi.

FailureStatusCodeRange

Object

Hata http durum kodu aralığı

Name Tür Description
max

integer (int32)

minimum: 200
maximum: 599

En yüksek http durum kodu.
min

integer (int32)

minimum: 200
maximum: 599

En düşük http durum kodu.

Pool

Object
Name Tür Description
services

BackendPoolItem[]

Havuza ait arka uç varlıklarının listesi.

X509CertificateName

Object

X509Names sunucusunun özellikleri.

Name Tür Description
issuerCertificateThumbprint

string

Sertifikayı Veren için parmak izi.
name

string

Sertifikanın Ortak Adı.