Backend - Update

Service:: API Management

API-versie:: 2024-05-01

Hiermee werkt u een bestaande back-end bij.

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

URI-parameters

Name	In	Vereist	Type	Description
backendId	path	True	string minLength: 1 maxLength: 80	Id van de back-endentiteit. Moet uniek zijn in het huidige EXEMPLAAR van de API Management-service.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	De naam van de API Management-service.
subscriptionId	path	True	string (uuid)	De id van het doelabonnement. De waarde moet een UUID zijn.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Name	Vereist	Type	Description
If-Match	True	string	ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus van het headerantwoord van de GET-aanvraag of moet * zijn voor een onvoorwaardelijke update.

Aanvraagbody

Name	Type	Description
properties.circuitBreaker	BackendCircuitBreaker	Configuratie van back-endcircuitonderbreker
properties.credentials	BackendCredentialsContract	Contracteigenschappen voor back-endreferenties
properties.description	string minLength: 1 maxLength: 2000	Beschrijving van back-end.
properties.pool	Pool
properties.properties	BackendProperties	Contract voor back-endeigenschappen
properties.protocol	BackendProtocol	Protocol voor back-endcommunicatie. Vereist wanneer het backend-type 'Enkel' is.
properties.proxy	BackendProxyContract	Eigenschappen van back-endgatewaycontract
properties.resourceId	string minLength: 1 maxLength: 2000	Beheer-URI van de resource in extern systeem. Deze URL kan de Arm-resource-id van Logic Apps, Functie-apps of API-apps zijn.
properties.title	string minLength: 1 maxLength: 300	Back-endtitel.
properties.tls	BackendTlsProperties	TLS-eigenschappen voor back-end
properties.type	BackendType	Type van de back-end. Een back-end kan één of pool zijn.
properties.url	string minLength: 1 maxLength: 2000	Runtime-URL van de back-end. Vereist wanneer het backend-type 'Enkel' is.

Antwoorden

Name	Type	Description
200 OK	BackendContract	De bestaande back-end is bijgewerkt. Kopteksten ETag: string
Other Status Codes	ErrorResponse	Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Name

Type

Description

200 OK

BackendContract

De bestaande back-end is bijgewerkt.

Kopteksten

ETag: string

Other Status Codes

ErrorResponse

Foutreactie waarin wordt beschreven waarom de bewerking is mislukt.

Beveiliging

azure_auth

OAuth2-stroom voor Azure Active Directory.

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

Name	Description
user_impersonation	Uw gebruikersaccount imiteren

Voorbeelden

ApiManagementUpdateBackend

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
BackendAuthorizationHeaderCredentials	Informatie over autorisatieheader.
BackendCircuitBreaker	De configuratie van de back-endcircuitonderbreker
BackendContract	Details van de back-end.
BackendCredentialsContract	Details van de referenties die worden gebruikt om verbinding te maken met de back-end.
BackendPoolItem	Servicegegevens van back-endpool
BackendProperties	Eigenschappen die specifiek zijn voor het back-endtype.
BackendProtocol	Protocol voor back-endcommunicatie. Vereist wanneer het backend-type 'Enkel' is.
BackendProxyContract	Details van de back-endwebproxyserver die moet worden gebruikt in de aanvraag naar back-end.
BackendServiceFabricClusterProperties	Eigenschappen van de back-end van het Service Fabric-type.
BackendTlsProperties	Eigenschappen die tls-certificaatvalidatie beheren.
BackendType	Type van de back-end. Een back-end kan één of pool zijn.
BackendUpdateParameters	Parameters voor back-endupdates.
CircuitBreakerFailureCondition	De reisvoorwaarden van de circuitonderbreker
CircuitBreakerRule	Regelconfiguratie om naar de back-end te gaan.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
FailureStatusCodeRange	Het http-statuscodebereik van de fout
Pool
X509CertificateName	Eigenschappen van server X509Names.

BackendAuthorizationHeaderCredentials

Object

Informatie over autorisatieheader.

Name	Type	Description
parameter	string minLength: 1 maxLength: 300	Waarde van verificatieparameter.
scheme	string minLength: 1 maxLength: 100	Naam van verificatieschema.

BackendCircuitBreaker

Object

De configuratie van de back-endcircuitonderbreker

Name	Type	Description
rules	CircuitBreakerRule[]	De regels voor het trippen van de back-end.

BackendContract

