通过

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

Microsoft.ApiManagement 服务/后端

  • 项目

Bicep 资源定义

可以使用目标操作部署服务/后端资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service/backends 资源，请将以下 Bicep 添加到模板。

resource symbolicname 'Microsoft.ApiManagement/service/backends@2024-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    circuitBreaker: {
      rules: [
        {
          acceptRetryAfter: bool
          failureCondition: {
            count: int
            errorReasons: [
              'string'
            ]
            interval: 'string'
            percentage: int
            statusCodeRanges: [
              {
                max: int
                min: int
              }
            ]
          }
          name: 'string'
          tripDuration: 'string'
        }
      ]
    }
    credentials: {
      authorization: {
        parameter: 'string'
        scheme: 'string'
      }
      certificate: [
        'string'
      ]
      certificateIds: [
        'string'
      ]
      header: {
        {customized property}: [
          'string'
        ]
      }
      query: {
        {customized property}: [
          'string'
        ]
      }
    }
    description: 'string'
    pool: {
      services: [
        {
          id: 'string'
          priority: int
          weight: int
        }
      ]
    }
    properties: {
      serviceFabricCluster: {
        clientCertificateId: 'string'
        clientCertificatethumbprint: 'string'
        managementEndpoints: [
          'string'
        ]
        maxPartitionResolutionRetries: int
        serverCertificateThumbprints: [
          'string'
        ]
        serverX509Names: [
          {
            issuerCertificateThumbprint: 'string'
            name: 'string'
          }
        ]
      }
    }
    protocol: 'string'
    proxy: {
      password: 'string'
      url: 'string'
      username: 'string'
    }
    resourceId: 'string'
    title: 'string'
    tls: {
      validateCertificateChain: bool
      validateCertificateName: bool
    }
    type: 'string'
    url: 'string'
  }
}

属性值

BackendAuthorizationHeaderCredentials

名字 描述 价值
参数 身份验证参数值。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
方案 身份验证方案名称。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）

BackendBaseParametersPool

名字 描述 价值
服务业 属于池的后端实体的列表。 BackendPoolItem[]

BackendCircuitBreaker

名字 描述 价值
规则 用于行程后端的规则。 CircuitBreakerRule[]

BackendContractProperties

名字 描述 价值
circuitBreaker 后端断路器配置 BackendCircuitBreaker
凭据 后端凭据协定属性 BackendCredentialsContract
描述 后端说明。 字符串

约束：
最小长度 = 1
最大长度 = 1
池 BackendBaseParametersPool
性能 后端属性协定 BackendProperties
协议 后端通信协议。 “http”
“soap”（必需）
代理 后端网关协定属性 BackendProxyContract
resourceId 外部系统中资源的管理 URI。 此 URL 可以是逻辑应用、函数应用或 API 应用的 Arm 资源 ID。 字符串

约束：
最小长度 = 1
最大长度 = 1
标题 后端标题。 字符串

约束：
最小长度 = 1
最大长度 = 1
tls 后端 TLS 属性 BackendTlsProperties
类型 后端的类型。 后端可以是单一后端，也可以是池。 “Pool”
“Single”
url 后端的运行时 URL。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）

BackendCredentialsContract

名字 描述 价值
授权 授权标头身份验证 BackendAuthorizationHeaderCredentials
证书 客户端证书指纹列表。 如果提供了 certificatesIds，则将被忽略。 string[]
certificateIds 客户端证书 ID 的列表。 string[]
页眉 标头参数说明。 BackendCredentialsContractHeader
查询 查询参数说明。 BackendCredentialsContractQuery

BackendCredentialsContractHeader

名字 描述 价值

BackendCredentialsContractQuery

名字 描述 价值

BackendPoolItem

名字 描述 价值
id 后端实体的唯一 ARM ID。 ARM ID 应引用已存在的后端实体。 string （必需）
优先权 后端池中后端实体的优先级。 必须介于 0 和 100 之间。 如果未指定值，也可以为 null。 int

约束：
最小值 = 0
最大值 = 100
重量 后端池中后端实体的权重。 必须介于 0 和 100 之间。 如果未指定值，也可以为 null。 int

