Backend - Update

Service:

API Management

API Version:

2022-08-01

Novedades un back-end existente.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
backendId	path	True	string	Identificador de la entidad back-end. Debe ser único en la instancia de servicio API Management actual.
resourceGroupName	path	True	string	Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas.
serviceName	path	True	string	Nombre del servicio API Management. Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Identificador de la suscripción de destino.
api-version	query	True	string	Versión de API que se usará para la operación.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
If-Match	True	string	ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

Cuerpo de la solicitud

Nombre	Tipo	Description
properties.credentials	BackendCredentialsContract	Propiedades del contrato de credenciales de back-end
properties.description	string	Descripción del back-end.
properties.properties	BackendProperties	Contrato de propiedades de back-end
properties.protocol	BackendProtocol	Protocolo de comunicación back-end.
properties.proxy	BackendProxyContract	Propiedades del contrato de puerta de enlace de back-end
properties.resourceId	string	Uri de administración del recurso en sistema externo. Esta dirección URL puede ser el identificador de recurso de Arm de Logic Apps, Function Apps o API Apps.
properties.title	string	Título del back-end.
properties.tls	BackendTlsProperties	Propiedades de TLS de back-end
properties.url	string	Dirección URL del entorno de ejecución del back-end.

Respuestas

Nombre	Tipo	Description
200 OK	BackendContract	El backend existente se actualizó correctamente. Headers ETag: string
Other Status Codes	ErrorResponse	Respuesta de error que describe el motivo del error de la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

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

Scopes

Nombre	Description
user_impersonation	suplantación de su cuenta de usuario

Ejemplos

ApiManagementUpdateBackend

Sample Request

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

Sample Response

Status code:

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

Definiciones

Nombre	Description
BackendAuthorizationHeaderCredentials	Información del encabezado de autorización.
BackendContract	Detalles del back-end.
BackendCredentialsContract	Detalles de las credenciales usadas para conectarse al back-end.
BackendProperties	Propiedades específicas del tipo de back-end.
BackendProtocol	Protocolo de comunicación back-end.
BackendProxyContract	Detalles del servidor WebProxy de back-end que se va a usar en la solicitud al back-end.
BackendServiceFabricClusterProperties	Propiedades del back-end de tipo de Service Fabric.
BackendTlsProperties	Propiedades que controlan la validación de certificados TLS.
BackendUpdateParameters	Parámetros de actualización de back-end.
ErrorFieldContract	Contrato de campo de error.
ErrorResponse	Respuesta de error.
X509CertificateName	Propiedades del servidor X509Names.

BackendAuthorizationHeaderCredentials

Información del encabezado de autorización.

Nombre	Tipo	Description
parameter	string	Valor del parámetro de autenticación.
scheme	string	Nombre del esquema de autenticación.

BackendContract

Detalles del back-end.

Nombre	Tipo	Description
id	string	Identificador de recurso completo del recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso.
properties.credentials	BackendCredentialsContract	Propiedades del contrato de credenciales de back-end
properties.description	string	Descripción del back-end.
properties.properties	BackendProperties	Contrato de propiedades de back-end
properties.protocol	BackendProtocol	Protocolo de comunicación back-end.
properties.proxy	BackendProxyContract	Propiedades del contrato de puerta de enlace de back-end
properties.resourceId	string	Uri de administración del recurso en sistema externo. Esta dirección URL puede ser el identificador de recurso de Arm de Logic Apps, Function Apps o API Apps.
properties.title	string	Título del back-end.
properties.tls	BackendTlsProperties	Propiedades de TLS de back-end
properties.url	string	Dirección URL del entorno de ejecución del back-end.
type	string	Tipo de recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Detalles de las credenciales usadas para conectarse al back-end.

