你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。
Microsoft.ApiManagement 服务/后端 2023-05-01-preview
Bicep 资源定义
可以使用针对以下操作部署服务/后端资源类型：
有关每个 API 版本中更改的属性的列表，请参阅 更改日志。
若要创建 Microsoft.ApiManagement/service/backends 资源，请将以下 Bicep 添加到模板。
resource symbolicname 'Microsoft.ApiManagement/service/backends@2023-05-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
circuitBreaker: {
rules: [
{
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'
}
]
}
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'
}
}
属性值
service/backends
| 名称 |
说明 |
值 |
| name |
资源名称
了解如何在 Bicep 中为子资源设置名称和类型。 |
字符串 (必需)
字符限制：1-80
有效字符：
字母数字和连字符。
以字母开头且以字母数字结尾。 |
| 父级 (parent) |
在 Bicep 中，可以为子资源指定父资源。 仅当子资源在父资源外部声明时，才需要添加此属性。
有关详细信息，请参阅 父资源之外的子资源。 |
类型为“服务”的资源的符号名称 |
| properties |
后端实体协定属性。 |
BackendContractProperties |
BackendContractProperties
BackendCircuitBreaker
CircuitBreakerRule
CircuitBreakerFailureCondition
| 名称 |
说明 |
Value |
| count |
用于打开线路的阈值。 |
int |
| errorReasons |
被视为失败的错误原因。 |
string[] |
| interval |
计算失败的时间间隔。 |
字符串 |
| percentage |
用于打开线路的阈值。 |
int |
| statusCodeRanges |
被视为失败的状态代码范围。 |
FailureStatusCodeRange[] |
FailureStatusCodeRange
| 名称 |
说明 |
值 |
| max |
最大 http 状态代码。 |
int |
| 分钟 |
最低 http 状态代码。 |
int |
BackendCredentialsContract
| 名称 |
说明 |
值 |
| 参数 (parameter) |
身份验证参数值。 |
字符串 (必需) |
| scheme |
身份验证方案名称。 |
字符串 (必需) |
| 名称 |
说明 |
值 |
| {customized property} |
|
string[] |
BackendCredentialsContractQuery
| 名称 |
说明 |
值 |
| {customized property} |
|
string[] |
BackendBaseParametersPool
BackendPoolItem
| 名称 |
说明 |
Value |
| id |
后端实体的唯一 ARM ID。 ARM ID 应引用已存在的后端实体。 |
字符串 (必需) |
BackendProperties
BackendServiceFabricClusterProperties
| 名称 |
说明 |
值 |
| clientCertificateId |
管理终结点的客户端证书 ID。 |
字符串 |
| clientCertificatethumbprint |
管理终结点的客户端证书指纹。 如果提供了 certificatesIds，将忽略 |
字符串 |
| managementEndpoints |
群集管理终结点。 |
string[] (必需) |
| maxPartitionResolutionRetries |
尝试解析分区时的最大重试次数。 |
int |
| serverCertificateThumbprints |
群集管理服务用于 tls 通信的证书指纹 |
string[] |
| serverX509Names |
服务器 X509 证书名称集合 |
X509CertificateName[] |
X509CertificateName
| 名称 |
说明 |
值 |
| issuerCertificateThumbprint |
证书颁发者的指纹。 |
字符串 |
| name |
证书的公用名。 |
字符串 |
BackendProxyContract
| 名称 |
说明 |
值 |
| password |
用于连接到 WebProxy 服务器的密码 |
字符串 |
| url |
WebProxy 服务器 AbsoluteUri 属性，其中包括存储在 Uri 实例中的整个 URI，包括所有片段和查询字符串。 |
字符串 (必需) |
| username |
用于连接到 WebProxy 服务器的用户名 |
字符串 |
BackendTlsProperties
| 名称 |
说明 |
值 |
| validateCertificateChain |
指示对此后端主机使用自签名证书时是否应执行 SSL 证书链验证的标志。 |
bool |
| validateCertificateName |
指示对此后端主机使用自签名证书时是否应执行 SSL 证书名称验证的标志。 |
bool |
ARM 模板资源定义
可以使用面向以下操作部署服务/后端资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
若要创建 Microsoft.ApiManagement/service/backends 资源，请将以下 JSON 添加到模板。
{
"type": "Microsoft.ApiManagement/service/backends",
"apiVersion": "2023-05-01-preview",
"name": "string",
"properties": {
"circuitBreaker": {
"rules": [
{
"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"
}
]
},
"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"
}
}
属性值
service/backends
| 名称 |
说明 |
Value |
| type |
资源类型 |
“Microsoft.ApiManagement/service/backends” |
| apiVersion |
资源 API 版本 |
'2023-05-01-preview' |
| name |
资源名称
了解如何在 JSON ARM 模板中设置子资源的名称和类型。 |
字符串 (必需)
字符限制：1-80
有效字符：
字母数字和连字符。
以字母开头且以字母数字结尾。 |
| properties |
后端实体协定属性。 |
BackendContractProperties |
BackendContractProperties
BackendCircuitBreaker
CircuitBreakerRule
CircuitBreakerFailureCondition
| 名称 |
说明 |
Value |
| count |
用于打开线路的阈值。 |
int |
| errorReasons |
被视为失败的错误原因。 |
string[] |
| interval |
计算失败的时间间隔。 |
字符串 |
| percentage |
用于打开线路的阈值。 |
int |
| statusCodeRanges |
被视为失败的状态代码范围。 |
FailureStatusCodeRange[] |
FailureStatusCodeRange
| 名称 |
说明 |
值 |
| max |
最大 http 状态代码。 |
int |
| 分钟 |
最低 http 状态代码。 |
int |
BackendCredentialsContract
| 名称 |
说明 |
值 |
| 参数 (parameter) |
身份验证参数值。 |
字符串 (必需) |
| scheme |
身份验证方案名称。 |
字符串 (必需) |
| 名称 |
说明 |
值 |
| {customized property} |
|
string[] |
BackendCredentialsContractQuery
| 名称 |
说明 |
值 |
| {customized property} |
|
string[] |
BackendBaseParametersPool
BackendPoolItem
| 名称 |
说明 |
Value |
| id |
后端实体的唯一 ARM ID。 ARM ID 应引用已存在的后端实体。 |
字符串 (必需) |
BackendProperties
BackendServiceFabricClusterProperties
| 名称 |
说明 |
值 |
| clientCertificateId |
管理终结点的客户端证书 ID。 |
字符串 |
| clientCertificatethumbprint |
管理终结点的客户端证书指纹。 如果提供了 certificatesIds，将忽略 |
字符串 |
| managementEndpoints |
群集管理终结点。 |
string[] (必需) |
| maxPartitionResolutionRetries |
尝试解析分区时的最大重试次数。 |
int |
| serverCertificateThumbprints |
群集管理服务用于 tls 通信的证书指纹 |
string[] |
| serverX509Names |
服务器 X509 证书名称集合 |
X509CertificateName[] |
X509CertificateName
| 名称 |
说明 |
值 |
| issuerCertificateThumbprint |
证书颁发者的指纹。 |
字符串 |
| name |
证书的公用名。 |
字符串 |
BackendProxyContract
| 名称 |
说明 |
值 |
| password |
用于连接到 WebProxy 服务器的密码 |
字符串 |
| url |
WebProxy 服务器 AbsoluteUri 属性，其中包括存储在 Uri 实例中的整个 URI，包括所有片段和查询字符串。 |
字符串 (必需) |
| username |
用于连接到 WebProxy 服务器的用户名 |
字符串 |
BackendTlsProperties
| 名称 |
说明 |
值 |
| validateCertificateChain |
指示对此后端主机使用自签名证书时是否应执行 SSL 证书链验证的标志。 |
bool |
| validateCertificateName |
指示对此后端主机使用自签名证书时是否应执行 SSL 证书名称验证的标志。 |
bool |
可以使用面向以下操作部署服务/后端资源类型：
有关每个 API 版本中已更改属性的列表，请参阅 更改日志。
若要创建 Microsoft.ApiManagement/service/backends 资源，请将以下 Terraform 添加到模板。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/backends@2023-05-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
circuitBreaker = {
rules = [
{
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"
}
]
}
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"
}
})
}
属性值
service/backends
| 名称 |
说明 |
Value |
| type |
资源类型 |
“Microsoft.ApiManagement/service/backends@2023-05-01-preview” |
| name |
资源名称 |
字符串 (必需)
字符限制：1-80
有效字符：
字母数字和连字符。
以字母开头且以字母数字结尾。 |
| parent_id |
此资源的父资源 ID。 |
类型为“服务”的资源的 ID |
| properties |
后端实体协定属性。 |
BackendContractProperties |
BackendContractProperties
BackendCircuitBreaker
CircuitBreakerRule
CircuitBreakerFailureCondition
| 名称 |
说明 |
Value |
| count |
用于打开线路的阈值。 |
int |
| errorReasons |
被视为失败的错误原因。 |
string[] |
| interval |
故障计数的间隔。 |
字符串 |
| percentage |
用于打开线路的阈值。 |
int |
| statusCodeRanges |
被视为失败的状态代码范围。 |
FailureStatusCodeRange[] |
FailureStatusCodeRange
| 名称 |
说明 |
值 |
| max |
最大 http 状态代码。 |
int |
| 分钟 |
最低 http 状态代码。 |
int |
BackendCredentialsContract
| 名称 |
说明 |
值 |
| 参数 (parameter) |
身份验证参数值。 |
字符串 (必需) |
| scheme |
身份验证方案名称。 |
字符串 (必需) |
| 名称 |
说明 |
值 |
| {customized property} |
|
string[] |
BackendCredentialsContractQuery
| 名称 |
说明 |
值 |
| {customized property} |
|
string[] |
BackendBaseParametersPool
BackendPoolItem
| 名称 |
说明 |
Value |
| id |
后端实体的唯一 ARM ID。 ARM ID 应引用已存在的后端实体。 |
字符串 (必需) |
BackendProperties
BackendServiceFabricClusterProperties
| 名称 |
说明 |
值 |
| clientCertificateId |
管理终结点的客户端证书 ID。 |
字符串 |
| clientCertificatethumbprint |
管理终结点的客户端证书指纹。 如果提供了 certificatesIds，将忽略 |
字符串 |
| managementEndpoints |
群集管理终结点。 |
string[] (必需) |
| maxPartitionResolutionRetries |
尝试解析分区时的最大重试次数。 |
int |
| serverCertificateThumbprints |
群集管理服务用于 tls 通信的证书指纹 |
string[] |
| serverX509Names |
服务器 X509 证书名称集合 |
X509CertificateName[] |
X509CertificateName
| 名称 |
说明 |
值 |
| issuerCertificateThumbprint |
证书颁发者的指纹。 |
字符串 |
| name |
证书的公用名。 |
字符串 |
BackendProxyContract
| 名称 |
说明 |
值 |
| password |
连接到 WebProxy 服务器的密码 |
字符串 |
| url |
WebProxy 服务器 AbsoluteUri 属性，包括存储在 Uri 实例中的整个 URI，包括所有片段和查询字符串。 |
字符串 (必需) |
| username |
用于连接到 WebProxy 服务器的用户名 |
字符串 |
BackendTlsProperties
| 名称 |
说明 |
值 |
| validateCertificateChain |
指示使用此后端主机的自签名证书时是否应完成 SSL 证书链验证的标志。 |
bool |
| validateCertificateName |
指示使用此后端主机的自签名证书时是否应完成 SSL 证书名称验证的标志。 |
bool |