Backend - Update
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 |
---|---|---|---|---|
backend
|
path | True |
string |
Identificador de la entidad back-end. Debe ser único en la instancia de servicio API Management actual. |
resource
|
path | True |
string |
Nombre del grupo de recursos. El nombre distingue mayúsculas de minúsculas. |
service
|
path | True |
string |
Nombre del servicio API Management. Patrón de Regex: |
subscription
|
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 |
Propiedades del contrato de credenciales de back-end |
|
properties.description |
string |
Descripción del back-end. |
properties.properties |
Contrato de propiedades de back-end |
|
properties.protocol |
Protocolo de comunicación back-end. |
|
properties.proxy |
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 |
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 |
El backend existente se actualizó correctamente. Encabezados ETag: string |
|
Other Status Codes |
Respuesta de error que describe el motivo del error de 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 | suplantación de su cuenta de usuario |
Ejemplos
ApiManagementUpdateBackend
Solicitud de ejemplo
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
}
}
}
Respuesta de muestra
{
"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 |
---|---|
Backend |
Información del encabezado de autorización. |
Backend |
Detalles del back-end. |
Backend |
Detalles de las credenciales usadas para conectarse al back-end. |
Backend |
Propiedades específicas del tipo de back-end. |
Backend |
Protocolo de comunicación back-end. |
Backend |
Detalles del servidor WebProxy de back-end que se va a usar en la solicitud al back-end. |
Backend |
Propiedades del back-end de tipo de Service Fabric. |
Backend |
Propiedades que controlan la validación de certificados TLS. |
Backend |
Parámetros de actualización de back-end. |
Error |
Contrato de campo de error. |
Error |
Respuesta de error. |
X509Certificate |
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 |
Propiedades del contrato de credenciales de back-end |
|
properties.description |
string |
Descripción del back-end. |
properties.properties |
Contrato de propiedades de back-end |
|
properties.protocol |
Protocolo de comunicación back-end. |
|
properties.proxy |
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 |
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 |
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 |
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 |
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 |
Propiedades del contrato de credenciales de back-end |
|
properties.description |
string |
Descripción del back-end. |
properties.properties |
Contrato de propiedades de back-end |
|
properties.protocol |
Protocolo de comunicación back-end. |
|
properties.proxy |
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 |
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 |
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. |