Backend - Update

Service:

API Management

Version d'API:

2022-08-01

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. Modèle d’expression régulière: ^[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. En-têtes 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
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/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend?api-version=2022-08-01


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

Java

import com.azure.resourcemanager.apimanagement.models.BackendContract;
import com.azure.resourcemanager.apimanagement.models.BackendTlsProperties;

/** Samples for Backend Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateBackend.json
     */
    /**
     * Sample code: ApiManagementUpdateBackend.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateBackend(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        BackendContract resource =
            manager
                .backends()
                .getWithResponse("rg1", "apimService1", "proxybackend", com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withDescription("description5308")
            .withTls(new BackendTlsProperties().withValidateCertificateChain(false).withValidateCertificateName(true))
            .withIfMatch("*")
            .apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_update_backend.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.backend.update(
        resource_group_name="rg1",
        service_name="apimService1",
        backend_id="proxybackend",
        if_match="*",
        parameters={
            "properties": {
                "description": "description5308",
                "tls": {"validateCertificateChain": False, "validateCertificateName": True},
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateBackend.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateBackend.json
func ExampleBackendClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewBackendClient().Update(ctx, "rg1", "apimService1", "proxybackend", "*", armapimanagement.BackendUpdateParameters{
		Properties: &armapimanagement.BackendUpdateParameterProperties{
			Description: to.Ptr("description5308"),
			TLS: &armapimanagement.BackendTLSProperties{
				ValidateCertificateChain: to.Ptr(false),
				ValidateCertificateName:  to.Ptr(true),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BackendContract = armapimanagement.BackendContract{
	// 	Name: to.Ptr("proxybackend"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/backends"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend"),
	// 	Properties: &armapimanagement.BackendContractProperties{
	// 		Description: to.Ptr("description5308"),
	// 		Credentials: &armapimanagement.BackendCredentialsContract{
	// 			Authorization: &armapimanagement.BackendAuthorizationHeaderCredentials{
	// 				Parameter: to.Ptr("opensesma"),
	// 				Scheme: to.Ptr("Basic"),
	// 			},
	// 			Header: map[string][]*string{
	// 				"x-my-1": []*string{
	// 					to.Ptr("val1"),
	// 					to.Ptr("val2")},
	// 				},
	// 				Query: map[string][]*string{
	// 					"sv": []*string{
	// 						to.Ptr("xx"),
	// 						to.Ptr("bb"),
	// 						to.Ptr("cc")},
	// 					},
	// 				},
	// 				Proxy: &armapimanagement.BackendProxyContract{
	// 					Password: to.Ptr("<password>"),
	// 					URL: to.Ptr("http://192.168.1.1:8080"),
	// 					Username: to.Ptr("Contoso\\admin"),
	// 				},
	// 				TLS: &armapimanagement.BackendTLSProperties{
	// 					ValidateCertificateChain: to.Ptr(false),
	// 					ValidateCertificateName: to.Ptr(true),
	// 				},
	// 				URL: to.Ptr("https://backendname2644/"),
	// 				Protocol: to.Ptr(armapimanagement.BackendProtocolHTTP),
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates an existing backend.
 *
 * @summary Updates an existing backend.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateBackend.json
 */
async function apiManagementUpdateBackend() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const backendId = "proxybackend";
  const ifMatch = "*";
  const parameters = {
    description: "description5308",
    tls: { validateCertificateChain: false, validateCertificateName: true },
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.backend.update(
    resourceGroupName,
    serviceName,
    backendId,
    ifMatch,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using System.Xml;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement.Models;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateBackend.json
// this example is just showing the usage of "Backend_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementBackendResource created on azure
// for more information of creating ApiManagementBackendResource, please refer to the document of ApiManagementBackendResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string backendId = "proxybackend";
ResourceIdentifier apiManagementBackendResourceId = ApiManagementBackendResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, backendId);
ApiManagementBackendResource apiManagementBackend = client.GetApiManagementBackendResource(apiManagementBackendResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
ApiManagementBackendPatch patch = new ApiManagementBackendPatch()
{
    Description = "description5308",
    Tls = new BackendTlsProperties()
    {
        ShouldValidateCertificateChain = false,
        ShouldValidateCertificateName = true,
    },
};
ApiManagementBackendResource result = await apiManagementBackend.UpdateAsync(ifMatch, patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementBackendData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Exemple de réponse

Code d’état:

200

{
  "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.