Backend - Update

Reference

Služba:: API Management

Verze rozhraní API:: 2024-05-01

Aktualizuje existující back-end.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
backendId	path	True	string minLength: 1 maxLength: 80	Identifikátor entity back-endu. V aktuální instanci služby API Management musí být jedinečné.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Název služby API Management.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
If-Match	True	string	ETag of the Entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET, nebo by měla být * pro nepodmíněnou aktualizaci.

Text požadavku

Name	Typ	Description
properties.circuitBreaker	BackendCircuitBreaker	Konfigurace jističe back-endu
properties.credentials	BackendCredentialsContract	Vlastnosti kontraktu přihlašovacích údajů back-endu
properties.description	string minLength: 1 maxLength: 2000	Popis back-endu
properties.pool	Pool
properties.properties	BackendProperties	Kontrakt vlastností back-endu
properties.protocol	BackendProtocol	Komunikační protokol back-endu.
properties.proxy	BackendProxyContract	Vlastnosti kontraktu back-endové brány
properties.resourceId	string minLength: 1 maxLength: 2000	Identifikátor URI správy prostředku v externím systému Tato adresa URL může být ID prostředku Arm pro Logic Apps, Function Apps nebo API Apps.
properties.title	string minLength: 1 maxLength: 300	Název back-endu
properties.tls	BackendTlsProperties	Vlastnosti protokolu TLS back-endu
properties.type	BackendType	Typ back-endu Back-end může být jeden nebo fond.
properties.url	string minLength: 1 maxLength: 2000	Adresa URL modulu runtime back-endu

Odpovědi

Name	Typ	Description
200 OK	BackendContract	Stávající back-end byl úspěšně aktualizován. Hlavičky ETag: string
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Name

Typ

Description

200 OK

BackendContract

Stávající back-end byl úspěšně aktualizován.

Hlavičky

ETag: string

Other Status Codes

ErrorResponse

Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementUpdateBackend

Ukázkový požadavek

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

Ukázková odpověď

Stavový kó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
    }
  }
}

Definice

Name	Description
BackendAuthorizationHeaderCredentials	Informace o autorizační hlavičce
BackendCircuitBreaker	Konfigurace jističe back-endu
BackendContract	Podrobnosti o back-endu
BackendCredentialsContract	Podrobnosti o přihlašovacích údajích použitých k připojení k back-endu
BackendPoolItem	Informace o službě back-endových fondů
BackendProperties	Vlastnosti specifické pro typ back-endu
BackendProtocol	Komunikační protokol back-endu.
BackendProxyContract	Podrobnosti o serveru Back-end WebProxy, který se má použít v požadavku na back-end.
BackendServiceFabricClusterProperties	Vlastnosti back-endu typu Service Fabric
BackendTlsProperties	Vlastnosti, které řídí ověřování certifikátu TLS
BackendType	Typ back-endu Back-end může být jeden nebo fond.
BackendUpdateParameters	Parametry aktualizace back-endu
CircuitBreakerFailureCondition	Podmínky jízdy jističe
CircuitBreakerRule	Konfigurace pravidla pro cestu k back-endu
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
FailureStatusCodeRange	Rozsah stavového kódu HTTP selhání
Pool
X509CertificateName	Vlastnosti serveru X509Names

BackendAuthorizationHeaderCredentials

Objekt

Informace o autorizační hlavičce

Name	Typ	Description
parameter	string minLength: 1 maxLength: 300	Hodnota parametru ověřování
scheme	string minLength: 1 maxLength: 100	Název schématu ověřování

BackendCircuitBreaker

Objekt

Konfigurace jističe back-endu

Name	Typ	Description
rules	CircuitBreakerRule[]	Pravidla pro výlet do back-endu.

BackendContract

Objekt

Podrobnosti o back-endu