Object

Details van de back-end.

Name	Type	Description
id	string	Volledig gekwalificeerde resource-id voor de resource. Vb.: - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	De naam van de resource
properties.circuitBreaker	BackendCircuitBreaker	Configuratie van back-endcircuitonderbreker
properties.credentials	BackendCredentialsContract	Contracteigenschappen voor back-endreferenties
properties.description	string minLength: 1 maxLength: 2000	Beschrijving van back-end.
properties.pool	Pool
properties.properties	BackendProperties	Contract voor back-endeigenschappen
properties.protocol	BackendProtocol	Protocol voor back-endcommunicatie. Vereist wanneer het backend-type 'Enkel' is.
properties.proxy	BackendProxyContract	Eigenschappen van back-endgatewaycontract
properties.resourceId	string minLength: 1 maxLength: 2000	Beheer-URI van de resource in extern systeem. Deze URL kan de Arm-resource-id van Logic Apps, Functie-apps of API-apps zijn.
properties.title	string minLength: 1 maxLength: 300	Back-endtitel.
properties.tls	BackendTlsProperties	TLS-eigenschappen voor back-end
properties.type	BackendType	Type van de back-end. Een back-end kan één of pool zijn.
properties.url	string minLength: 1 maxLength: 2000	Runtime-URL van de back-end. Vereist wanneer het backend-type 'Enkel' is.
type	string	Het type resource. Bijvoorbeeld 'Microsoft.Compute/virtualMachines' of 'Microsoft.Storage/storageAccounts'

BackendCredentialsContract

Object

Details van de referenties die worden gebruikt om verbinding te maken met de back-end.

Name	Type	Description
authorization	BackendAuthorizationHeaderCredentials	Verificatie van autorisatieheader
certificate	string[]	Lijst met vingerafdruk van clientcertificaat. Wordt genegeerd als er certificatesIds worden opgegeven.
certificateIds	string[]	Lijst met clientcertificaat-id's.
header	object	Beschrijving van headerparameter.
query	object	Beschrijving van queryparameter.

BackendPoolItem

Object

Servicegegevens van back-endpool

Name	Type	Description
id	string (arm-id)	De unieke ARM-id van de back-endentiteit. De ARM-id moet verwijzen naar een al bestaande back-endentiteit.
priority	integer (int32) minimum: 0 maximum: 100	De prioriteit van de back-endentiteit in de back-endpool. Moet tussen 0 en 100 zijn. Het kan ook null zijn als de waarde niet is opgegeven.
weight	integer (int32) minimum: 0 maximum: 100	Het gewicht van de back-endentiteit in de back-endpool. Moet tussen 0 en 100 zijn. Het kan ook null zijn als de waarde niet is opgegeven.

BackendProperties

Object

Eigenschappen die specifiek zijn voor het back-endtype.

Name	Type	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Eigenschappen van service fabric-back-endcluster

BackendProtocol

Inventarisatie

Protocol voor back-endcommunicatie. Vereist wanneer het backend-type 'Enkel' is.

Waarde	Description
http	De back-end is een RESTful-service.
soap	De back-end is een SOAP-service.

BackendProxyContract

Object

Details van de back-endwebproxyserver die moet worden gebruikt in de aanvraag naar back-end.

Name	Type	Description
password	string	Wachtwoord om verbinding te maken met de WebProxy-server
url	string minLength: 1 maxLength: 2000	De eigenschap AbsoluteUri van WebProxy Server die de volledige URI bevat die is opgeslagen in het URI-exemplaar, inclusief alle fragmenten en queryreeksen.
username	string	Gebruikersnaam om verbinding te maken met de WebProxy-server

BackendServiceFabricClusterProperties

Object

Eigenschappen van de back-end van het Service Fabric-type.

Name	Type	Description
clientCertificateId	string	De clientcertificaat-id voor het beheereindpunt.
clientCertificatethumbprint	string	De vingerafdruk van het clientcertificaat voor het beheereindpunt. Wordt genegeerd als er certificatesIds worden opgegeven
managementEndpoints	string[]	Het eindpunt voor clusterbeheer.
maxPartitionResolutionRetries	integer (int32)	Maximum aantal nieuwe pogingen tijdens het oplossen van de partitie.
serverCertificateThumbprints	string[]	Vingerafdruk van certificaten die door de clusterbeheerservice worden gebruikt voor tls-communicatie
serverX509Names	X509CertificateName[]	Verzameling server X509-certificaatnamen

