Microsoft.ApiManagement 服務/backends 2021-04-01-preview
- 最新
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Bicep 資源定義
服務/後端資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/backends 資源，請將下列 Bicep 新增至範本。
resource symbolicname 'Microsoft.ApiManagement/service/backends@2021-04-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
credentials: {
authorization: {
parameter: 'string'
scheme: 'string'
}
certificate: [
'string'
]
certificateIds: [
'string'
]
header: {
{customized property}: [
'string'
]
}
query: {
{customized property}: [
'string'
]
}
}
description: '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
}
url: 'string'
}
}
屬性值
BackendAuthorizationHeaderCredentials
| 名字 | 描述 | 價值 |
|---|---|---|
| 參數 | 驗證參數值。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
| 方案 | 驗證配置名稱。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
BackendContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 憑據 | 後端認證合約屬性 | BackendCredentialsContract |
| 描述 | 後端描述。 | 字串 約束： 最小長度 = 1 最大長度 = 1 |
| 性能 | 後端屬性合約 | BackendProperties |
| 協定 | 後端通訊協定。 | 'http' 'soap' （必要） |
| 代理 | 後端 Proxy 合約屬性 | BackendProxyContract |
| resourceId | 外部系統中資源的管理 URI。 此 URL 可以是 Logic Apps、Function Apps 或 API Apps 的 Arm 資源識別符。 | 字串 約束： 最小長度 = 1 最大長度 = 1 |
| 標題 | 後端標題。 | 字串 約束： 最小長度 = 1 最大長度 = 1 |
| tls | 後端 TLS 屬性 | BackendTlsProperties |
| url | 後端的運行時間 URL。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
BackendCredentialsContract
| 名字 | 描述 | 價值 |
|---|---|---|
| 授權 | 授權標頭驗證 | BackendAuthorizationHeaderCredentials |
| 證書 | 用戶端憑證指紋的清單。 如果提供 certificatesIds，將會忽略。 | string[] |
| certificateIds | 用戶端憑證標識碼的清單。 | string[] |
| 頁眉 | 標頭參數描述。 | BackendCredentialsContractHeader |
| 查詢 | 查詢參數描述。 | BackendCredentialsContractQuery |
BackendCredentialsContractHeader
| 名字 | 描述 | 價值 |
|---|
BackendCredentialsContractQuery
| 名字 | 描述 | 價值 |
|---|
BackendProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| serviceFabricCluster | 後端 Service Fabric 叢集屬性 | BackendServiceFabricClusterProperties |
BackendProxyContract
| 名字 | 描述 | 價值 |
|---|---|---|
| 密碼 | 線上至 WebProxy 伺服器的密碼 | 字串 |
| url | WebProxy Server AbsoluteUri 屬性，其中包含儲存在 Uri 實例中的整個 URI，包括所有片段和查詢字串。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
| username | 線上至 WebProxy 伺服器的使用者名稱 | 字串 |
BackendServiceFabricClusterProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| clientCertificateId | 管理端點的客戶端憑證標識碼。 | 字串 |
| clientCertificatethumbprint | 管理端點的客戶端憑證指紋。 如果提供 certificatesIds，將會忽略 | 字串 |
| managementEndpoints | 叢集管理端點。 | string[] （必要） |
| maxPartitionResolutionRetries | 嘗試解析分割區時重試次數上限。 | int |
| serverCertificateThumbprints | 叢集管理服務用於 tls 通訊的憑證指紋 | string[] |
| serverX509Names | 伺服器 X509 憑證名稱集合 | X509CertificateName[] |
BackendTlsProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| validateCertificateChain | 旗標，指出使用此後端主機的自我簽署憑證時，是否應該完成 SSL 憑證鏈結驗證。 | bool |
| validateCertificateName | 旗標，指出使用此後端主機的自我簽署憑證時，是否應該完成SSL憑證名稱驗證。 | bool |
Microsoft.ApiManagement/service/backends
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
| 父母 | 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增這個屬性。 如需詳細資訊，請參閱 父資源外部的子資源。 |
類型的資源符號名稱：服務 |
| 性能 | 後端實體合約屬性。 | BackendContractProperties |
X509CertificateName
| 名字 | 描述 | 價值 |
|---|---|---|
| issuerCertificateThumbprint | 憑證簽發者的指紋。 | 字串 |
| 名字 | 憑證的一般名稱。 | 字串 |
ARM 樣本資源定義
服務/後端資源類型可以使用目標作業來部署：
- 資源群組 - 請參閱 資源群組部署命令
如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。
資源格式
若要建立 Microsoft.ApiManagement/service/backends 資源，請將下列 JSON 新增至範本。
{
"type": "Microsoft.ApiManagement/service/backends",
"apiVersion": "2021-04-01-preview",
"name": "string",
"properties": {
"credentials": {
"authorization": {
"parameter": "string",
"scheme": "string"
},
"certificate": [ "string" ],
"certificateIds": [ "string" ],
"header": {
"{customized property}": [ "string" ]
},
"query": {
"{customized property}": [ "string" ]
}
},
"description": "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"
},
"url": "string"
}
}
屬性值
BackendAuthorizationHeaderCredentials
| 名字 | 描述 | 價值 |
|---|---|---|
| 參數 | 驗證參數值。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
| 方案 | 驗證配置名稱。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
BackendContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 憑據 | 後端認證合約屬性 | BackendCredentialsContract |
| 描述 | 後端描述。 | 字串 約束： 最小長度 = 1 最大長度 = 1 |
| 性能 | 後端屬性合約 | BackendProperties |
| 協定 | 後端通訊協定。 | 'http' 'soap' （必要） |
| 代理 | 後端 Proxy 合約屬性 | BackendProxyContract |
| resourceId | 外部系統中資源的管理 URI。 此 URL 可以是 Logic Apps、Function Apps 或 API Apps 的 Arm 資源識別符。 | 字串 約束： 最小長度 = 1 最大長度 = 1 |
| 標題 | 後端標題。 | 字串 約束： 最小長度 = 1 最大長度 = 1 |
| tls | 後端 TLS 屬性 | BackendTlsProperties |
| url | 後端的運行時間 URL。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
BackendCredentialsContract
| 名字 | 描述 | 價值 |
|---|---|---|
| 授權 | 授權標頭驗證 | BackendAuthorizationHeaderCredentials |
| 證書 | 用戶端憑證指紋的清單。 如果提供 certificatesIds，將會忽略。 | string[] |
| certificateIds | 用戶端憑證標識碼的清單。 | string[] |
| 頁眉 | 標頭參數描述。 | BackendCredentialsContractHeader |
| 查詢 | 查詢參數描述。 | BackendCredentialsContractQuery |
BackendCredentialsContractHeader
| 名字 | 描述 | 價值 |
|---|
BackendCredentialsContractQuery
| 名字 | 描述 | 價值 |
|---|
BackendProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| serviceFabricCluster | 後端 Service Fabric 叢集屬性 | BackendServiceFabricClusterProperties |
BackendProxyContract
| 名字 | 描述 | 價值 |
|---|---|---|
| 密碼 | 線上至 WebProxy 伺服器的密碼 | 字串 |
| url | WebProxy Server AbsoluteUri 屬性，其中包含儲存在 Uri 實例中的整個 URI，包括所有片段和查詢字串。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
| username | 線上至 WebProxy 伺服器的使用者名稱 | 字串 |
BackendServiceFabricClusterProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| clientCertificateId | 管理端點的客戶端憑證標識碼。 | 字串 |
| clientCertificatethumbprint | 管理端點的客戶端憑證指紋。 如果提供 certificatesIds，將會忽略 | 字串 |
| managementEndpoints | 叢集管理端點。 | string[] （必要） |
| maxPartitionResolutionRetries | 嘗試解析分割區時重試次數上限。 | int |
| serverCertificateThumbprints | 叢集管理服務用於 tls 通訊的憑證指紋 | string[] |
| serverX509Names | 伺服器 X509 憑證名稱集合 | X509CertificateName[] |
BackendTlsProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| validateCertificateChain | 旗標，指出使用此後端主機的自我簽署憑證時，是否應該完成 SSL 憑證鏈結驗證。 | bool |
| validateCertificateName | 旗標，指出使用此後端主機的自我簽署憑證時，是否應該完成SSL憑證名稱驗證。 | bool |
Microsoft.ApiManagement/service/backends
| 名字 | 描述 | 價值 |
|---|---|---|
| apiVersion | API 版本 | '2021-04-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@2021-04-01-preview"
name = "string"
body = jsonencode({
properties = {
credentials = {
authorization = {
parameter = "string"
scheme = "string"
}
certificate = [
"string"
]
certificateIds = [
"string"
]
header = {
{customized property} = [
"string"
]
}
query = {
{customized property} = [
"string"
]
}
}
description = "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
}
url = "string"
}
})
}
屬性值
BackendAuthorizationHeaderCredentials
| 名字 | 描述 | 價值 |
|---|---|---|
| 參數 | 驗證參數值。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
| 方案 | 驗證配置名稱。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
BackendContractProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| 憑據 | 後端認證合約屬性 | BackendCredentialsContract |
| 描述 | 後端描述。 | 字串 約束： 最小長度 = 1 最大長度 = 1 |
| 性能 | 後端屬性合約 | BackendProperties |
| 協定 | 後端通訊協定。 | 'http' 'soap' （必要） |
| 代理 | 後端 Proxy 合約屬性 | BackendProxyContract |
| resourceId | 外部系統中資源的管理 URI。 此 URL 可以是 Logic Apps、Function Apps 或 API Apps 的 Arm 資源識別符。 | 字串 約束： 最小長度 = 1 最大長度 = 1 |
| 標題 | 後端標題。 | 字串 約束： 最小長度 = 1 最大長度 = 1 |
| tls | 後端 TLS 屬性 | BackendTlsProperties |
| url | 後端的運行時間 URL。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
BackendCredentialsContract
| 名字 | 描述 | 價值 |
|---|---|---|
| 授權 | 授權標頭驗證 | BackendAuthorizationHeaderCredentials |
| 證書 | 用戶端憑證指紋的清單。 如果提供 certificatesIds，將會忽略。 | string[] |
| certificateIds | 用戶端憑證標識碼的清單。 | string[] |
| 頁眉 | 標頭參數描述。 | BackendCredentialsContractHeader |
| 查詢 | 查詢參數描述。 | BackendCredentialsContractQuery |
BackendCredentialsContractHeader
| 名字 | 描述 | 價值 |
|---|
BackendCredentialsContractQuery
| 名字 | 描述 | 價值 |
|---|
BackendProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| serviceFabricCluster | 後端 Service Fabric 叢集屬性 | BackendServiceFabricClusterProperties |
BackendProxyContract
| 名字 | 描述 | 價值 |
|---|---|---|
| 密碼 | 線上至 WebProxy 伺服器的密碼 | 字串 |
| url | WebProxy Server AbsoluteUri 屬性，其中包含儲存在 Uri 實例中的整個 URI，包括所有片段和查詢字串。 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
| username | 線上至 WebProxy 伺服器的使用者名稱 | 字串 |
BackendServiceFabricClusterProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| clientCertificateId | 管理端點的客戶端憑證標識碼。 | 字串 |
| clientCertificatethumbprint | 管理端點的客戶端憑證指紋。 如果提供 certificatesIds，將會忽略 | 字串 |
| managementEndpoints | 叢集管理端點。 | string[] （必要） |
| maxPartitionResolutionRetries | 嘗試解析分割區時重試次數上限。 | int |
| serverCertificateThumbprints | 叢集管理服務用於 tls 通訊的憑證指紋 | string[] |
| serverX509Names | 伺服器 X509 憑證名稱集合 | X509CertificateName[] |
BackendTlsProperties
| 名字 | 描述 | 價值 |
|---|---|---|
| validateCertificateChain | 旗標，指出使用此後端主機的自我簽署憑證時，是否應該完成 SSL 憑證鏈結驗證。 | bool |
| validateCertificateName | 旗標，指出使用此後端主機的自我簽署憑證時，是否應該完成SSL憑證名稱驗證。 | bool |
Microsoft.ApiManagement/service/backends
| 名字 | 描述 | 價值 |
|---|---|---|
| 名字 | 資源名稱 | 字串 約束： 最小長度 = 1 最大長度 = 1 （必要） |
| parent_id | 此資源為父系之資源的標識碼。 | 類型的資源標識碼：服務 |
| 性能 | 後端實體合約屬性。 | BackendContractProperties |
| 類型 | 資源類型 | “Microsoft.ApiManagement/service/backends@2021-04-01-preview” |
X509CertificateName
| 名字 | 描述 | 價值 |
|---|---|---|
| issuerCertificateThumbprint | 憑證簽發者的指紋。 | 字串 |
| 名字 | 憑證的一般名稱。 | 字串 |