Name	Typ	Description
id	string	Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Název prostředku
properties.circuitBreaker	BackendCircuitBreaker	Konfigurace jističe back-endu
properties.credentials	BackendCredentialsContract	Vlastnosti kontraktu přihlašovacích údajů back-endu
properties.description	string minLength: 1 maxLength: 2000	Popis back-endu
properties.pool	Pool
properties.properties	BackendProperties	Kontrakt vlastností back-endu
properties.protocol	BackendProtocol	Komunikační protokol back-endu.
properties.proxy	BackendProxyContract	Vlastnosti kontraktu back-endové brány
properties.resourceId	string minLength: 1 maxLength: 2000	Identifikátor URI správy prostředku v externím systému Tato adresa URL může být ID prostředku Arm pro Logic Apps, Function Apps nebo API Apps.
properties.title	string minLength: 1 maxLength: 300	Název back-endu
properties.tls	BackendTlsProperties	Vlastnosti protokolu TLS back-endu
properties.type	BackendType	Typ back-endu Back-end může být jeden nebo fond.
properties.url	string minLength: 1 maxLength: 2000	Adresa URL modulu runtime back-endu
type	string	Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

BackendCredentialsContract

Objekt

Podrobnosti o přihlašovacích údajích použitých k připojení k back-endu

Name	Typ	Description
authorization	BackendAuthorizationHeaderCredentials	Ověřování autorizační hlavičky
certificate	string[]	Seznam kryptografických otisků klientského certifikátu Pokud jsou zadané id certifikátů, bude ignorováno.
certificateIds	string[]	Seznam ID klientských certifikátů
header	object	Popis parametru hlavičky
query	object	Popis parametru dotazu

BackendPoolItem

Objekt

Informace o službě back-endových fondů

Name	Typ	Description
id	string (arm-id)	Jedinečné ID ARM entity back-endu. ID ARM by mělo odkazovat na již existující back-endovou entitu.
priority	integer (int32) minimum: 0 maximum: 100	Priorita entity back-endu v back-endovém fondu Musí být v rozmezí od 0 do 100. Může mít také hodnotu null, pokud není zadaná hodnota.
weight	integer (int32) minimum: 0 maximum: 100	Váha entity back-endu v back-endovém fondu. Musí být v rozmezí od 0 do 100. Může mít také hodnotu null, pokud není zadaná hodnota.

BackendProperties

Objekt

Vlastnosti specifické pro typ back-endu

Name	Typ	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Vlastnosti clusteru Service Fabric back-endu

BackendProtocol

Výčet

Komunikační protokol back-endu.

Hodnota	Description
http	Back-end je služba RESTful.
soap	Back-end je služba SOAP.

BackendProxyContract

Objekt

Podrobnosti o serveru Back-end WebProxy, který se má použít v požadavku na back-end.

Name	Typ	Description
password	string	Heslo pro připojení k serveru WebProxy
url	string minLength: 1 maxLength: 2000	Vlastnost WebProxy Server AbsoluteUri, která zahrnuje celý identifikátor URI uložený v instanci Uri, včetně všech fragmentů a řetězců dotazů.
username	string	Uživatelské jméno pro připojení k serveru WebProxy

BackendServiceFabricClusterProperties

Objekt

Vlastnosti back-endu typu Service Fabric

Name	Typ	Description
clientCertificateId	string	ID klientského certifikátu pro koncový bod správy.
clientCertificatethumbprint	string	Kryptografický otisk klientského certifikátu pro koncový bod správy. Pokud jsou zadané id certifikátů, bude ignorováno.
managementEndpoints	string[]	Koncový bod správy clusteru.
maxPartitionResolutionRetries	integer (int32)	Maximální počet opakování při pokusu o vyřešení oddílu
serverCertificateThumbprints	string[]	Kryptografické otisky služby pro správu clusteru certifikátů používají pro komunikaci tls
serverX509Names	X509CertificateName[]	Kolekce názvů certifikátů X509 serveru

BackendTlsProperties

Objekt

Vlastnosti, které řídí ověřování certifikátu TLS

