Backend - Update

Referencia

Szolgáltatás:: API Management

API-verzió:: 2024-05-01

Meglévő háttérrendszer frissítése.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
backendId	path	True	string minLength: 1 maxLength: 80	A Háttér entitás azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Az API Management szolgáltatás neve.
subscriptionId	path	True	string (uuid)	A cél-előfizetés azonosítója. Az értéknek UUID-nek kell lennie.
api-version	query	True	string minLength: 1	A művelethez használni kívánt API-verzió.

Kérelem fejléce

Name	Kötelező	Típus	Description
If-Match	True	string	Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.

Kérelem törzse

Name	Típus	Description
properties.circuitBreaker	BackendCircuitBreaker	Háttér áramkör-megszakító konfigurációja
properties.credentials	BackendCredentialsContract	Háttérbeli hitelesítő adatok szerződésének tulajdonságai
properties.description	string minLength: 1 maxLength: 2000	Háttér leírása.
properties.pool	Pool
properties.properties	BackendProperties	Háttértulajdonságok szerződése
properties.protocol	BackendProtocol	Háttérkommunikációs protokoll.
properties.proxy	BackendProxyContract	Háttérátjáró szerződésének tulajdonságai
properties.resourceId	string minLength: 1 maxLength: 2000	Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Function Apps vagy az API Apps arm erőforrás-azonosítója.
properties.title	string minLength: 1 maxLength: 300	Háttércím.
properties.tls	BackendTlsProperties	Háttérbeli TLS-tulajdonságok
properties.type	BackendType	A háttérrendszer típusa. A háttérrendszer lehet önálló vagy készlet.
properties.url	string minLength: 1 maxLength: 2000	A háttérrendszer futtatókörnyezeti URL-címe.

Válaszok

Name	Típus	Description
200 OK	BackendContract	A meglévő háttérrendszer frissítése sikeresen megtörtént. Fejlécek ETag: string
Other Status Codes	ErrorResponse	Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Name

Típus

Description

200 OK

BackendContract

A meglévő háttérrendszer frissítése sikeresen megtörtént.

Fejlécek

ETag: string

Other Status Codes

ErrorResponse

Hibaválasz, amely leírja, hogy miért nem sikerült a művelet.

Biztonság

azure_auth

Azure Active Directory OAuth2 Flow.

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

ApiManagementUpdateBackend

Mintakérelem

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

Mintaválasz

Állapotkód:: 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
    }
  }
}

Definíciók

Name	Description
BackendAuthorizationHeaderCredentials	Az engedélyezési fejléc adatai.
BackendCircuitBreaker	A háttér-kapcsolatcsoport-megszakító konfigurálása
BackendContract	Háttéradatok.
BackendCredentialsContract	A háttérrendszerhez való csatlakozáshoz használt hitelesítő adatok részletei.
BackendPoolItem	Háttérkészlet szolgáltatásinformációi
BackendProperties	A háttértípusra jellemző tulajdonságok.
BackendProtocol	Háttérkommunikációs protokoll.
BackendProxyContract	A háttérrendszerbeli WebProxy-kiszolgáló részletei, amelyet a Háttéralkalmazás kérése szolgáltatásban kell használni.
BackendServiceFabricClusterProperties	A Service Fabric típusú háttérrendszer tulajdonságai.
BackendTlsProperties	TLS-tanúsítványérvényesítést vezérlő tulajdonságok.
BackendType	A háttérrendszer típusa. A háttérrendszer lehet önálló vagy készlet.
BackendUpdateParameters	Háttérfrissítési paraméterek.
CircuitBreakerFailureCondition	Az áramkör-megszakító utazási feltételei
CircuitBreakerRule	Szabálykonfiguráció a háttérrendszer kijárásához.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
FailureStatusCodeRange	A hiba http-állapotkód-tartománya
Pool
X509CertificateName	Az X509Names kiszolgáló tulajdonságai.

BackendAuthorizationHeaderCredentials

Objektum

Az engedélyezési fejléc adatai.

Name	Típus	Description
parameter	string minLength: 1 maxLength: 300	Hitelesítési paraméter értéke.
scheme	string minLength: 1 maxLength: 100	Hitelesítési séma neve.

BackendCircuitBreaker

Objektum

A háttér-kapcsolatcsoport-megszakító konfigurálása