约束：
最小值 = 0
最大值 = 100

BackendProperties

名字 描述 价值
serviceFabricCluster 后端 Service Fabric 群集属性 BackendServiceFabricClusterProperties

BackendProxyContract

名字 描述 价值
密码 连接到 WebProxy 服务器的密码 字符串
url WebProxy Server AbsoluteUri 属性，其中包括存储在 Uri 实例中的整个 URI，包括所有片段和查询字符串。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
username 连接到 WebProxy 服务器的用户名 字符串

BackendServiceFabricClusterProperties

名字 描述 价值
clientCertificateId 管理终结点的客户端证书 ID。 字符串
clientCertificatethumbprint 管理终结点的客户端证书指纹。 如果提供了 certificatesIds，将忽略 字符串
managementEndpoints 群集管理终结点。 string[] （必需）
maxPartitionResolutionRetries 尝试解析分区时的最大重试次数。 int
serverCertificateThumbprints 群集管理服务用于 tls 通信的证书指纹 string[]
serverX509Names 服务器 X509 证书名称集合 X509CertificateName[]

BackendTlsProperties

名字 描述 价值
validateCertificateChain 指示在此后端主机使用自签名证书时是否应执行 SSL 证书链验证的标志。 bool
validateCertificateName 指示在此后端主机使用自签名证书时是否应执行 SSL 证书名称验证的标志。 bool

CircuitBreakerFailureCondition

名字 描述 价值
计数 打开线路的阈值。 int
errorReasons 被视为失败的错误原因。 字符串

约束：
最大长度 = []
间隔 计算失败的间隔。 字符串
百分比 打开线路的阈值。 int
statusCodeRanges 被视为失败的状态代码范围。 FailureStatusCodeRange[]

CircuitBreakerRule

名字 描述 价值
acceptRetryAfter 从后端接受 Retry-After 标头的标志。 bool
failureCondition 断路器的行程条件。 CircuitBreakerFailureCondition
名字 规则名称。 字符串
tripDuration 线路将被绊倒的持续时间。 字符串

FailureStatusCodeRange

名字 描述 价值
麦克斯 最大 http 状态代码。 int

约束：
最小值 = 200
最大值 = 599
min 最低 http 状态代码。 int

约束：
最小值 = 200
最大值 = 599

Microsoft.ApiManagement/service/backends

名字 描述 价值
名字 资源名称 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
父母 在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。

有关详细信息，请参阅 父资源外部的子资源。		 类型资源的符号名称：服务
性能 后端实体协定属性。 BackendContractProperties

X509CertificateName

名字 描述 价值
issuerCertificateThumbprint 证书颁发者的指纹。 字符串
名字 证书的公用名。 字符串

ARM 模板资源定义

可以使用目标操作部署服务/后端资源类型：

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service/backends 资源，请将以下 JSON 添加到模板。

{
  "type": "Microsoft.ApiManagement/service/backends",
  "apiVersion": "2024-06-01-preview",
  "name": "string",
  "properties": {
    "circuitBreaker": {
      "rules": [
        {
          "acceptRetryAfter": "bool",
          "failureCondition": {
            "count": "int",
            "errorReasons": [ "string" ],
            "interval": "string",
            "percentage": "int",
            "statusCodeRanges": [
              {
                "max": "int",
                "min": "int"
              }
            ]
          },
          "name": "string",
          "tripDuration": "string"
        }
      ]
    },
    "credentials": {
      "authorization": {
        "parameter": "string",
        "scheme": "string"
      },
      "certificate": [ "string" ],
      "certificateIds": [ "string" ],
      "header": {
        "{customized property}": [ "string" ]
      },
      "query": {
        "{customized property}": [ "string" ]
      }
    },
    "description": "string",
    "pool": {
      "services": [
        {
          "id": "string",
          "priority": "int",
          "weight": "int"
        }
      ]
    },
    "properties": {
      "serviceFabricCluster": {
        "clientCertificateId": "string",
        "clientCertificatethumbprint": "string",
        "managementEndpoints": [ "string" ],
        "maxPartitionResolutionRetries": "int",
        "serverCertificateThumbprints": [ "string" ],
        "serverX509Names": [
          {
            "issuerCertificateThumbprint": "string",
            "name": "string"
          }
        ]
      }
    },
    "protocol": "string",
    "proxy": {
      "password": "string",
      "url": "string",
      "username": "string"
    },
    "resourceId": "string",
    "title": "string",
    "tls": {
      "validateCertificateChain": "bool",
      "validateCertificateName": "bool"
    },
    "type": "string",
    "url": "string"
  }
}

