你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

Backend - Update

汇报现有后端。

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

URI 参数

名称 必需 类型 说明
backendId
path True

string

后端实体的标识符。 在当前API 管理服务实例中必须是唯一的。

resourceGroupName
path True

string

资源组的名称。 此名称不区分大小写。

serviceName
path True

string

API 管理服务的名称。

正则表达式模式: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

目标订阅的 ID。

api-version
query True

string

要用于此操作的 API 版本。

请求头

名称 必需 类型 说明
If-Match True

string

实体的 ETag。 ETag 应与 GET 请求的标头响应中的当前实体状态匹配,或者对于无条件更新,ETag 应为 * 。

请求正文

名称 类型 说明
properties.credentials

BackendCredentialsContract

后端凭据协定属性

properties.description

string

后端说明。

properties.properties

BackendProperties

后端属性协定

properties.protocol

BackendProtocol

后端通信协议。

properties.proxy

BackendProxyContract

后端网关协定属性

properties.resourceId

string

外部系统中资源的管理 URI。 此 URL 可以是逻辑应用、函数应用或 API 应用的 Arm 资源 ID。

properties.title

string

后端标题。

properties.tls

BackendTlsProperties

后端 TLS 属性

properties.url

string

后端的运行时 URL。

响应

名称 类型 说明
200 OK

BackendContract

已成功更新现有后端。

标头

ETag: string

Other Status Codes

ErrorResponse

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流。

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

示例

ApiManagementUpdateBackend

示例请求

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

示例响应

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

定义

名称 说明
BackendAuthorizationHeaderCredentials

授权标头信息。

BackendContract

后端详细信息。

BackendCredentialsContract

用于连接到后端的凭据的详细信息。

BackendProperties

特定于后端类型的属性。

BackendProtocol

后端通信协议。

BackendProxyContract

要用于请求后端的后端 WebProxy 服务器的详细信息。

BackendServiceFabricClusterProperties

Service Fabric 类型后端的属性。

BackendTlsProperties

控制 TLS 证书验证的属性。

BackendUpdateParameters

后端更新参数。

ErrorFieldContract

错误字段协定。

ErrorResponse

错误响应。

X509CertificateName

服务器 X509Names 的属性。

BackendAuthorizationHeaderCredentials

授权标头信息。

名称 类型 说明
parameter

string

身份验证参数值。

scheme

string

身份验证方案名称。

BackendContract

后端详细信息。

名称 类型 说明
id

string

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

资源的名称

properties.credentials

BackendCredentialsContract

后端凭据协定属性

properties.description

string

后端说明。

properties.properties

BackendProperties

后端属性协定

properties.protocol

BackendProtocol

后端通信协议。

properties.proxy

BackendProxyContract

后端网关协定属性

properties.resourceId

string

外部系统中资源的管理 URI。 此 URL 可以是逻辑应用、函数应用或 API 应用的 Arm 资源 ID。

properties.title

string

后端标题。

properties.tls

BackendTlsProperties

后端 TLS 属性

properties.url

string

后端的运行时 URL。

type

string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”

BackendCredentialsContract

用于连接到后端的凭据的详细信息。

名称 类型 说明
authorization

BackendAuthorizationHeaderCredentials

授权标头身份验证

certificate

string[]

客户端证书指纹列表。 如果提供了 certificatesIds,将忽略 。

certificateIds

string[]

客户端证书 ID 列表。

header

object

标头 参数说明。

query

object

查询参数说明。

BackendProperties

特定于后端类型的属性。

名称 类型 说明
serviceFabricCluster

BackendServiceFabricClusterProperties

后端 Service Fabric 群集属性

BackendProtocol

后端通信协议。

名称 类型 说明
http

string

后端是 RESTful 服务。

soap

string

后端是 SOAP 服务。

BackendProxyContract

要用于请求后端的后端 WebProxy 服务器的详细信息。

名称 类型 说明
password

string

用于连接到 WebProxy 服务器的密码

url

string

WebProxy 服务器 AbsoluteUri 属性,其中包括存储在 Uri 实例中的整个 URI,包括所有片段和查询字符串。

username

string

用于连接到 WebProxy 服务器的用户名

BackendServiceFabricClusterProperties

Service Fabric 类型后端的属性。

名称 类型 说明
clientCertificateId

string

管理终结点的客户端证书 ID。

clientCertificatethumbprint

string

管理终结点的客户端证书指纹。 如果提供了 certificatesIds,将忽略

managementEndpoints

string[]

群集管理终结点。

maxPartitionResolutionRetries

integer

尝试解析分区时的最大重试次数。

serverCertificateThumbprints

string[]

群集管理服务用于 tls 通信的证书指纹

serverX509Names

X509CertificateName[]

服务器 X509 证书名称集合

BackendTlsProperties

控制 TLS 证书验证的属性。

名称 类型 默认值 说明
validateCertificateChain

boolean

True

指示对此后端主机使用自签名证书时是否应执行 SSL 证书链验证的标志。

validateCertificateName

boolean

True

指示对此后端主机使用自签名证书时是否应执行 SSL 证书名称验证的标志。

BackendUpdateParameters

后端更新参数。

名称 类型 说明
properties.credentials

BackendCredentialsContract

后端凭据协定属性

properties.description

string

后端说明。

properties.properties

BackendProperties

后端属性协定

properties.protocol

BackendProtocol

后端通信协议。

properties.proxy

BackendProxyContract

后端网关协定属性

properties.resourceId

string

外部系统中资源的管理 URI。 此 URL 可以是逻辑应用、函数应用或 API 应用的 Arm 资源 ID。

properties.title

string

后端标题。

properties.tls

BackendTlsProperties

后端 TLS 属性

properties.url

string

后端的运行时 URL。

ErrorFieldContract

错误字段协定。

名称 类型 说明
code

string

属性级错误代码。

message

string

属性级错误的可读表示形式。

target

string

属性名称。

ErrorResponse

错误响应。

名称 类型 说明
error.code

string

服务定义的错误代码。 此代码用作响应中指定的 HTTP 错误代码的子状态。

error.details

ErrorFieldContract[]

在发生验证错误时,请求中发送的无效字段列表。

error.message

string

错误的用户可读表示形式。

X509CertificateName

服务器 X509Names 的属性。

名称 类型 说明
issuerCertificateThumbprint

string

证书颁发者的指纹。

name

string

证书的公用名。