Name	Típus	Description
rules	CircuitBreakerRule[]	A háttérrendszer bemásolásának szabályai.

BackendContract

Objektum

Háttéradatok.

Name	Típus	Description
id	string	Az erőforrás teljes erőforrás-azonosítója. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Az erőforrás neve
properties.circuitBreaker	BackendCircuitBreaker	Háttér áramkör-megszakító konfigurációja
properties.credentials	BackendCredentialsContract	Háttérbeli hitelesítő adatok szerződésének tulajdonságai
properties.description	string minLength: 1 maxLength: 2000	Háttér leírása.
properties.pool	Pool
properties.properties	BackendProperties	Háttértulajdonságok szerződése
properties.protocol	BackendProtocol	Háttérkommunikációs protokoll.
properties.proxy	BackendProxyContract	Háttérátjáró szerződésének tulajdonságai
properties.resourceId	string minLength: 1 maxLength: 2000	Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Function Apps vagy az API Apps arm erőforrás-azonosítója.
properties.title	string minLength: 1 maxLength: 300	Háttércím.
properties.tls	BackendTlsProperties	Háttérbeli TLS-tulajdonságok
properties.type	BackendType	A háttérrendszer típusa. A háttérrendszer lehet önálló vagy készlet.
properties.url	string minLength: 1 maxLength: 2000	A háttérrendszer futtatókörnyezeti URL-címe.
type	string	Az erőforrás típusa. Pl. "Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Objektum

A háttérrendszerhez való csatlakozáshoz használt hitelesítő adatok részletei.

Name	Típus	Description
authorization	BackendAuthorizationHeaderCredentials	Engedélyezési fejléc hitelesítése
certificate	string[]	Az ügyféltanúsítvány ujjlenyomatainak listája. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva.
certificateIds	string[]	Ügyféltanúsítvány-azonosítók listája.
header	object	Fejlécparaméter leírása.
query	object	Lekérdezési paraméter leírása.

BackendPoolItem

Objektum

Háttérkészlet szolgáltatásinformációi

Name	Típus	Description
id	string (arm-id)	A háttérentitás egyedi ARM-azonosítója. Az ARM-azonosítónak egy már meglévő háttérentitásra kell hivatkoznia.
priority	integer (int32) minimum: 0 maximum: 100	A háttérentitás prioritása a háttérkészletben. 0 és 100 között kell lennie. Null értékű is lehet, ha az érték nincs megadva.
weight	integer (int32) minimum: 0 maximum: 100	A háttérbeli entitás súlya a háttérkészletben. 0 és 100 között kell lennie. Null értékű is lehet, ha az érték nincs megadva.

BackendProperties

Objektum

A háttértípusra jellemző tulajdonságok.

Name	Típus	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	HáttérSzolgáltatás-hálófürt tulajdonságai

BackendProtocol

Enumerálás

Háttérkommunikációs protokoll.

Érték	Description
http	A háttérrendszer egy RESTful szolgáltatás.
soap	A háttérrendszer egy SOAP szolgáltatás.

BackendProxyContract

Objektum

A háttérrendszerbeli WebProxy-kiszolgáló részletei, amelyet a Háttéralkalmazás kérése szolgáltatásban kell használni.

Name	Típus	Description
password	string	Jelszó a WebProxy-kiszolgálóhoz való csatlakozáshoz
url	string minLength: 1 maxLength: 2000	WebProxy Server AbsoluteUri tulajdonság, amely az Uri-példányban tárolt teljes URI-t tartalmazza, beleértve az összes töredéket és lekérdezési sztringet.
username	string	Felhasználónév a WebProxy-kiszolgálóhoz való csatlakozáshoz

BackendServiceFabricClusterProperties

Objektum

A Service Fabric típusú háttérrendszer tulajdonságai.

Name	Típus	Description
clientCertificateId	string	A felügyeleti végpont ügyféltanúsítvány-azonosítója.
clientCertificatethumbprint	string	A felügyeleti végpont ügyféltanúsítványának ujjlenyomata. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva
managementEndpoints	string[]	A fürtkezelési végpont.
maxPartitionResolutionRetries	integer (int32)	A partíció feloldása során az újrapróbálkozási kísérletek maximális száma.
serverCertificateThumbprints	string[]	Tanúsítványok fürtfelügyeleti szolgáltatásának ujjlenyomatai tls-kommunikációhoz
serverX509Names	X509CertificateName[]	Kiszolgáló X509 tanúsítványnévgyűjteménye

