Backend - Update

Odwołanie

Usługa:: API Management

Wersja interfejsu API:: 2024-05-01

Aktualizuje istniejące zaplecze.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
backendId	path	True	string minLength: 1 maxLength: 80	Identyfikator jednostki zaplecza. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa usługi API Management.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
If-Match	True	string	Element ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * dla bezwarunkowej aktualizacji.

Treść żądania

Nazwa	Typ	Opis
properties.circuitBreaker	BackendCircuitBreaker	Konfiguracja wyłącznika zaplecza
properties.credentials	BackendCredentialsContract	Właściwości kontraktu poświadczeń zaplecza
properties.description	string minLength: 1 maxLength: 2000	Opis zaplecza.
properties.pool	Pool
properties.properties	BackendProperties	Kontrakt właściwości zaplecza
properties.protocol	BackendProtocol	Protokół komunikacyjny zaplecza.
properties.proxy	BackendProxyContract	Właściwości kontraktu bramy zaplecza
properties.resourceId	string minLength: 1 maxLength: 2000	Identyfikator URI zarządzania zasobu w systemie zewnętrznym. Ten adres URL może być identyfikatorem zasobu arm usługi Logic Apps, aplikacji funkcji lub aplikacji interfejsu API.
properties.title	string minLength: 1 maxLength: 300	Tytuł zaplecza.
properties.tls	BackendTlsProperties	Właściwości protokołu TLS zaplecza
properties.type	BackendType	Typ zaplecza. Zaplecze może mieć wartość pojedynczą lub pulę.
properties.url	string minLength: 1 maxLength: 2000	Adres URL środowiska uruchomieniowego zaplecza.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	BackendContract	Istniejące zaplecze zostało pomyślnie zaktualizowane. Nagłówki ETag: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

BackendContract

Istniejące zaplecze zostało pomyślnie zaktualizowane.

Nagłówki

ETag: string

Other Status Codes

ErrorResponse

Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementUpdateBackend

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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
    }
  }
}

Definicje

Nazwa	Opis
BackendAuthorizationHeaderCredentials	Informacje nagłówka autoryzacji.
BackendCircuitBreaker	Konfiguracja wyłącznika zaplecza
BackendContract	Szczegóły zaplecza.
BackendCredentialsContract	Szczegóły poświadczeń używanych do nawiązywania połączenia z zapleczem.
BackendPoolItem	Informacje o usłudze puli zaplecza
BackendProperties	Właściwości specyficzne dla typu zaplecza.
BackendProtocol	Protokół komunikacyjny zaplecza.
BackendProxyContract	Szczegóły serwera WebProxy zaplecza do użycia w żądaniu do zaplecza.
BackendServiceFabricClusterProperties	Właściwości zaplecza typu usługi Service Fabric.
BackendTlsProperties	Właściwości kontrolujące weryfikację certyfikatu TLS.
BackendType	Typ zaplecza. Zaplecze może mieć wartość pojedynczą lub pulę.
BackendUpdateParameters	Parametry aktualizacji zaplecza.
CircuitBreakerFailureCondition	Warunki pracy wyłącznika
CircuitBreakerRule	Konfiguracja reguły w celu podróży zaplecza.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
FailureStatusCodeRange	Zakres kodu stanu http błędu
Pool
X509CertificateName	Właściwości serwera X509Names.

BackendAuthorizationHeaderCredentials

Objekt

Informacje nagłówka autoryzacji.

Nazwa	Typ	Opis
parameter	string minLength: 1 maxLength: 300	Wartość parametru uwierzytelniania.
scheme	string minLength: 1 maxLength: 100	Nazwa schematu uwierzytelniania.

BackendCircuitBreaker

Objekt

Konfiguracja wyłącznika zaplecza

Nazwa	Typ	Opis
rules	CircuitBreakerRule[]	Reguły potknięcia zaplecza.

BackendContract

Objekt

Szczegóły zaplecza.

