Partager via


Backend - Update

Mises à jour un back-end existant.

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

Paramètres URI

Nom Dans Obligatoire Type Description
backendId
path True

string

Identificateur de l’entité Back-end. Doit être unique dans le instance de service Gestion des API actuel.

resourceGroupName
path True

string

Nom du groupe de ressources. Le nom ne respecte pas la casse.

serviceName
path True

string

Nom du service Gestion des API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ID de l’abonnement cible.

api-version
query True

string

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 d’entité actuel 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.credentials

BackendCredentialsContract

Propriétés du contrat d’informations d’identification back-end

properties.description

string

Description du back-end.

properties.properties

BackendProperties

Contrat de 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

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

Titre du back-end.

properties.tls

BackendTlsProperties

Propriétés TLS du back-end

properties.url

string

URL d’exécution du serveur principal.

Réponses

Nom Type Description
200 OK

BackendContract

Le serveur principal a été correctement mis à jour.

Headers

ETag: string

Other Status Codes

ErrorResponse

Réponse d’erreur décrivant la raison de l’échec de l’opération.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

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

Exemples

ApiManagementUpdateBackend

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend?api-version=2022-08-01


{
  "properties": {
    "description": "description5308",
    "tls": {
      "validateCertificateChain": false,
      "validateCertificateName": true
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid/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.

BackendContract

Détails du back-end.

BackendCredentialsContract

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

BackendProperties

Propriétés spécifiques au type de back-end.

BackendProtocol

Protocole de communication back-end.

BackendProxyContract

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

BackendServiceFabricClusterProperties

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

BackendTlsProperties

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

BackendUpdateParameters

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

ErrorFieldContract

Contrat champ d’erreur.

ErrorResponse

Réponse d’erreur.

X509CertificateName

Propriétés du serveur X509Names.

BackendAuthorizationHeaderCredentials

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

Nom Type Description
parameter

string

Valeur du paramètre d’authentification.

scheme

string

Nom du schéma d’authentification.

BackendContract

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.credentials

BackendCredentialsContract

Propriétés du contrat d’informations d’identification back-end

properties.description

string

Description du back-end.

properties.properties

BackendProperties

Contrat de 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

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

Titre du back-end.

properties.tls

BackendTlsProperties

Propriétés TLS du back-end

properties.url

string

URL d’exécution du serveur principal.

type

string

Type de la ressource. Par exemple, « Microsoft.Compute/virtualMachines » ou « Microsoft.Storage/storageAccounts »

BackendCredentialsContract

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 des id de certificats 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.

BackendProperties

Propriétés spécifiques au type de back-end.

Nom Type Description
serviceFabricCluster

BackendServiceFabricClusterProperties

Propriétés du cluster Service Fabric principal

BackendProtocol

Protocole de communication back-end.

Nom Type Description
http

string

Le back-end est un service RESTful.

soap

string

Le back-end est un service SOAP.

BackendProxyContract

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

Nom Type Description
password

string

Mot de passe pour se connecter au serveur WebProxy

url

string

Propriété AbsoluteUri du serveur WebProxy qui inclut l’URI entier stocké dans le instance URI, y compris tous les fragments et chaînes de requête.

username

string

Nom d’utilisateur pour se connecter au serveur WebProxy

BackendServiceFabricClusterProperties

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 du certificat client pour le point de terminaison de gestion. Sera ignoré si des id de certificats sont fournis

managementEndpoints

string[]

Point de terminaison de gestion du cluster.

maxPartitionResolutionRetries

integer

Nombre maximal de nouvelles tentatives lors de la tentative de résolution de la partition.

serverCertificateThumbprints

string[]

Utilisations des empreintes numériques du service de gestion de cluster de certificats pour la communication TLS

serverX509Names

X509CertificateName[]

Collection de noms de certificats Server X509

BackendTlsProperties

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.

BackendUpdateParameters

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

Nom Type Description
properties.credentials

BackendCredentialsContract

Propriétés du contrat d’informations d’identification back-end

properties.description

string

Description du back-end.

properties.properties

BackendProperties

Contrat de 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

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

Titre du back-end.

properties.tls

BackendTlsProperties

Propriétés TLS du back-end

properties.url

string

URL d’exécution du serveur principal.

ErrorFieldContract

Contrat champ d’erreur.

Nom Type Description
code

string

Code d'erreur de niveau propriété.

message

string

Représentation lisible par l’homme de l’erreur au niveau de la propriété.

target

string

Nom de propriété.

ErrorResponse

Réponse d’erreur.

Nom Type Description
error.code

string

Code d'erreur défini par le service. Ce code sert de sous-état pour le code d'erreur HTTP spécifié dans la réponse.

error.details

ErrorFieldContract[]

Liste des champs non valides envoyés dans la demande, en cas d’erreur de validation.

error.message

string

Représentation contrôlable de visu de l’erreur.

X509CertificateName

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.