Backend - Update

Référence

Service:: API Management

Version d'API:: 2024-05-01

Met à jour un back-end existant.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
backendId	path	True	string minLength: 1 maxLength: 80	Identificateur de l’entité back-end. Doit être unique dans l’instance actuelle du service Gestion des API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nom du groupe de ressources. Le nom ne respecte pas la casse.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nom du service Gestion des API.
subscriptionId	path	True	string (uuid)	ID de l’abonnement cible. La valeur doit être un UUID.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom	Obligatoire	Type	Description
If-Match	True	string	ETag de l’entité. ETag doit correspondre à l’état actuel de l’entité à partir de la réponse d’en-tête de la requête GET ou il doit être * pour la mise à jour inconditionnelle.

Corps de la demande

Nom	Type	Description
properties.circuitBreaker	BackendCircuitBreaker	Configuration du disjoncteur principal
properties.credentials	BackendCredentialsContract	Propriétés du contrat d’informations d’identification du serveur principal
properties.description	string minLength: 1 maxLength: 2000	Description du back-end.
properties.pool	Pool
properties.properties	BackendProperties	Contrat propriétés du back-end
properties.protocol	BackendProtocol	Protocole de communication back-end.
properties.proxy	BackendProxyContract	Propriétés du contrat de passerelle principale
properties.resourceId	string minLength: 1 maxLength: 2000	URI de gestion de la ressource dans le système externe. Cette URL peut être l’ID de ressource Arm des applications logiques, des applications de fonction ou des applications API.
properties.title	string minLength: 1 maxLength: 300	Titre du back-end.
properties.tls	BackendTlsProperties	Propriétés TLS du back-end
properties.type	BackendType	Type du back-end. Un back-end peut être unique ou pool.
properties.url	string minLength: 1 maxLength: 2000	URL du runtime du back-end.

Réponses

Nom	Type	Description
200 OK	BackendContract	Le back-end existant a été correctement mis à jour. En-têtes ETag: string
Other Status Codes	ErrorResponse	Réponse d’erreur décrivant pourquoi l’opération a échoué.

Nom

Type

Description

200 OK

BackendContract

Le back-end existant a été correctement mis à jour.

En-têtes

ETag: string

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant pourquoi l’opération a échoué.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

Nom	Description
user_impersonation	emprunter l’identité de votre compte d’utilisateur

Exemples

ApiManagementUpdateBackend

Exemple de requête

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

Exemple de réponse

Code d’état:: 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
    }
  }
}

Définitions

Nom	Description
BackendAuthorizationHeaderCredentials	Informations d’en-tête d’autorisation.
BackendCircuitBreaker	Configuration du disjoncteur principal
BackendContract	Détails du back-end.
BackendCredentialsContract	Détails des informations d’identification utilisées pour se connecter au serveur principal.
BackendPoolItem	Informations sur le service du pool principal
BackendProperties	Propriétés propres au type de back-end.
BackendProtocol	Protocole de communication back-end.
BackendProxyContract	Détails du serveur WebProxy principal à utiliser dans la requête au serveur principal.
BackendServiceFabricClusterProperties	Propriétés du serveur principal de type Service Fabric.
BackendTlsProperties	Propriétés contrôlant la validation de certificat TLS.
BackendType	Type du back-end. Un back-end peut être unique ou pool.
BackendUpdateParameters	Paramètres de mise à jour du back-end.
CircuitBreakerFailureCondition	Conditions de voyage du disjoncteur
CircuitBreakerRule	Configuration de règle pour effectuer le déplacement du back-end.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
FailureStatusCodeRange	Plage de codes d’état http d’échec
Pool
X509CertificateName	Propriétés du serveur X509Names.

BackendAuthorizationHeaderCredentials

Object

Informations d’en-tête d’autorisation.

Nom	Type	Description
parameter	string minLength: 1 maxLength: 300	Valeur du paramètre d’authentification.
scheme	string minLength: 1 maxLength: 100	Nom du schéma d’authentification.

BackendCircuitBreaker

Object

Configuration du disjoncteur principal