属性值

BackendAuthorizationHeaderCredentials

名字 描述 价值
参数 身份验证参数值。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
方案 身份验证方案名称。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）

BackendBaseParametersPool

名字 描述 价值
服务业 属于池的后端实体的列表。 BackendPoolItem[]

BackendCircuitBreaker

名字 描述 价值
规则 用于行程后端的规则。 CircuitBreakerRule[]

BackendContractProperties

名字 描述 价值
circuitBreaker 后端断路器配置 BackendCircuitBreaker
凭据 后端凭据协定属性 BackendCredentialsContract
描述 后端说明。 字符串

约束：
最小长度 = 1
最大长度 = 1
池 BackendBaseParametersPool
性能 后端属性协定 BackendProperties
协议 后端通信协议。 “http”
“soap”（必需）
代理 后端网关协定属性 BackendProxyContract
resourceId 外部系统中资源的管理 URI。 此 URL 可以是逻辑应用、函数应用或 API 应用的 Arm 资源 ID。 字符串

约束：
最小长度 = 1
最大长度 = 1
标题 后端标题。 字符串

约束：
最小长度 = 1
最大长度 = 1
tls 后端 TLS 属性 BackendTlsProperties
类型 后端的类型。 后端可以是单一后端，也可以是池。 “Pool”
“Single”
url 后端的运行时 URL。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）

BackendCredentialsContract

名字 描述 价值
授权 授权标头身份验证 BackendAuthorizationHeaderCredentials
证书 客户端证书指纹列表。 如果提供了 certificatesIds，则将被忽略。 string[]
certificateIds 客户端证书 ID 的列表。 string[]
页眉 标头参数说明。 BackendCredentialsContractHeader
查询 查询参数说明。 BackendCredentialsContractQuery

BackendCredentialsContractHeader

名字 描述 价值

BackendCredentialsContractQuery

名字 描述 价值

BackendPoolItem

名字 描述 价值
id 后端实体的唯一 ARM ID。 ARM ID 应引用已存在的后端实体。 string （必需）
优先权 后端池中后端实体的优先级。 必须介于 0 和 100 之间。 如果未指定值，也可以为 null。 int

约束：
最小值 = 0
最大值 = 100
重量 后端池中后端实体的权重。 必须介于 0 和 100 之间。 如果未指定值，也可以为 null。 int

约束：
最小值 = 0
最大值 = 100

BackendProperties

名字 描述 价值
serviceFabricCluster 后端 Service Fabric 群集属性 BackendServiceFabricClusterProperties

BackendProxyContract

名字 描述 价值
密码 连接到 WebProxy 服务器的密码 字符串
url WebProxy Server AbsoluteUri 属性，其中包括存储在 Uri 实例中的整个 URI，包括所有片段和查询字符串。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
username 连接到 WebProxy 服务器的用户名 字符串

BackendServiceFabricClusterProperties

名字 描述 价值
clientCertificateId 管理终结点的客户端证书 ID。 字符串
clientCertificatethumbprint 管理终结点的客户端证书指纹。 如果提供了 certificatesIds，将忽略 字符串
managementEndpoints 群集管理终结点。 string[] （必需）
maxPartitionResolutionRetries 尝试解析分区时的最大重试次数。 int
serverCertificateThumbprints 群集管理服务用于 tls 通信的证书指纹 string[]
serverX509Names 服务器 X509 证书名称集合 X509CertificateName[]

BackendTlsProperties

名字 描述 价值
validateCertificateChain 指示在此后端主机使用自签名证书时是否应执行 SSL 证书链验证的标志。 bool
validateCertificateName 指示在此后端主机使用自签名证书时是否应执行 SSL 证书名称验证的标志。 bool