BackendTlsProperties

Object

Eigenschappen die tls-certificaatvalidatie beheren.

Name	Type	Default value	Description
validateCertificateChain	boolean	True	Vlag die aangeeft of validatie van SSL-certificaatketens moet worden uitgevoerd bij het gebruik van zelfondertekende certificaten voor deze back-endhost.
validateCertificateName	boolean	True	Vlag die aangeeft of validatie van SSL-certificaatnaam moet worden uitgevoerd bij het gebruik van zelfondertekende certificaten voor deze back-endhost.

BackendType

Inventarisatie

Type van de back-end. Een back-end kan één of pool zijn.

Waarde	Description
Single	ondersteunt één back-end
Pool	ondersteunt back-end van pool

BackendUpdateParameters

Object

Parameters voor back-endupdates.

Name	Type	Description
properties.circuitBreaker	BackendCircuitBreaker	Configuratie van back-endcircuitonderbreker
properties.credentials	BackendCredentialsContract	Contracteigenschappen voor back-endreferenties
properties.description	string minLength: 1 maxLength: 2000	Beschrijving van back-end.
properties.pool	Pool
properties.properties	BackendProperties	Contract voor back-endeigenschappen
properties.protocol	BackendProtocol	Protocol voor back-endcommunicatie. Vereist wanneer het backend-type 'Enkel' is.
properties.proxy	BackendProxyContract	Eigenschappen van back-endgatewaycontract
properties.resourceId	string minLength: 1 maxLength: 2000	Beheer-URI van de resource in extern systeem. Deze URL kan de Arm-resource-id van Logic Apps, Functie-apps of API-apps zijn.
properties.title	string minLength: 1 maxLength: 300	Back-endtitel.
properties.tls	BackendTlsProperties	TLS-eigenschappen voor back-end
properties.type	BackendType	Type van de back-end. Een back-end kan één of pool zijn.
properties.url	string minLength: 1 maxLength: 2000	Runtime-URL van de back-end. Vereist wanneer het backend-type 'Enkel' is.

CircuitBreakerFailureCondition

Object

De reisvoorwaarden van de circuitonderbreker

Name	Type	Description
count	integer (int64)	De drempelwaarde voor het openen van het circuit.
errorReasons	string[] maxLength: 200	De foutredenen die als fout worden beschouwd.
interval	string (duration)	Het interval waarin de fouten worden geteld.
percentage	integer (int64)	De drempelwaarde voor het openen van het circuit.
statusCodeRanges	FailureStatusCodeRange[]	De statuscodebereiken die als fout worden beschouwd.

CircuitBreakerRule

Object

Regelconfiguratie om naar de back-end te gaan.

Name	Type	Description
acceptRetryAfter	boolean	vlag om Retry-After header van de back-end te accepteren.
failureCondition	CircuitBreakerFailureCondition	De voorwaarden voor het trippen van de circuitonderbreker.
name	string	De naam van de regel.
tripDuration	string (duration)	De duur waarvoor het circuit wordt gereisd.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Object

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

FailureStatusCodeRange

Object

Het http-statuscodebereik van de fout

Name	Type	Description
max	integer (int32) minimum: 200 maximum: 599	De maximale HTTP-statuscode.
min	integer (int32) minimum: 200 maximum: 599	De minimale HTTP-statuscode.

Pool

Object

Name	Type	Description
services	BackendPoolItem[]	De lijst met back-endentiteiten die deel uitmaken van een pool.

X509CertificateName

Object

Eigenschappen van server X509Names.

Name	Type	Description
issuerCertificateThumbprint	string	Vingerafdruk voor de uitgever van het certificaat.
name	string	Algemene naam van het certificaat.

Delen via

Backend - Update

URI-parameters

Aanvraagkoptekst

Aanvraagbody

Antwoorden

Beveiliging

azure_auth

Bereiken

Voorbeelden

ApiManagementUpdateBackend

Voorbeeldaanvraag

Voorbeeldrespons

Definities

BackendAuthorizationHeaderCredentials

BackendCircuitBreaker

BackendContract

BackendCredentialsContract

BackendPoolItem

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

BackendType

BackendUpdateParameters

CircuitBreakerFailureCondition

CircuitBreakerRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailureStatusCodeRange

Pool

X509CertificateName