Name	Typ	Default value	Description
validateCertificateChain	boolean	True	Příznak označující, jestli se má ověření řetězu certifikátů SSL provést při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele.
validateCertificateName	boolean	True	Příznak označující, jestli se má ověření názvu certifikátu SSL provést při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele.

BackendType

Výčet

Typ back-endu Back-end může být jeden nebo fond.

Hodnota	Description
Pool	podporuje back-end fondu.
Single	podporuje jeden back-end.

BackendUpdateParameters

Objekt

Parametry aktualizace back-endu

Name	Typ	Description
properties.circuitBreaker	BackendCircuitBreaker	Konfigurace jističe back-endu
properties.credentials	BackendCredentialsContract	Vlastnosti kontraktu přihlašovacích údajů back-endu
properties.description	string minLength: 1 maxLength: 2000	Popis back-endu
properties.pool	Pool
properties.properties	BackendProperties	Kontrakt vlastností back-endu
properties.protocol	BackendProtocol	Komunikační protokol back-endu.
properties.proxy	BackendProxyContract	Vlastnosti kontraktu back-endové brány
properties.resourceId	string minLength: 1 maxLength: 2000	Identifikátor URI správy prostředku v externím systému Tato adresa URL může být ID prostředku Arm pro Logic Apps, Function Apps nebo API Apps.
properties.title	string minLength: 1 maxLength: 300	Název back-endu
properties.tls	BackendTlsProperties	Vlastnosti protokolu TLS back-endu
properties.type	BackendType	Typ back-endu Back-end může být jeden nebo fond.
properties.url	string minLength: 1 maxLength: 2000	Adresa URL modulu runtime back-endu

CircuitBreakerFailureCondition

Objekt

Podmínky jízdy jističe

Name	Typ	Description
count	integer (int64)	Prahová hodnota pro otevření okruhu.
errorReasons	string[] maxLength: 200	Důvody chyby, které jsou považovány za selhání.
interval	string (duration)	Interval, během kterého se počítají chyby.
percentage	integer (int64)	Prahová hodnota pro otevření okruhu.
statusCodeRanges	FailureStatusCodeRange[]	Rozsahy stavového kódu, které jsou považovány za selhání.

CircuitBreakerRule

Objekt

Konfigurace pravidla pro cestu k back-endu

Name	Typ	Description
acceptRetryAfter	boolean	příznak pro přijetí hlavičky Retry-After z back-endu.
failureCondition	CircuitBreakerFailureCondition	Podmínky pro jízdu jističe.
name	string	Název pravidla.
tripDuration	string (duration)	Doba trvání, po kterou bude okruh zahozen.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

FailureStatusCodeRange

Objekt

Rozsah stavového kódu HTTP selhání

Name	Typ	Description
max	integer (int32) minimum: 200 maximum: 599	Maximální stavový kód HTTP.
min	integer (int32) minimum: 200 maximum: 599	Minimální stavový kód HTTP.

Pool

Objekt

Name	Typ	Description
services	BackendPoolItem[]	Seznam back-endových entit patřících do fondu

X509CertificateName

Objekt

Vlastnosti serveru X509Names

Name	Typ	Description
issuerCertificateThumbprint	string	Kryptografický otisk pro vystavitele certifikátu
name	string	Běžný název certifikátu

Sdílet prostřednictvím

Backend - Update

Parametry identifikátoru URI

Hlavička požadavku

Text požadavku

Odpovědi

Zabezpečení

azure_auth

Rozsahy

Příklady

ApiManagementUpdateBackend

Ukázkový požadavek

Ukázková odpověď

Definice

BackendAuthorizationHeaderCredentials

BackendCircuitBreaker

BackendContract

BackendCredentialsContract

BackendPoolItem

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

BackendType

BackendUpdateParameters

CircuitBreakerFailureCondition

CircuitBreakerRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailureStatusCodeRange

Pool

X509CertificateName

Další materiály