Nazwa	Typ	Opis
id	string	W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nazwa zasobu
properties.circuitBreaker	BackendCircuitBreaker	Konfiguracja wyłącznika zaplecza
properties.credentials	BackendCredentialsContract	Właściwości kontraktu poświadczeń zaplecza
properties.description	string minLength: 1 maxLength: 2000	Opis zaplecza.
properties.pool	Pool
properties.properties	BackendProperties	Kontrakt właściwości zaplecza
properties.protocol	BackendProtocol	Protokół komunikacyjny zaplecza.
properties.proxy	BackendProxyContract	Właściwości kontraktu bramy zaplecza
properties.resourceId	string minLength: 1 maxLength: 2000	Identyfikator URI zarządzania zasobu w systemie zewnętrznym. Ten adres URL może być identyfikatorem zasobu arm usługi Logic Apps, aplikacji funkcji lub aplikacji interfejsu API.
properties.title	string minLength: 1 maxLength: 300	Tytuł zaplecza.
properties.tls	BackendTlsProperties	Właściwości protokołu TLS zaplecza
properties.type	BackendType	Typ zaplecza. Zaplecze może mieć wartość pojedynczą lub pulę.
properties.url	string minLength: 1 maxLength: 2000	Adres URL środowiska uruchomieniowego zaplecza.
type	string	Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Objekt

Szczegóły poświadczeń używanych do nawiązywania połączenia z zapleczem.

Nazwa	Typ	Opis
authorization	BackendAuthorizationHeaderCredentials	Uwierzytelnianie nagłówka autoryzacji
certificate	string[]	Lista odcisków palca certyfikatu klienta. Jeśli podano identyfikatory certyfikatów, zostaną zignorowane.
certificateIds	string[]	Lista identyfikatorów certyfikatów klienta.
header	object	Opis parametru nagłówka.
query	object	Opis parametru zapytania.

BackendPoolItem

Objekt

Informacje o usłudze puli zaplecza

Nazwa	Typ	Opis
id	string (arm-id)	Unikatowy identyfikator arm jednostki zaplecza. Identyfikator usługi ARM powinien odwoływać się do istniejącej jednostki zaplecza.
priority	integer (int32) minimum: 0 maximum: 100	Priorytet jednostki zaplecza w puli zaplecza. Musi należeć do zakresu od 0 do 100. Może to być również wartość null, jeśli wartość nie została określona.
weight	integer (int32) minimum: 0 maximum: 100	Waga jednostki zaplecza w puli zaplecza. Musi należeć do zakresu od 0 do 100. Może to być również wartość null, jeśli wartość nie została określona.

BackendProperties

Objekt

Właściwości specyficzne dla typu zaplecza.

Nazwa	Typ	Opis
serviceFabricCluster	BackendServiceFabricClusterProperties	Właściwości klastra usługi Service Fabric zaplecza

BackendProtocol

Wyliczanie

Protokół komunikacyjny zaplecza.

Wartość	Opis
http	Zaplecze jest usługą RESTful.
soap	Zaplecze jest usługą SOAP.

BackendProxyContract

Objekt

Szczegóły serwera WebProxy zaplecza do użycia w żądaniu do zaplecza.

Nazwa	Typ	Opis
password	string	Hasło do nawiązania połączenia z serwerem WebProxy
url	string minLength: 1 maxLength: 2000	Właściwość AbsoluteUri serwera WebProxy, która zawiera cały identyfikator URI przechowywany w wystąpieniu identyfikatora Uri, w tym wszystkie fragmenty i ciągi zapytania.
username	string	Nazwa użytkownika do nawiązania połączenia z serwerem WebProxy

BackendServiceFabricClusterProperties

Objekt

Właściwości zaplecza typu usługi Service Fabric.

Nazwa	Typ	Opis
clientCertificateId	string	Identyfikator certyfikatu klienta dla punktu końcowego zarządzania.
clientCertificatethumbprint	string	Odcisk palca certyfikatu klienta dla punktu końcowego zarządzania. Jeśli podano identyfikatory certyfikatów, zostaną zignorowane
managementEndpoints	string[]	Punkt końcowy zarządzania klastrem.
maxPartitionResolutionRetries	integer (int32)	Maksymalna liczba ponownych prób podczas próby rozwiązania partycji.
serverCertificateThumbprints	string[]	Odciski palca usługi zarządzania klastrem certyfikatów używane do komunikacji tls
serverX509Names	X509CertificateName[]	Kolekcja nazw certyfikatów X509 serwera

BackendTlsProperties

Objekt