BackendTlsProperties

Objektum

TLS-tanúsítványérvényesítést vezérlő tulajdonságok.

Name	Típus	Alapértelmezett érték	Description
validateCertificateChain	boolean	True	Jelző, amely jelzi, hogy az SSL-tanúsítványlánc érvényesítését el kell-e végezni, ha önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez.
validateCertificateName	boolean	True	Jelző, amely jelzi, hogy az SSL-tanúsítvány nevének érvényesítése akkor történjen-e meg, ha önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez.

BackendType

Enumerálás

A háttérrendszer típusa. A háttérrendszer lehet önálló vagy készlet.

Érték	Description
Pool	támogatja a készlet háttérrendszerét
Single	támogatja az önálló háttérrendszert

BackendUpdateParameters

Objektum

Háttérfrissítési paraméterek.

Name	Típus	Description
properties.circuitBreaker	BackendCircuitBreaker	Háttér áramkör-megszakító konfigurációja
properties.credentials	BackendCredentialsContract	Háttérbeli hitelesítő adatok szerződésének tulajdonságai
properties.description	string minLength: 1 maxLength: 2000	Háttér leírása.
properties.pool	Pool
properties.properties	BackendProperties	Háttértulajdonságok szerződése
properties.protocol	BackendProtocol	Háttérkommunikációs protokoll.
properties.proxy	BackendProxyContract	Háttérátjáró szerződésének tulajdonságai
properties.resourceId	string minLength: 1 maxLength: 2000	Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Function Apps vagy az API Apps arm erőforrás-azonosítója.
properties.title	string minLength: 1 maxLength: 300	Háttércím.
properties.tls	BackendTlsProperties	Háttérbeli TLS-tulajdonságok
properties.type	BackendType	A háttérrendszer típusa. A háttérrendszer lehet önálló vagy készlet.
properties.url	string minLength: 1 maxLength: 2000	A háttérrendszer futtatókörnyezeti URL-címe.

CircuitBreakerFailureCondition

Objektum

Az áramkör-megszakító utazási feltételei

Name	Típus	Description
count	integer (int64)	A kapcsolatcsoport megnyitásának küszöbértéke.
errorReasons	string[] maxLength: 200	A hiba okai, amelyek hibának minősülnek.
interval	string (duration)	A hibák számbavételének időköze.
percentage	integer (int64)	A kapcsolatcsoport megnyitásának küszöbértéke.
statusCodeRanges	FailureStatusCodeRange[]	A sikertelennek ítélt állapotkódtartományok.

CircuitBreakerRule

Objektum

Szabálykonfiguráció a háttérrendszer kijárásához.

Name	Típus	Description
acceptRetryAfter	boolean	jelölőt a háttérrendszerből Retry-After fejléc elfogadásához.
failureCondition	CircuitBreakerFailureCondition	Az áramkör-megszakító becsatolásának feltételei.
name	string	A szabály neve.
tripDuration	string (duration)	A kapcsolatcsoport megbotlásához szükséges időtartam.

ErrorAdditionalInfo

Objektum

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

Objektum

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Objektum

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

FailureStatusCodeRange

Objektum

A hiba http-állapotkód-tartománya

Name	Típus	Description
max	integer (int32) minimum: 200 maximum: 599	A http-állapotkód maximális száma.
min	integer (int32) minimum: 200 maximum: 599	A minimális HTTP-állapotkód.

Pool

Objektum

Name	Típus	Description
services	BackendPoolItem[]	A készlethez tartozó háttérentitások listája.

X509CertificateName

Objektum

Az X509Names kiszolgáló tulajdonságai.

Name	Típus	Description
issuerCertificateThumbprint	string	A tanúsítvány kiállítójának ujjlenyomata.
name	string	A tanúsítvány köznapi neve.

Megosztás a következőn keresztül:

Backend - Update

URI-paraméterek

Kérelem fejléce

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

ApiManagementUpdateBackend

Mintakérelem

Mintaválasz

Definíciók

BackendAuthorizationHeaderCredentials

BackendCircuitBreaker

BackendContract

BackendCredentialsContract

BackendPoolItem

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

BackendType

BackendUpdateParameters

CircuitBreakerFailureCondition

CircuitBreakerRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailureStatusCodeRange

Pool

X509CertificateName

További források