CircuitBreakerFailureCondition

名字 描述 价值
计数 打开线路的阈值。 int
errorReasons 被视为失败的错误原因。 字符串

约束：
最大长度 = []
间隔 计算失败的间隔。 字符串
百分比 打开线路的阈值。 int
statusCodeRanges 被视为失败的状态代码范围。 FailureStatusCodeRange[]

CircuitBreakerRule

名字 描述 价值
acceptRetryAfter 从后端接受 Retry-After 标头的标志。 bool
failureCondition 断路器的行程条件。 CircuitBreakerFailureCondition
名字 规则名称。 字符串
tripDuration 线路将被绊倒的持续时间。 字符串

FailureStatusCodeRange

名字 描述 价值
麦克斯 最大 http 状态代码。 int

约束：
最小值 = 200
最大值 = 599
min 最低 http 状态代码。 int

约束：
最小值 = 200
最大值 = 599

Microsoft.ApiManagement/service/backends

名字 描述 价值
apiVersion API 版本 '2024-06-01-preview'
名字 资源名称 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
性能 后端实体协定属性。 BackendContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/backends”

X509CertificateName

名字 描述 价值
issuerCertificateThumbprint 证书颁发者的指纹。 字符串
名字 证书的公用名。 字符串

Terraform （AzAPI 提供程序）资源定义

可以使用目标操作部署服务/后端资源类型：

  • 资源组

有关每个 API 版本中已更改属性的列表，请参阅 更改日志。

资源格式

若要创建 Microsoft.ApiManagement/service/backends 资源，请将以下 Terraform 添加到模板。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/backends@2024-06-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      circuitBreaker = {
        rules = [
          {
            acceptRetryAfter = bool
            failureCondition = {
              count = int
              errorReasons = [
                "string"
              ]
              interval = "string"
              percentage = int
              statusCodeRanges = [
                {
                  max = int
                  min = int
                }
              ]
            }
            name = "string"
            tripDuration = "string"
          }
        ]
      }
      credentials = {
        authorization = {
          parameter = "string"
          scheme = "string"
        }
        certificate = [
          "string"
        ]
        certificateIds = [
          "string"
        ]
        header = {
          {customized property} = [
            "string"
          ]
        }
        query = {
          {customized property} = [
            "string"
          ]
        }
      }
      description = "string"
      pool = {
        services = [
          {
            id = "string"
            priority = int
            weight = int
          }
        ]
      }
      properties = {
        serviceFabricCluster = {
          clientCertificateId = "string"
          clientCertificatethumbprint = "string"
          managementEndpoints = [
            "string"
          ]
          maxPartitionResolutionRetries = int
          serverCertificateThumbprints = [
            "string"
          ]
          serverX509Names = [
            {
              issuerCertificateThumbprint = "string"
              name = "string"
            }
          ]
        }
      }
      protocol = "string"
      proxy = {
        password = "string"
        url = "string"
        username = "string"
      }
      resourceId = "string"
      title = "string"
      tls = {
        validateCertificateChain = bool
        validateCertificateName = bool
      }
      type = "string"
      url = "string"
    }
  })
}

属性值

BackendAuthorizationHeaderCredentials

名字 描述 价值
参数 身份验证参数值。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
方案 身份验证方案名称。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）

BackendBaseParametersPool

名字 描述 价值
服务业 属于池的后端实体的列表。 BackendPoolItem[]

BackendCircuitBreaker

名字 描述 价值
规则 用于行程后端的规则。 CircuitBreakerRule[]

BackendContractProperties

名字 描述 价值
circuitBreaker 后端断路器配置 BackendCircuitBreaker
凭据 后端凭据协定属性 BackendCredentialsContract
描述 后端说明。 字符串

约束：
最小长度 = 1
最大长度 = 1
池 BackendBaseParametersPool
性能 后端属性协定 BackendProperties
协议 后端通信协议。 “http”
“soap”（必需）
代理 后端网关协定属性 BackendProxyContract
resourceId 外部系统中资源的管理 URI。 此 URL 可以是逻辑应用、函数应用或 API 应用的 Arm 资源 ID。 字符串

