Backend - Update

Referens

Tjänst:: API Management

API-version:: 2024-05-01

Uppdaterar en befintlig serverdel.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
backendId	path	True	string minLength: 1 maxLength: 80	Identifierare för serverdelsentiteten. Måste vara unikt i den aktuella API Management-tjänstinstansen.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Namnet på resursgruppen. Namnet är skiftlägesokänsligt.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Namnet på API Management-tjänsten.
subscriptionId	path	True	string (uuid)	ID för målprenumerationen. Värdet måste vara ett UUID.
api-version	query	True	string minLength: 1	DEN API-version som ska användas för den här åtgärden.

Begärandehuvud

Name	Obligatorisk	Typ	Description
If-Match	True	string	ETag för entiteten. ETag ska matcha det aktuella entitetstillståndet från huvudsvaret för GET-begäran, eller så bör det vara * för ovillkorlig uppdatering.

Begärandetext

Name	Typ	Description
properties.circuitBreaker	BackendCircuitBreaker	Konfiguration av backend-kretsbrytare
properties.credentials	BackendCredentialsContract	Egenskaper för backend-autentiseringsuppgifter för kontrakt
properties.description	string minLength: 1 maxLength: 2000	Serverdelsbeskrivning.
properties.pool	Pool
properties.properties	BackendProperties	Kontrakt för serverdelsegenskaper
properties.protocol	BackendProtocol	Protokoll för serverdelskommunikation.
properties.proxy	BackendProxyContract	Egenskaper för serverdelsgatewaykontrakt
properties.resourceId	string minLength: 1 maxLength: 2000	Hanterings-URI för resursen i det externa systemet. Den här URL:en kan vara armresurs-ID för Logic Apps, Funktionsappar eller API-appar.
properties.title	string minLength: 1 maxLength: 300	Serverdelsrubrik.
properties.tls	BackendTlsProperties	Egenskaper för serverdels-TLS
properties.type	BackendType	Typ av serverdel. En serverdel kan vara antingen Enskild eller Pool.
properties.url	string minLength: 1 maxLength: 2000	Körnings-URL för serverdelen.

Svar

Name	Typ	Description
200 OK	BackendContract	Den befintliga serverdelen har uppdaterats. Sidhuvuden ETag: string
Other Status Codes	ErrorResponse	Felsvar som beskriver varför åtgärden misslyckades.

Name

Typ

Description

200 OK

BackendContract

Den befintliga serverdelen har uppdaterats.

Sidhuvuden

ETag: string

Other Status Codes

ErrorResponse

Felsvar som beskriver varför åtgärden misslyckades.

Säkerhet

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

Name	Description
user_impersonation	personifiera ditt användarkonto

Exempel

ApiManagementUpdateBackend

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name	Description
BackendAuthorizationHeaderCredentials	Information om auktoriseringshuvud.
BackendCircuitBreaker	Konfigurationen av backend-kretsbrytaren
BackendContract	Serverdelsinformation.
BackendCredentialsContract	Information om de autentiseringsuppgifter som används för att ansluta till serverdelen.
BackendPoolItem	Tjänstinformation för serverdelspool
BackendProperties	Egenskaper som är specifika för serverdelstypen.
BackendProtocol	Protokoll för serverdelskommunikation.
BackendProxyContract	Information om serverdelen WebProxy Server som ska användas i begäran till serverdelen.
BackendServiceFabricClusterProperties	Egenskaper för Service Fabric Type-serverdelen.
BackendTlsProperties	Egenskaper som styr TLS-certifikatverifiering.
BackendType	Typ av serverdel. En serverdel kan vara antingen Enskild eller Pool.
BackendUpdateParameters	Parametrar för serverdelsuppdatering.
CircuitBreakerFailureCondition	Kretsbrytarens färdförhållanden
CircuitBreakerRule	Regelkonfiguration för att snubbla serverdelen.
ErrorAdditionalInfo	Ytterligare information om resurshanteringsfelet.
ErrorDetail	Felinformationen.
ErrorResponse	Felsvar
FailureStatusCodeRange	Felkodintervallet http-status
Pool
X509CertificateName	Egenskaper för servern X509Names.

BackendAuthorizationHeaderCredentials

Objekt

Information om auktoriseringshuvud.

Name	Typ	Description
parameter	string minLength: 1 maxLength: 300	Autentiseringsparametervärde.
scheme	string minLength: 1 maxLength: 100	Namn på autentiseringsschema.

BackendCircuitBreaker