Nom	Type	Description
rules	CircuitBreakerRule[]	Règles de déplacement du back-end.

BackendContract

Object

Détails du back-end.

Nom	Type	Description
id	string	ID de ressource complet pour la ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nom de la ressource
properties.circuitBreaker	BackendCircuitBreaker	Configuration du disjoncteur principal
properties.credentials	BackendCredentialsContract	Propriétés du contrat d’informations d’identification du serveur principal
properties.description	string minLength: 1 maxLength: 2000	Description du back-end.
properties.pool	Pool
properties.properties	BackendProperties	Contrat propriétés du back-end
properties.protocol	BackendProtocol	Protocole de communication back-end.
properties.proxy	BackendProxyContract	Propriétés du contrat de passerelle principale
properties.resourceId	string minLength: 1 maxLength: 2000	URI de gestion de la ressource dans le système externe. Cette URL peut être l’ID de ressource Arm des applications logiques, des applications de fonction ou des applications API.
properties.title	string minLength: 1 maxLength: 300	Titre du back-end.
properties.tls	BackendTlsProperties	Propriétés TLS du back-end
properties.type	BackendType	Type du back-end. Un back-end peut être unique ou pool.
properties.url	string minLength: 1 maxLength: 2000	URL du runtime du back-end.
type	string	Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

BackendCredentialsContract

Object

Détails des informations d’identification utilisées pour se connecter au serveur principal.

Nom	Type	Description
authorization	BackendAuthorizationHeaderCredentials	Authentification de l’en-tête d’autorisation
certificate	string[]	Liste des empreintes de certificat client. Sera ignoré si les certificatesIds sont fournis.
certificateIds	string[]	Liste des ID de certificat client.
header	object	Description du paramètre d’en-tête.
query	object	Description du paramètre de requête.

BackendPoolItem

Object

Informations sur le service du pool principal

Nom	Type	Description
id	string (arm-id)	ID ARM unique de l’entité back-end. L’ID ARM doit faire référence à une entité back-end déjà existante.
priority	integer (int32) minimum: 0 maximum: 100	Priorité de l’entité back-end dans le pool principal. Doit être compris entre 0 et 100. Elle peut également être null si la valeur n’est pas spécifiée.
weight	integer (int32) minimum: 0 maximum: 100	Poids de l’entité back-end dans le pool principal. Doit être compris entre 0 et 100. Elle peut également être null si la valeur n’est pas spécifiée.

BackendProperties

Object

Propriétés propres au type de back-end.

Nom	Type	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Propriétés du cluster Service Fabric principal

BackendProtocol

Énumération

Protocole de communication back-end.

Valeur	Description
http	Le serveur principal est un service RESTful.
soap	Le serveur principal est un service SOAP.

BackendProxyContract

Object

Détails du serveur WebProxy principal à utiliser dans la requête au serveur principal.

Nom	Type	Description
password	string	Mot de passe pour se connecter au serveur WebProxy
url	string minLength: 1 maxLength: 2000	Propriété WebProxy Server AbsoluteUri qui inclut l’URI entier stocké dans l’instance d’URI, y compris tous les fragments et chaînes de requête.
username	string	Nom d’utilisateur pour se connecter au serveur WebProxy

BackendServiceFabricClusterProperties

Object

Propriétés du serveur principal de type Service Fabric.

Nom	Type	Description
clientCertificateId	string	ID de certificat client pour le point de terminaison de gestion.
clientCertificatethumbprint	string	Empreinte numérique du certificat client pour le point de terminaison de gestion. Sera ignoré si les certificatesIds sont fournis
managementEndpoints	string[]	Point de terminaison de gestion du cluster.
maxPartitionResolutionRetries	integer (int32)	Nombre maximal de nouvelles tentatives lors de la tentative de résolution de la partition.
serverCertificateThumbprints	string[]	Empreintes du service de gestion de cluster de certificats utilisée pour la communication tls
serverX509Names	X509CertificateName[]	Collection de noms de certificats Server X509

BackendTlsProperties

Object

Propriétés contrôlant la validation de certificat TLS.