Właściwości kontrolujące weryfikację certyfikatu TLS.

Nazwa	Typ	Domyślna wartość	Opis
validateCertificateChain	boolean	True	Flaga wskazująca, czy podczas korzystania z certyfikatów z podpisem własnym dla tego hosta zaplecza należy przeprowadzić walidację łańcucha certyfikatów SSL.
validateCertificateName	boolean	True	Flaga wskazująca, czy podczas korzystania z certyfikatów z podpisem własnym dla tego hosta zaplecza należy przeprowadzić walidację nazwy certyfikatu SSL.

BackendType

Wyliczanie

Typ zaplecza. Zaplecze może mieć wartość pojedynczą lub pulę.

Wartość	Opis
Pool	obsługuje zaplecze puli
Single	obsługuje pojedyncze zaplecze

BackendUpdateParameters

Objekt

Parametry aktualizacji zaplecza.

Nazwa	Typ	Opis
properties.circuitBreaker	BackendCircuitBreaker	Konfiguracja wyłącznika zaplecza
properties.credentials	BackendCredentialsContract	Właściwości kontraktu poświadczeń zaplecza
properties.description	string minLength: 1 maxLength: 2000	Opis zaplecza.
properties.pool	Pool
properties.properties	BackendProperties	Kontrakt właściwości zaplecza
properties.protocol	BackendProtocol	Protokół komunikacyjny zaplecza.
properties.proxy	BackendProxyContract	Właściwości kontraktu bramy zaplecza
properties.resourceId	string minLength: 1 maxLength: 2000	Identyfikator URI zarządzania zasobu w systemie zewnętrznym. Ten adres URL może być identyfikatorem zasobu arm usługi Logic Apps, aplikacji funkcji lub aplikacji interfejsu API.
properties.title	string minLength: 1 maxLength: 300	Tytuł zaplecza.
properties.tls	BackendTlsProperties	Właściwości protokołu TLS zaplecza
properties.type	BackendType	Typ zaplecza. Zaplecze może mieć wartość pojedynczą lub pulę.
properties.url	string minLength: 1 maxLength: 2000	Adres URL środowiska uruchomieniowego zaplecza.

CircuitBreakerFailureCondition

Objekt

Warunki pracy wyłącznika

Nazwa	Typ	Opis
count	integer (int64)	Próg otwarcia obwodu.
errorReasons	string[] maxLength: 200	Przyczyny błędu, które są uważane za niepowodzenie.
interval	string (duration)	Interwał, w którym są liczone błędy.
percentage	integer (int64)	Próg otwarcia obwodu.
statusCodeRanges	FailureStatusCodeRange[]	Zakresy kodów stanu, które są uznawane za błędy.

CircuitBreakerRule

Objekt

Konfiguracja reguły w celu podróży zaplecza.

Nazwa	Typ	Opis
acceptRetryAfter	boolean	flaga akceptowania nagłówka Retry-After z zaplecza.
failureCondition	CircuitBreakerFailureCondition	Warunki potknięcia wyłącznika.
name	string	Nazwa reguły.
tripDuration	string (duration)	Czas trwania, przez który obwód zostanie potknięty.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

FailureStatusCodeRange

Objekt

Zakres kodu stanu http błędu

Nazwa	Typ	Opis
max	integer (int32) minimum: 200 maximum: 599	Maksymalny kod stanu http.
min	integer (int32) minimum: 200 maximum: 599	Minimalny kod stanu http.

Pool

Objekt

Nazwa	Typ	Opis
services	BackendPoolItem[]	Lista jednostek zaplecza należących do puli.

X509CertificateName

Objekt

Właściwości serwera X509Names.

Nazwa	Typ	Opis
issuerCertificateThumbprint	string	Odcisk palca wystawcy certyfikatu.
name	string	Nazwa pospolita certyfikatu.

Udostępnij za pośrednictwem

Backend - Update

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

ApiManagementUpdateBackend

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

BackendAuthorizationHeaderCredentials

BackendCircuitBreaker

BackendContract

BackendCredentialsContract

BackendPoolItem

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

BackendType

BackendUpdateParameters

CircuitBreakerFailureCondition

CircuitBreakerRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailureStatusCodeRange

Pool

X509CertificateName

Dodatkowe zasoby