Objekt

Konfigurationen av backend-kretsbrytaren

Name	Typ	Description
rules	CircuitBreakerRule[]	Reglerna för att snubbla serverdelen.

BackendContract

Objekt

Serverdelsinformation.

Name	Typ	Description
id	string	Fullständigt kvalificerat resurs-ID för resursen. Ex – /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Namnet på resursen
properties.circuitBreaker	BackendCircuitBreaker	Konfiguration av backend-kretsbrytare
properties.credentials	BackendCredentialsContract	Egenskaper för backend-autentiseringsuppgifter för kontrakt
properties.description	string minLength: 1 maxLength: 2000	Serverdelsbeskrivning.
properties.pool	Pool
properties.properties	BackendProperties	Kontrakt för serverdelsegenskaper
properties.protocol	BackendProtocol	Protokoll för serverdelskommunikation.
properties.proxy	BackendProxyContract	Egenskaper för serverdelsgatewaykontrakt
properties.resourceId	string minLength: 1 maxLength: 2000	Hanterings-URI för resursen i det externa systemet. Den här URL:en kan vara armresurs-ID för Logic Apps, Funktionsappar eller API-appar.
properties.title	string minLength: 1 maxLength: 300	Serverdelsrubrik.
properties.tls	BackendTlsProperties	Egenskaper för serverdels-TLS
properties.type	BackendType	Typ av serverdel. En serverdel kan vara antingen Enskild eller Pool.
properties.url	string minLength: 1 maxLength: 2000	Körnings-URL för serverdelen.
type	string	Resurstypen. Till exempel "Microsoft.Compute/virtualMachines" eller "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Objekt

Information om de autentiseringsuppgifter som används för att ansluta till serverdelen.

Name	Typ	Description
authorization	BackendAuthorizationHeaderCredentials	Auktoriseringshuvudautentisering
certificate	string[]	Lista över tumavtryck för klientcertifikat. Ignoreras om certificatesIds tillhandahålls.
certificateIds	string[]	Lista över klientcertifikat-ID:t.
header	object	Beskrivning av rubrikparameter.
query	object	Beskrivning av frågeparameter.

BackendPoolItem

Objekt

Tjänstinformation för serverdelspool

Name	Typ	Description
id	string (arm-id)	Det unika ARM-ID:t för serverdelsentiteten. ARM-ID:t bör referera till en redan befintlig serverdelsentitet.
priority	integer (int32) minimum: 0 maximum: 100	Prioriteten för serverdelsentiteten i serverdelspoolen. Måste vara mellan 0 och 100. Det kan också vara null om värdet inte har angetts.
weight	integer (int32) minimum: 0 maximum: 100	Vikten för serverdelsentiteten i serverdelspoolen. Måste vara mellan 0 och 100. Det kan också vara null om värdet inte har angetts.

BackendProperties

Objekt

Egenskaper som är specifika för serverdelstypen.

Name	Typ	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Egenskaper för Serverdelens Service Fabric-kluster

BackendProtocol

Uppräkning

Protokoll för serverdelskommunikation.

Värde	Description
http	Serverdelen är en RESTful-tjänst.
soap	Serverdelen är en SOAP-tjänst.

BackendProxyContract

Objekt

Information om serverdelen WebProxy Server som ska användas i begäran till serverdelen.

Name	Typ	Description
password	string	Lösenord för att ansluta till WebProxy Server
url	string minLength: 1 maxLength: 2000	Egenskapen WebProxy Server AbsoluteUri som innehåller hela URI:n som lagras i URI-instansen, inklusive alla fragment och frågesträngar.
username	string	Användarnamn för att ansluta till WebProxy-servern

BackendServiceFabricClusterProperties

Objekt

Egenskaper för Service Fabric Type-serverdelen.

Name	Typ	Description
clientCertificateId	string	Klientcertifikat-ID för hanteringsslutpunkten.
clientCertificatethumbprint	string	Tumavtrycket för klientcertifikatet för hanteringsslutpunkten. Ignoreras om certificatesIds tillhandahålls
managementEndpoints	string[]	Slutpunkten för klusterhantering.
maxPartitionResolutionRetries	integer (int32)	Maximalt antal återförsök vid försök att lösa partitionen.
serverCertificateThumbprints	string[]	Tumavtryck för certifikatklusterhanteringstjänsten som används för tls-kommunikation
serverX509Names	X509CertificateName[]	Server X509-certifikatnamnsamling

BackendTlsProperties

