Backend - Update

Referencia

Servicio:: API Management

Versión de la API:: 2024-05-01

Actualiza un back-end existente.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
backendId	path	True	string minLength: 1 maxLength: 80	Identificador de la entidad back-end. Debe ser único en la instancia actual del servicio API Management.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nombre del servicio API Management.
subscriptionId	path	True	string (uuid)	Identificador de la suscripción de destino. El valor debe ser un UUID.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta 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.circuitBreaker	BackendCircuitBreaker	Configuración del disyuntor de back-end
properties.credentials	BackendCredentialsContract	Propiedades del contrato de credenciales de back-end
properties.description	string minLength: 1 maxLength: 2000	Descripción del back-end.
properties.pool	Pool
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 minLength: 1 maxLength: 2000	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 minLength: 1 maxLength: 300	Título de back-end.
properties.tls	BackendTlsProperties	Propiedades tls de back-end
properties.type	BackendType	Tipo del back-end. Un back-end puede ser Single o Pool.
properties.url	string minLength: 1 maxLength: 2000	Dirección URL en tiempo de ejecución del back-end.

Respuestas

Nombre	Tipo	Description
200 OK	BackendContract	El back-end existente se actualizó correctamente. Encabezados ETag: string
Other Status Codes	ErrorResponse	Respuesta de error que describe por qué se produjo un error en la operación.

Nombre

Tipo

Description

200 OK

BackendContract

El back-end existente se actualizó correctamente.

Encabezados

ETag: string

Other Status Codes

ErrorResponse

Respuesta de error que describe por qué se produjo un error en la operación.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory.

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

ApiManagementUpdateBackend

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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
    }
  }
}

Definiciones

Nombre	Description
BackendAuthorizationHeaderCredentials	Información del encabezado de autorización.
BackendCircuitBreaker	Configuración del disyuntor back-end
BackendContract	Detalles del back-end.
BackendCredentialsContract	Detalles de las credenciales usadas para conectarse al back-end.
BackendPoolItem	Información del servicio del grupo de 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.
BackendType	Tipo del back-end. Un back-end puede ser Single o Pool.
BackendUpdateParameters	Parámetros de actualización de back-end.
CircuitBreakerFailureCondition	Condiciones de viaje del disyuntor
CircuitBreakerRule	Configuración de reglas para realizar el recorrido del back-end.
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
FailureStatusCodeRange	Intervalo de código de estado HTTP de error
Pool
X509CertificateName	Propiedades del servidor X509Names.

BackendAuthorizationHeaderCredentials

Object

Información del encabezado de autorización.

Nombre	Tipo	Description
parameter	string minLength: 1 maxLength: 300	Valor del parámetro de autenticación.
scheme	string minLength: 1 maxLength: 100	Nombre del esquema de autenticación.

BackendCircuitBreaker

Object

Configuración del disyuntor back-end

Nombre	Tipo	Description
rules	CircuitBreakerRule[]	Reglas para realizar el recorrido del back-end.

BackendContract

Object

Detalles del back-end.

Nombre	Tipo	Description
id	string	Identificador de recurso completo para el recurso. Por ejemplo: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nombre del recurso
properties.circuitBreaker	BackendCircuitBreaker	Configuración del disyuntor de back-end
properties.credentials	BackendCredentialsContract	Propiedades del contrato de credenciales de back-end
properties.description	string minLength: 1 maxLength: 2000	Descripción del back-end.
properties.pool	Pool
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 minLength: 1 maxLength: 2000	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 minLength: 1 maxLength: 300	Título de back-end.
properties.tls	BackendTlsProperties	Propiedades tls de back-end
properties.type	BackendType	Tipo del back-end. Un back-end puede ser Single o Pool.
properties.url	string minLength: 1 maxLength: 2000	Dirección URL en tiempo de ejecución del back-end.
type	string	Tipo del recurso. Por ejemplo, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Object

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.

BackendPoolItem

Object

Información del servicio del grupo de back-end

