共用方式為

Microsoft.ApiManagement 服務/後端 2022-04-01-preview

  • 發行項

Bicep 資源定義

服務/後端資源類型可以使用目標作業進行部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/backends 資源，請將下列 Bicep 新增至您的範本。

resource symbolicname 'Microsoft.ApiManagement/service/backends@2022-04-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  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'
  }
}

屬性值

服務/後端

名稱 描述 值
NAME 資源名稱

瞭解如何在 Bicep 中設定子資源的名稱和類型。		 需要字串 ()

字元限制：1-80

合法字元：
英數字元和連字號。

以字母開頭，並以英數字元結尾。
父系 (parent) 在 Bicep 中，您可以指定子資源的父資源。 只有在父資源外部宣告子資源時，才需要新增此屬性。

如需詳細資訊，請參閱 父資源外部的子資源。		 類型資源的符號名稱： service
properties 後端實體合約屬性。 BackendContractProperties

BackendContractProperties

名稱 描述 值
認證 後端認證合約屬性 BackendCredentialsContract
description 後端描述。 字串
properties 後端屬性合約 BackendProperties
protocol 後端通訊協定。 'http'
需要 'soap' ()
proxy 後端閘道合約屬性 BackendProxyContract
resourceId 外部系統中資源的管理 URI。 此 URL 可以是 Logic Apps、函式應用程式或 API 應用程式的 Arm 資源識別碼。 字串
title 後端標題。 字串
Tls 後端 TLS 屬性 BackendTlsProperties
url 後端的運行時間 URL。 需要字串 ()

BackendCredentialsContract

名稱 描述 值
授權 授權標頭驗證 BackendAuthorizationHeaderCredentials
憑證 (certificate) 用戶端憑證指紋的清單。 如果提供 certificatesIds，將會忽略。 string[]
certificateIds 用戶端憑證標識碼的清單。 string[]
header 標頭參數描述。 BackendCredentialsContractHeader
查詢 查詢參數描述。 BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

名稱 描述 值
參數 (parameter) 驗證參數值。 需要字串 ()
scheme 驗證配置名稱。 字串 (必要)

BackendCredentialsContractHeader

名稱 描述 值
{自定義屬性} string[]

BackendCredentialsContractQuery

名稱 描述 值
{自定義屬性} string[]

BackendProperties

名稱 描述 值
serviceFabricCluster 後端 Service Fabric 叢集屬性 BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

名稱 描述 值
clientCertificateId 管理端點的客戶端憑證標識碼。 字串
clientCertificatethumbprint 管理端點的客戶端憑證指紋。 如果提供 certificatesIds，將會忽略 字串
managementEndpoints 叢集管理端點。 string[] (必要)
maxPartitionResolutionRetries 嘗試解析數據分割時重試次數上限。 int
serverCertificateThumbprints 叢集管理服務用於 TLS 通訊的憑證指紋 string[]
serverX509Names 伺服器 X509 憑證名稱集合 X509CertificateName[]

X509CertificateName

名稱 描述 值
issuerCertificateThumbprint 憑證簽發者的指紋。 字串
NAME 憑證的一般名稱。 字串

BackendProxyContract

名稱 描述 值
password 線上到 WebProxy 伺服器的密碼 字串
url WebProxy Server AbsoluteUri 屬性，其中包含儲存在 Uri 實例中的整個 URI，包括所有片段和查詢字串。 字串 (必要)
使用者名稱 線上到 WebProxy 伺服器的使用者名稱 字串

BackendTlsProperties

名稱 描述 值
validateCertificateChain 旗標，指出是否應該在此後端主機使用自我簽署憑證時完成SSL憑證鏈結驗證。 bool
validateCertificateName 旗標，指出是否應該在此後端主機使用自我簽署憑證時完成SSL憑證名稱驗證。 bool

ARM 範本資源定義

服務/後端資源類型可以使用目標作業來部署：

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄。

資源格式

若要建立 Microsoft.ApiManagement/service/backends 資源，請將下列 JSON 新增至您的範本。

{
  "type": "Microsoft.ApiManagement/service/backends",
  "apiVersion": "2022-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"
  }
}

屬性值

服務/後端

名稱 描述 值
類型 資源類型 'Microsoft.ApiManagement/service/backends'
apiVersion 資源 API 版本 '2022-04-01-preview'
NAME 資源名稱

請參閱如何在 JSON ARM 樣本中設定子資源的名稱和類型。		 字串 (必要)

字元限制：1-80

合法字元：
英數字元和連字號。

以字母開頭，並以英數字元結尾。
properties 後端實體合約屬性。 BackendContractProperties

BackendContractProperties

名稱 描述 值
認證 後端認證合約屬性 BackendCredentialsContract
description 後端描述。 字串
properties 後端屬性合約 BackendProperties
protocol 後端通訊協定。 'http'
需要 'soap' ()
proxy 後端閘道合約屬性 BackendProxyContract
resourceId 外部系統中資源的管理 URI。 此 URL 可以是 Logic Apps、函式應用程式或 API 應用程式的 Arm 資源識別碼。 字串
title 後端標題。 字串
Tls 後端 TLS 屬性 BackendTlsProperties
url 後端的運行時間 URL。 字串 (必要)

BackendCredentialsContract

名稱 描述 值
授權 授權標頭驗證 BackendAuthorizationHeaderCredentials
憑證 (certificate) 用戶端憑證指紋的清單。 如果提供 certificatesIds，將會忽略。 string[]
certificateIds 用戶端憑證標識碼的清單。 string[]
header 標頭參數描述。 BackendCredentialsContractHeader
查詢 查詢參數描述。 BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