Nombre	Tipo	Description
authorization	BackendAuthorizationHeaderCredentials	Autenticación de encabezado de autorización
certificate	string[]	Lista de huellas digitales de certificado de cliente. Se omitirá si se proporcionan certificatesIds.
certificateIds	string[]	Lista de identificadores de certificado de cliente.
header	object	Descripción del parámetro de encabezado.
query	object	Descripción del parámetro de consulta.

BackendProperties

Propiedades específicas del tipo de back-end.

Nombre	Tipo	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Propiedades del clúster de Service Fabric de back-end

BackendProtocol

Protocolo de comunicación back-end.

Nombre	Tipo	Description
http	string	El back-end es un servicio RESTful.
soap	string	El back-end es un servicio SOAP.

BackendProxyContract

Detalles del servidor WebProxy de back-end que se va a usar en la solicitud al back-end.

Nombre	Tipo	Description
password	string	Contraseña para conectarse al servidor WebProxy
url	string	Propiedad AbsoluteUri del servidor WebProxy que incluye todo el URI almacenado en la instancia de Uri, incluidos todos los fragmentos y cadenas de consulta.
username	string	Nombre de usuario para conectarse al servidor WebProxy

BackendServiceFabricClusterProperties

Propiedades del back-end de tipo de Service Fabric.

Nombre	Tipo	Description
clientCertificateId	string	Identificador de certificado de cliente para el punto de conexión de administración.
clientCertificatethumbprint	string	Huella digital del certificado de cliente para el punto de conexión de administración. Se omitirá si se proporcionan certificatesIds.
managementEndpoints	string[]	Punto de conexión de administración de clústeres.
maxPartitionResolutionRetries	integer	Número máximo de reintentos al intentar resolver la partición.
serverCertificateThumbprints	string[]	Huellas digitales del servicio de administración de clústeres de certificados usa para la comunicación tls
serverX509Names	X509CertificateName[]	Colección de nombres de certificado X509 de servidor

BackendTlsProperties

Propiedades que controlan la validación de certificados TLS.

Nombre	Tipo	Valor predeterminado	Description
validateCertificateChain	boolean	True	Marca que indica si se debe realizar la validación de la cadena de certificados SSL al usar certificados autofirmados para este host de back-end.
validateCertificateName	boolean	True	Marca que indica si se debe realizar la validación del nombre del certificado SSL al usar certificados autofirmados para este host de back-end.

BackendUpdateParameters

Parámetros de actualización de back-end.

Nombre	Tipo	Description
properties.credentials	BackendCredentialsContract	Propiedades del contrato de credenciales de back-end
properties.description	string	Descripción del back-end.
properties.properties	BackendProperties	Contrato de propiedades de back-end
properties.protocol	BackendProtocol	Protocolo de comunicación back-end.
properties.proxy	BackendProxyContract	Propiedades del contrato de puerta de enlace de back-end
properties.resourceId	string	Uri de administración del recurso en sistema externo. Esta dirección URL puede ser el identificador de recurso de Arm de Logic Apps, Function Apps o API Apps.
properties.title	string	Título del back-end.
properties.tls	BackendTlsProperties	Propiedades de TLS de back-end
properties.url	string	Dirección URL del entorno de ejecución del back-end.

ErrorFieldContract

Contrato de campo de error.

Nombre	Tipo	Description
code	string	Código de error de nivel de propiedad.
message	string	Representación legible del error de nivel de propiedad.
target	string	Nombre de propiedad.

ErrorResponse

Respuesta de error.

Nombre	Tipo	Description
error.code	string	Código del error definido por el servicio. Este código funciona como estado secundario del código de error HTTP especificado en la respuesta.
error.details	ErrorFieldContract[]	La lista de campos no válidos que se envían en la solicitud, en caso de error de validación.
error.message	string	Representación legible del error.

X509CertificateName

Propiedades del servidor X509Names.

Nombre	Tipo	Description
issuerCertificateThumbprint	string	Huella digital del emisor del certificado.
name	string	Nombre común del certificado.