Nombre	Tipo	Description
id	string (arm-id)	Identificador único de ARM de la entidad back-end. El identificador de ARM debe hacer referencia a una entidad de back-end ya existente.
priority	integer (int32) minimum: 0 maximum: 100	Prioridad de la entidad de back-end en el grupo de back-end. Debe estar comprendido entre 0 y 100. También puede ser NULL si no se especifica el valor.
weight	integer (int32) minimum: 0 maximum: 100	Peso de la entidad de back-end en el grupo de back-end. Debe estar comprendido entre 0 y 100. También puede ser NULL si no se especifica el valor.

BackendProperties

Object

Propiedades específicas del tipo de back-end.

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

BackendProtocol

Enumeración

Protocolo de comunicación back-end.

Valor	Description
http	El back-end es un servicio RESTful.
soap	El back-end es un servicio SOAP.

BackendProxyContract

Object

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 minLength: 1 maxLength: 2000	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

Object

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 del clúster.
maxPartitionResolutionRetries	integer (int32)	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 Server X509 Certificate Names

BackendTlsProperties

Object

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.

BackendType

Enumeración

Tipo del back-end. Un back-end puede ser Single o Pool.

Valor	Description
Pool	admite el back-end del grupo
Single	admite un solo back-end

BackendUpdateParameters

Object

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

Nombre	Tipo	Description
properties.circuitBreaker	BackendCircuitBreaker	Configuración del disyuntor de back-end
properties.credentials	BackendCredentialsContract	Propiedades del contrato de credenciales de back-end
properties.description	string minLength: 1 maxLength: 2000	Descripción del back-end.
properties.pool	Pool
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 minLength: 1 maxLength: 2000	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 minLength: 1 maxLength: 300	Título de back-end.
properties.tls	BackendTlsProperties	Propiedades tls de back-end
properties.type	BackendType	Tipo del back-end. Un back-end puede ser Single o Pool.
properties.url	string minLength: 1 maxLength: 2000	Dirección URL en tiempo de ejecución del back-end.

CircuitBreakerFailureCondition

Object

Condiciones de viaje del disyuntor

Nombre	Tipo	Description
count	integer (int64)	Umbral para abrir el circuito.
errorReasons	string[] maxLength: 200	Los motivos de error que se consideran erróneos.
interval	string (duration)	Intervalo durante el que se cuentan los errores.
percentage	integer (int64)	Umbral para abrir el circuito.
statusCodeRanges	FailureStatusCodeRange[]	Intervalos de código de estado que se consideran erróneos.

CircuitBreakerRule

Object

Configuración de reglas para realizar el recorrido del back-end.

Nombre	Tipo	Description
acceptRetryAfter	boolean	marca para aceptar Retry-After encabezado del back-end.
failureCondition	CircuitBreakerFailureCondition	Condiciones para viajar por el disyuntor.
name	string	Nombre de la regla.
tripDuration	string (duration)	Duración durante la que se realizará el recorrido del circuito.

ErrorAdditionalInfo

Object

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info	object	Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Object

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	Mensaje de error.
target	string	Destino del error.

ErrorResponse

Object

Respuesta de error

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

FailureStatusCodeRange

Object

Intervalo de código de estado HTTP de error

Nombre	Tipo	Description
max	integer (int32) minimum: 200 maximum: 599	Código de estado HTTP máximo.
min	integer (int32) minimum: 200 maximum: 599	Código de estado http mínimo.

Pool

Object

Nombre	Tipo	Description
services	BackendPoolItem[]	Lista de entidades de back-end que pertenecen a un grupo.

X509CertificateName

Object

Propiedades del servidor X509Names.

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

Compartir a través de

Backend - Update

Parámetros de identificador URI

Encabezado de la solicitud

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

ApiManagementUpdateBackend

Solicitud de ejemplo

Respuesta de muestra

Definiciones

BackendAuthorizationHeaderCredentials

BackendCircuitBreaker

BackendContract

BackendCredentialsContract

BackendPoolItem

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

BackendType

BackendUpdateParameters

CircuitBreakerFailureCondition

CircuitBreakerRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailureStatusCodeRange

Pool

X509CertificateName

Recursos adicionales