Objekt

Egenskaper som styr TLS-certifikatverifiering.

Name	Typ	Standardvärde	Description
validateCertificateChain	boolean	True	Flagga som anger om validering av SSL-certifikatkedja ska göras när du använder självsignerade certifikat för den här serverdelsvärden.
validateCertificateName	boolean	True	Flagga som anger om SSL-certifikatets namnverifiering ska utföras när du använder självsignerade certifikat för den här serverdelsvärden.

BackendType

Uppräkning

Typ av serverdel. En serverdel kan vara antingen Enskild eller Pool.

Värde	Description
Pool	stöder serverdelen för poolen
Single	stöder enkel serverdel

BackendUpdateParameters

Objekt

Parametrar för serverdelsuppdatering.

Name	Typ	Description
properties.circuitBreaker	BackendCircuitBreaker	Konfiguration av backend-kretsbrytare
properties.credentials	BackendCredentialsContract	Egenskaper för backend-autentiseringsuppgifter för kontrakt
properties.description	string minLength: 1 maxLength: 2000	Serverdelsbeskrivning.
properties.pool	Pool
properties.properties	BackendProperties	Kontrakt för serverdelsegenskaper
properties.protocol	BackendProtocol	Protokoll för serverdelskommunikation.
properties.proxy	BackendProxyContract	Egenskaper för serverdelsgatewaykontrakt
properties.resourceId	string minLength: 1 maxLength: 2000	Hanterings-URI för resursen i det externa systemet. Den här URL:en kan vara armresurs-ID för Logic Apps, Funktionsappar eller API-appar.
properties.title	string minLength: 1 maxLength: 300	Serverdelsrubrik.
properties.tls	BackendTlsProperties	Egenskaper för serverdels-TLS
properties.type	BackendType	Typ av serverdel. En serverdel kan vara antingen Enskild eller Pool.
properties.url	string minLength: 1 maxLength: 2000	Körnings-URL för serverdelen.

CircuitBreakerFailureCondition

Objekt

Kretsbrytarens färdförhållanden

Name	Typ	Description
count	integer (int64)	Tröskelvärdet för att öppna kretsen.
errorReasons	string[] maxLength: 200	De felorsaker som anses vara fel.
interval	string (duration)	Det intervall under vilket felen räknas.
percentage	integer (int64)	Tröskelvärdet för att öppna kretsen.
statusCodeRanges	FailureStatusCodeRange[]	De statuskodintervall som betraktas som fel.

CircuitBreakerRule

Objekt

Regelkonfiguration för att snubbla serverdelen.

Name	Typ	Description
acceptRetryAfter	boolean	för att acceptera Retry-After rubrik från serverdelen.
failureCondition	CircuitBreakerFailureCondition	Förutsättningarna för att snubbla kretsbrytaren.
name	string	Regelnamnet.
tripDuration	string (duration)	Hur länge kretsen ska utlösas.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name	Typ	Description
info	object	Ytterligare information.
type	string	Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Ytterligare information om felet.
code	string	Felkoden.
details	ErrorDetail[]	Felinformationen.
message	string	Felmeddelandet.
target	string	Felmålet.

ErrorResponse

Objekt

Felsvar

Name	Typ	Description
error	ErrorDetail	Felobjektet.

FailureStatusCodeRange

Objekt

Felkodintervallet http-status

Name	Typ	Description
max	integer (int32) minimum: 200 maximum: 599	Maximal http-statuskod.
min	integer (int32) minimum: 200 maximum: 599	Minsta http-statuskod.

Pool

Objekt

Name	Typ	Description
services	BackendPoolItem[]	Listan över serverdelsentiteter som tillhör en pool.

X509CertificateName

Objekt

Egenskaper för servern X509Names.

Name	Typ	Description
issuerCertificateThumbprint	string	Tumavtryck för certifikatutfärdaren.
name	string	Certifikatets gemensamma namn.

Dela via

Backend - Update

URI-parametrar

Begärandehuvud

Begärandetext

Svar

Säkerhet

azure_auth

Omfattningar

Exempel

ApiManagementUpdateBackend

Exempelbegäran

Exempelsvar

Definitioner

BackendAuthorizationHeaderCredentials

BackendCircuitBreaker

BackendContract

BackendCredentialsContract

BackendPoolItem

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

BackendType

BackendUpdateParameters

CircuitBreakerFailureCondition

CircuitBreakerRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailureStatusCodeRange

Pool

X509CertificateName

Ytterligare resurser