Nom	Type	Valeur par défaut	Description
validateCertificateChain	boolean	True	Indicateur indiquant si la validation de la chaîne de certificats SSL doit être effectuée lors de l’utilisation de certificats auto-signés pour cet hôte principal.
validateCertificateName	boolean	True	Indicateur indiquant si la validation du nom de certificat SSL doit être effectuée lors de l’utilisation de certificats auto-signés pour cet hôte principal.

BackendType

Énumération

Type du back-end. Un back-end peut être unique ou pool.

Valeur	Description
Pool	prend en charge le back-end du pool
Single	prend en charge un serveur principal unique

BackendUpdateParameters

Object

Paramètres de mise à jour du back-end.

Nom	Type	Description
properties.circuitBreaker	BackendCircuitBreaker	Configuration du disjoncteur principal
properties.credentials	BackendCredentialsContract	Propriétés du contrat d’informations d’identification du serveur principal
properties.description	string minLength: 1 maxLength: 2000	Description du back-end.
properties.pool	Pool
properties.properties	BackendProperties	Contrat propriétés du back-end
properties.protocol	BackendProtocol	Protocole de communication back-end.
properties.proxy	BackendProxyContract	Propriétés du contrat de passerelle principale
properties.resourceId	string minLength: 1 maxLength: 2000	URI de gestion de la ressource dans le système externe. Cette URL peut être l’ID de ressource Arm des applications logiques, des applications de fonction ou des applications API.
properties.title	string minLength: 1 maxLength: 300	Titre du back-end.
properties.tls	BackendTlsProperties	Propriétés TLS du back-end
properties.type	BackendType	Type du back-end. Un back-end peut être unique ou pool.
properties.url	string minLength: 1 maxLength: 2000	URL du runtime du back-end.

CircuitBreakerFailureCondition

Object

Conditions de voyage du disjoncteur

Nom	Type	Description
count	integer (int64)	Seuil d’ouverture du circuit.
errorReasons	string[] maxLength: 200	Les raisons d’erreur qui sont considérées comme des échecs.
interval	string (duration)	Intervalle pendant lequel les échecs sont comptabilisés.
percentage	integer (int64)	Seuil d’ouverture du circuit.
statusCodeRanges	FailureStatusCodeRange[]	Plages de code d’état considérées comme des échecs.

CircuitBreakerRule

Object

Configuration de règle pour effectuer le déplacement du back-end.

Nom	Type	Description
acceptRetryAfter	boolean	indicateur permettant d’accepter Retry-After en-tête à partir du serveur principal.
failureCondition	CircuitBreakerFailureCondition	Conditions de déplacement du disjoncteur.
name	string	Nom de la règle.
tripDuration	string (duration)	Durée pendant laquelle le circuit sera triplé.

ErrorAdditionalInfo

Object

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info	object	Informations supplémentaires.
type	string	Type d’informations supplémentaire.

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

FailureStatusCodeRange

Object

Plage de codes d’état http d’échec

Nom	Type	Description
max	integer (int32) minimum: 200 maximum: 599	Code d’état http maximal.
min	integer (int32) minimum: 200 maximum: 599	Code d’état http minimal.

Pool

Object

Nom	Type	Description
services	BackendPoolItem[]	Liste des entités principales appartenant à un pool.

X509CertificateName

Object

Propriétés du serveur X509Names.

Nom	Type	Description
issuerCertificateThumbprint	string	Empreinte numérique de l’émetteur du certificat.
name	string	Nom commun du certificat.

Partager via

Backend - Update

Paramètres URI

En-tête de la demande

Corps de la demande

Réponses

Sécurité

azure_auth

Étendues

Exemples

ApiManagementUpdateBackend

Exemple de requête

Exemple de réponse

Définitions

BackendAuthorizationHeaderCredentials

BackendCircuitBreaker

BackendContract

BackendCredentialsContract

BackendPoolItem

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

BackendType

BackendUpdateParameters

CircuitBreakerFailureCondition

CircuitBreakerRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailureStatusCodeRange

Pool

X509CertificateName

Ressources supplémentaires