名稱 描述 值
參數 (parameter) 驗證參數值。 字串 (必要)
scheme 驗證配置名稱。 字串 (必要)

BackendCredentialsContractHeader

名稱 描述 值
{自定義屬性} string[]

BackendCredentialsContractQuery

名稱 描述 值
{自定義屬性} string[]

BackendProperties

名稱 描述 值
serviceFabricCluster 後端 Service Fabric 叢集屬性 BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

名稱 描述 值
clientCertificateId 管理端點的客戶端憑證標識碼。 字串
clientCertificatethumbprint 管理端點的客戶端憑證指紋。 如果提供 certificatesIds，將會忽略 字串
managementEndpoints 叢集管理端點。 string[] (必要)
maxPartitionResolutionRetries 嘗試解析數據分割時重試次數上限。 int
serverCertificateThumbprints 憑證叢集管理服務用於 TLS 通訊的指紋 string[]
serverX509Names 伺服器 X509 憑證名稱集合 X509CertificateName[]

X509CertificateName

名稱 描述 值
issuerCertificateThumbprint 憑證簽發者的指紋。 字串
NAME 憑證的一般名稱。 字串

BackendProxyContract

名稱 描述 值
password 線上到 WebProxy 伺服器的密碼 字串
url WebProxy Server AbsoluteUri 屬性，其中包含儲存在 Uri 實例中的整個 URI，包括所有片段和查詢字串。 需要字串 ()
使用者名稱 線上到 WebProxy 伺服器的使用者名稱 字串

BackendTlsProperties

名稱 描述 值
validateCertificateChain 旗標，指出使用此後端主機的自我簽署憑證時，是否應該完成 SSL 憑證鏈結驗證。 bool
validateCertificateName 旗標，指出使用此後端主機的自我簽署憑證時，是否應該完成SSL憑證名稱驗證。 bool

Terraform (AzAPI 提供者) 資源定義

服務/後端資源類型可以使用目標作業進行部署：

  • 資源群組

如需每個 API 版本中已變更屬性的清單，請參閱 變更記錄檔。

資源格式

若要建立 Microsoft.ApiManagement/service/backends 資源，請將下列 Terraform 新增至範本。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/backends@2022-04-01-preview"
  name = "string"
  parent_id = "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"
    }
  })
}

屬性值

服務/後端

名稱 描述 值
類型 資源類型 “Microsoft.ApiManagement/service/backends@2022-04-01-preview”
NAME 資源名稱 需要字串 ()

字元限制：1-80

合法字元：
英數字元和連字號。

以字母開頭，並以英數字元結尾。
parent_id 此資源父系之資源的標識碼。 類型資源的標識碼： 服務
properties 後端實體合約屬性。 BackendContractProperties

BackendContractProperties

名稱 描述 值
認證 後端認證合約屬性 BackendCredentialsContract
description 後端描述。 字串
properties 後端屬性合約 BackendProperties
protocol 後端通訊協定。 “http”
“soap” (必要)
proxy 後端閘道合約屬性 BackendProxyContract
resourceId 外部系統中資源的管理 URI。 此 URL 可以是 Logic Apps、函式應用程式或 API 應用程式的 Arm 資源識別碼。 字串
title 後端標題。 字串
Tls 後端 TLS 屬性 BackendTlsProperties
url 後端的運行時間 URL。 字串 (必要)

BackendCredentialsContract

名稱 描述 值
授權 授權標頭驗證 BackendAuthorizationHeaderCredentials
憑證 (certificate) 用戶端憑證指紋的清單。 如果提供 certificatesIds，將會忽略。 string[]
certificateIds 用戶端憑證標識碼的清單。 string[]
header 標頭參數描述。 BackendCredentialsContractHeader
查詢 查詢參數描述。 BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

名稱 描述 值
參數 (parameter) 驗證參數值。 字串 (必要)
scheme 驗證配置名稱。 字串 (必要)

BackendCredentialsContractHeader

名稱 描述 值
{自定義屬性} string[]

BackendCredentialsContractQuery

名稱 描述 值
{自定義屬性} string[]

BackendProperties

名稱 描述 值
serviceFabricCluster 後端 Service Fabric 叢集屬性 BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

名稱 描述 值
clientCertificateId 管理端點的客戶端憑證標識碼。 字串
clientCertificatethumbprint 管理端點的客戶端憑證指紋。 如果提供 certificatesIds，將會忽略 字串
managementEndpoints 叢集管理端點。 string[] (必要)
maxPartitionResolutionRetries 嘗試解析數據分割時重試次數上限。 int
serverCertificateThumbprints 叢集管理服務用於 TLS 通訊的憑證指紋 string[]
serverX509Names 伺服器 X509 憑證名稱集合 X509CertificateName[]

X509CertificateName

名稱 描述 值
issuerCertificateThumbprint 憑證簽發者的指紋。 字串
NAME 憑證的一般名稱。 字串

BackendProxyContract

名稱 描述 值
password 線上到 WebProxy 伺服器的密碼 字串
url WebProxy Server AbsoluteUri 屬性，其中包含儲存在 Uri 實例中的整個 URI，包括所有片段和查詢字串。 字串 (必要)
使用者名稱 線上到 WebProxy 伺服器的使用者名稱 字串

BackendTlsProperties

名稱 描述 值
validateCertificateChain 旗標，指出使用此後端主機的自我簽署憑證時，是否應該完成 SSL 憑證鏈結驗證。 bool
validateCertificateName 旗標，指出使用此後端主機的自我簽署憑證時，是否應該完成SSL憑證名稱驗證。 bool