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=2021-08-01
Paramètres URI
Nom | Dans | Obligatoire | Type | Description |
---|---|---|---|---|
backend
|
path | True |
string |
Identificateur de l’entité back-end. Doit être unique dans le instance de service Gestion des API actuel. |
resource
|
path | True |
string |
Nom du groupe de ressources. |
service
|
path | True |
string |
Nom du service Gestion des API. Modèle d’expression régulière: |
subscription
|
path | True |
string |
Informations d’identification d’abonnement qui identifient de manière unique l’abonnement Microsoft Azure. L’ID d’abonnement fait partie de l’URI pour chaque appel de service. |
api-version
|
query | True |
string |
Version de l’API à utiliser avec la demande du client. |
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.credentials |
Propriétés du contrat d’informations d’identification du serveur principal |
|
properties.description |
string |
Description du back-end. |
properties.properties |
Contrat de propriétés du back-end |
|
properties.protocol |
Protocole de communication back-end. |
|
properties.proxy |
Propriétés du contrat de proxy principal |
|
properties.resourceId |
string |
URI de gestion de la ressource dans le système externe. Cette URL peut être l’ID de ressource Arm de Logic Apps, Function Apps ou API Apps. |
properties.title |
string |
Titre du back-end. |
properties.tls |
Propriétés TLS du serveur principal |
|
properties.url |
string |
URL d’exécution du serveur principal. |
Réponses
Nom | Type | Description |
---|---|---|
200 OK |
Le serveur principal a été correctement mis à jour. En-têtes ETag: string |
|
Other Status Codes |
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
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
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend?api-version=2021-08-01
{
"properties": {
"description": "description5308",
"tls": {
"validateCertificateChain": false,
"validateCertificateName": true
}
}
}
Exemple de réponse
{
"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 |
---|---|
Backend |
Informations d’en-tête d’autorisation. |
Backend |
Détails du back-end. |
Backend |
Détails des informations d’identification utilisées pour se connecter au serveur principal. |
Backend |
Propriétés spécifiques au type de back-end. |
Backend |
Protocole de communication back-end. |
Backend |
Détails du serveur WebProxy principal à utiliser dans la requête au serveur principal. |
Backend |
Propriétés du serveur principal de type Service Fabric. |
Backend |
Propriétés contrôlant la validation de certificat TLS. |
Backend |
Paramètres de mise à jour du back-end. |
Error |
Contrat de champ d’erreur. |
Error |
Réponse d’erreur. |
X509Certificate |
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 |
Propriétés du contrat d’informations d’identification du serveur principal |
|
properties.description |
string |
Description du back-end. |
properties.properties |
Contrat de propriétés du back-end |
|
properties.protocol |
Protocole de communication back-end. |
|
properties.proxy |
Propriétés du contrat de proxy principal |
|
properties.resourceId |
string |
URI de gestion de la ressource dans le système externe. Cette URL peut être l’ID de ressource Arm de Logic Apps, Function Apps ou API Apps. |
properties.title |
string |
Titre du back-end. |
properties.tls |
Propriétés TLS du serveur principal |
|
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 |
Authentification de l’en-tête d’autorisation |
|
certificate |
string[] |
Liste des empreintes de certificat client. Sera ignoré si des id de certificat 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 |
Propriétés du cluster Service Fabric principal |
BackendProtocol
Protocole de communication back-end.
Nom | Type | Description |
---|---|---|
http |
string |
Le serveur principal est un service RESTful. |
soap |
string |
Le serveur principal est un service SOAP. |
BackendProxyContract
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 |
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 numérique 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[] |
Empreintes numériques des certificats que le service de gestion de cluster utilise pour la communication tls |
serverX509Names |
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 |
Propriétés du contrat d’informations d’identification du serveur principal |
|
properties.description |
string |
Description du back-end. |
properties.properties |
Contrat de propriétés du back-end |
|
properties.protocol |
Protocole de communication back-end. |
|
properties.proxy |
Propriétés du contrat de proxy principal |
|
properties.resourceId |
string |
URI de gestion de la ressource dans le système externe. Cette URL peut être l’ID de ressource Arm de Logic Apps, Function Apps ou API Apps. |
properties.title |
string |
Titre du back-end. |
properties.tls |
Propriétés TLS du serveur principal |
|
properties.url |
string |
URL d’exécution du serveur principal. |
ErrorFieldContract
Contrat de 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 des propriétés. |
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 |
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. |