约束：
最小长度 = 1
最大长度 = 1
标题 后端标题。 字符串

约束：
最小长度 = 1
最大长度 = 1
tls 后端 TLS 属性 BackendTlsProperties
类型 后端的类型。 后端可以是单一后端，也可以是池。 “Pool”
“Single”
url 后端的运行时 URL。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）

BackendCredentialsContract

名字 描述 价值
授权 授权标头身份验证 BackendAuthorizationHeaderCredentials
证书 客户端证书指纹列表。 如果提供了 certificatesIds，则将被忽略。 string[]
certificateIds 客户端证书 ID 的列表。 string[]
页眉 标头参数说明。 BackendCredentialsContractHeader
查询 查询参数说明。 BackendCredentialsContractQuery

BackendCredentialsContractHeader

名字 描述 价值

BackendCredentialsContractQuery

名字 描述 价值

BackendPoolItem

名字 描述 价值
id 后端实体的唯一 ARM ID。 ARM ID 应引用已存在的后端实体。 string （必需）
优先权 后端池中后端实体的优先级。 必须介于 0 和 100 之间。 如果未指定值，也可以为 null。 int

约束：
最小值 = 0
最大值 = 100
重量 后端池中后端实体的权重。 必须介于 0 和 100 之间。 如果未指定值，也可以为 null。 int

约束：
最小值 = 0
最大值 = 100

BackendProperties

名字 描述 价值
serviceFabricCluster 后端 Service Fabric 群集属性 BackendServiceFabricClusterProperties

BackendProxyContract

名字 描述 价值
密码 连接到 WebProxy 服务器的密码 字符串
url WebProxy Server AbsoluteUri 属性，其中包括存储在 Uri 实例中的整个 URI，包括所有片段和查询字符串。 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
username 连接到 WebProxy 服务器的用户名 字符串

BackendServiceFabricClusterProperties

名字 描述 价值
clientCertificateId 管理终结点的客户端证书 ID。 字符串
clientCertificatethumbprint 管理终结点的客户端证书指纹。 如果提供了 certificatesIds，将忽略 字符串
managementEndpoints 群集管理终结点。 string[] （必需）
maxPartitionResolutionRetries 尝试解析分区时的最大重试次数。 int
serverCertificateThumbprints 群集管理服务用于 tls 通信的证书指纹 string[]
serverX509Names 服务器 X509 证书名称集合 X509CertificateName[]

BackendTlsProperties

名字 描述 价值
validateCertificateChain 指示在此后端主机使用自签名证书时是否应执行 SSL 证书链验证的标志。 bool
validateCertificateName 指示在此后端主机使用自签名证书时是否应执行 SSL 证书名称验证的标志。 bool

CircuitBreakerFailureCondition

名字 描述 价值
计数 打开线路的阈值。 int
errorReasons 被视为失败的错误原因。 字符串

约束：
最大长度 = []
间隔 计算失败的间隔。 字符串
百分比 打开线路的阈值。 int
statusCodeRanges 被视为失败的状态代码范围。 FailureStatusCodeRange[]

CircuitBreakerRule

名字 描述 价值
acceptRetryAfter 从后端接受 Retry-After 标头的标志。 bool
failureCondition 断路器的行程条件。 CircuitBreakerFailureCondition
名字 规则名称。 字符串
tripDuration 线路将被绊倒的持续时间。 字符串

FailureStatusCodeRange

名字 描述 价值
麦克斯 最大 http 状态代码。 int

约束：
最小值 = 200
最大值 = 599
min 最低 http 状态代码。 int

约束：
最小值 = 200
最大值 = 599

Microsoft.ApiManagement/service/backends

名字 描述 价值
名字 资源名称 字符串

约束：
最小长度 = 1
最大长度 = 1 （必需）
parent_id 此资源的父资源的 ID。 类型资源的 ID：服务
性能 后端实体协定属性。 BackendContractProperties
类型 资源类型 “Microsoft.ApiManagement/service/backends@2024-06-01-preview”

X509CertificateName

名字 描述 价值
issuerCertificateThumbprint 证书颁发者的指纹。 字符串
名字 证书的公用名。 字符串