Layanan/backend Microsoft.ApiManagement

Definisi sumber daya Bicep

Jenis sumber daya layanan/backend dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service/backends, tambahkan Bicep berikut ke templat Anda.

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

Nilai properti

layanan/backend

Nama Deskripsi Nilai
nama Nama sumber daya

Lihat cara mengatur nama dan jenis untuk sumber daya anak di Bicep.
string (diperlukan)

Batas karakter: 1-80

Karakter yang valid:
Alfanumerik dan tanda hubung.

Mulai dengan huruf, dan akhiri dengan alfanumerik.
induk Di Bicep, Anda dapat menentukan sumber daya induk untuk sumber daya anak. Anda hanya perlu menambahkan properti ini ketika sumber daya anak dideklarasikan di luar sumber daya induk.

Untuk informasi selengkapnya, lihat Sumber daya anak di luar sumber daya induk.
Nama simbolis untuk sumber daya jenis: layanan
properti Properti kontrak entitas backend. BackendContractProperties

BackendContractProperties

Nama Deskripsi Nilai
circuitBreaker Konfigurasi Pemutus Sirkuit Backend BackendCircuitBreaker
informasi masuk Properti Kontrak Kredensial Backend BackendCredentialsContract
deskripsi Deskripsi Backend. string
kumpulan BackendBaseParametersPool
properti Kontrak Properti Backend BackendProperties
protokol Protokol komunikasi backend. 'http'
'soap' (diperlukan)
proksi Properti Kontrak gateway backend BackendProxyContract
resourceId Uri Manajemen Sumber Daya di Sistem Eksternal. URL ini dapat menjadi Id Sumber Daya Arm dari Logic Apps, Aplikasi Fungsi, atau Aplikasi API. string
judul Judul Backend. string
Tls Properti TLS Backend BackendTlsProperties
jenis Jenis backend. Backend dapat berupa Tunggal atau Kumpulan. 'Kumpulan'
'Tunggal'
url Runtime Url of the Backend. string (diperlukan)

BackendCircuitBreaker

Nama Deskripsi Nilai
aturan Aturan untuk tersandung backend. CircuitBreakerRule[]

CircuitBreakerRule

Nama Deskripsi Nilai
failureCondition Kondisi untuk tersandung pemutus sirkuit. CircuitBreakerFailureCondition
nama Nama aturan. string
tripDuration Durasi sirkuit akan tersandung. string

CircuitBreakerFailureCondition

Nama Deskripsi Nilai
jumlah Ambang batas untuk membuka sirkuit. int
errorReasons Alasan kesalahan yang dianggap sebagai kegagalan. string[]
Interval Interval di mana kegagalan dihitung. string
persentase Ambang batas untuk membuka sirkuit. int
statusCodeRanges Rentang kode status yang dianggap sebagai kegagalan. FailureStatusCodeRange[]

FailureStatusCodeRange

Nama Deskripsi Nilai
maks Kode status http maksimum. int
mnt Kode status http minimum. int

BackendCredentialsContract

Nama Deskripsi Nilai
otorisasi Autentikasi header otorisasi BackendAuthorizationHeaderCredentials
sertifikat Daftar Thumbprint Sertifikat Klien. Akan diabaikan jika certificatesIds disediakan. string[]
certificateIds Daftar Id Sertifikat Klien. string[]
header Deskripsi Parameter Header. BackendCredentialsContractHeader
query Deskripsi Parameter Kueri. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nama Deskripsi Nilai
parameter Nilai Parameter Autentikasi. string (diperlukan)
skema Nama Skema Autentikasi. string (diperlukan)

BackendCredentialsContractHeader

Nama Deskripsi Nilai
{properti yang disesuaikan} string[]

BackendCredentialsContractQuery

Nama Deskripsi Nilai
{properti yang disesuaikan} string[]

BackendBaseParametersPool

Nama Deskripsi Nilai
services Daftar entitas backend milik kumpulan. BackendPoolItem[]

BackendPoolItem

Nama Deskripsi Nilai
id Id ARM unik dari entitas backend. Id ARM harus merujuk ke entitas backend yang sudah ada. string (diperlukan)

BackendProperties

Nama Deskripsi Nilai
serviceFabricCluster Properti Kluster Backend Service Fabric BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Nama Deskripsi Nilai
clientCertificateId Id sertifikat klien untuk titik akhir manajemen. string
clientCertificatethumbprint Thumbprint sertifikat klien untuk titik akhir manajemen. Akan diabaikan jika certificatesIds disediakan string
managementEndpoints Titik akhir manajemen kluster. string[] (diperlukan)
maxPartitionResolutionRetries Jumlah maksimum percobaan ulang saat mencoba menyelesaikan partisi. int
serverCertificateThumbprints Thumbprints layanan manajemen kluster sertifikat digunakan untuk komunikasi tls string[]
serverX509Names Kumpulan Nama Sertifikat Server X509 X509CertificateName[]

X509CertificateName

Nama Deskripsi Nilai
issuerCertificateThumbprint Thumbprint untuk Penerbit Sertifikat. string
nama Nama Umum Sertifikat. string

BackendProxyContract

Nama Deskripsi Nilai
kata sandi Kata sandi untuk menyambungkan ke Server WebProxy string
url Properti AbsoluteUri Server WebProxy yang mencakup seluruh URI yang disimpan dalam instans Uri, termasuk semua fragmen dan string kueri. string (diperlukan)
Nama pengguna Nama pengguna untuk menyambungkan ke server WebProxy string

BackendTlsProperties

Nama Deskripsi Nilai
validateCertificateChain Bendera yang menunjukkan apakah validasi rantai sertifikat SSL harus dilakukan saat menggunakan sertifikat yang ditandatangani sendiri untuk host backend ini. bool
validateCertificateName Bendera yang menunjukkan apakah validasi nama sertifikat SSL harus dilakukan saat menggunakan sertifikat yang ditandatangani sendiri untuk host backend ini. bool

Definisi sumber daya templat ARM

Jenis sumber daya layanan/backend dapat disebarkan dengan operasi yang menargetkan:

Untuk daftar properti yang diubah di setiap versi API, lihat log perubahan.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service/backends, tambahkan JSON berikut ke templat Anda.

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

Nilai properti

layanan/backend

Nama Deskripsi Nilai
jenis Jenis sumber daya 'Microsoft.ApiManagement/service/backends'
apiVersion Versi api sumber daya '2023-05-01-preview'
nama Nama sumber daya

Lihat cara mengatur nama dan jenis untuk sumber daya anak dalam templat JSON ARM.
string (diperlukan)

Batas karakter: 1-80

Karakter yang valid:
Alfanumerik dan tanda hubung.

Mulai dengan huruf, dan akhiri dengan alfanumerik.
properti Properti kontrak entitas backend. BackendContractProperties

BackendContractProperties

Nama Deskripsi Nilai
circuitBreaker Konfigurasi Pemutus Sirkuit Backend BackendCircuitBreaker
informasi masuk Properti Kontrak Kredensial Backend BackendCredentialsContract
deskripsi Deskripsi Backend. string
kumpulan BackendBaseParametersPool
properti Kontrak Properti Backend BackendProperties
protokol Protokol komunikasi backend. 'http'
'sabun' (diperlukan)
proksi Properti Kontrak gateway backend BackendProxyContract
resourceId Uri Manajemen Sumber Daya di Sistem Eksternal. URL ini dapat menjadi Id Sumber Daya Arm dari Logic Apps, Aplikasi Fungsi, atau Aplikasi API. string
judul Judul Backend. string
Tls Properti TLS Backend BackendTlsProperties
jenis Jenis backend. Backend dapat berupa Tunggal atau Kumpulan. 'Pool'
'Tunggal'
url Runtime Url of the Backend. string (diperlukan)

BackendCircuitBreaker

Nama Deskripsi Nilai
aturan Aturan untuk tersandung backend. CircuitBreakerRule[]

CircuitBreakerRule

Nama Deskripsi Nilai
failureCondition Kondisi untuk tersandung pemutus sirkuit. CircuitBreakerFailureCondition
nama Nama aturan. string
tripDuration Durasi sirkuit akan tersandung. string

CircuitBreakerFailureCondition

Nama Deskripsi Nilai
jumlah Ambang batas untuk membuka sirkuit. int
errorReasons Alasan kesalahan yang dianggap sebagai kegagalan. string[]
Interval Interval di mana kegagalan dihitung. string
persentase Ambang batas untuk membuka sirkuit. int
statusCodeRanges Rentang kode status yang dianggap sebagai kegagalan. FailureStatusCodeRange[]

FailureStatusCodeRange

Nama Deskripsi Nilai
maks Kode status http maksimum. int
mnt Kode status http minimum. int

BackendCredentialsContract

Nama Deskripsi Nilai
otorisasi Autentikasi header otorisasi BackendAuthorizationHeaderCredentials
sertifikat Daftar Thumbprint Sertifikat Klien. Akan diabaikan jika certificatesIds disediakan. string[]
certificateIds Daftar Id Sertifikat Klien. string[]
header Deskripsi Parameter Header. BackendCredentialsContractHeader
query Deskripsi Parameter Kueri. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nama Deskripsi Nilai
parameter Nilai Parameter Autentikasi. string (diperlukan)
skema Nama Skema Autentikasi. string (diperlukan)

BackendCredentialsContractHeader

Nama Deskripsi Nilai
{properti yang disesuaikan} string[]

BackendCredentialsContractQuery

Nama Deskripsi Nilai
{properti yang disesuaikan} string[]

BackendBaseParametersPool

Nama Deskripsi Nilai
services Daftar entitas backend milik kumpulan. BackendPoolItem[]

BackendPoolItem

Nama Deskripsi Nilai
id Id ARM unik dari entitas backend. Id ARM harus merujuk ke entitas backend yang sudah ada. string (diperlukan)

BackendProperties

Nama Deskripsi Nilai
serviceFabricCluster Properti Kluster Backend Service Fabric BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Nama Deskripsi Nilai
clientCertificateId Id sertifikat klien untuk titik akhir manajemen. string
clientCertificatethumbprint Thumbprint sertifikat klien untuk titik akhir manajemen. Akan diabaikan jika certificatesIds disediakan string
managementEndpoints Titik akhir manajemen kluster. string[] (diperlukan)
maxPartitionResolutionRetries Jumlah maksimum percobaan ulang saat mencoba menyelesaikan partisi. int
serverCertificateThumbprints Thumbprints layanan manajemen kluster sertifikat yang digunakan untuk komunikasi tls string[]
serverX509Names Kumpulan Nama Sertifikat Server X509 X509CertificateName[]

X509CertificateName

Nama Deskripsi Nilai
issuerCertificateThumbprint Thumbprint untuk Penerbit Sertifikat. string
nama Nama Umum Sertifikat. string

BackendProxyContract

Nama Deskripsi Nilai
kata sandi Kata sandi untuk menyambungkan ke Server WebProxy string
url Properti WebProxy Server AbsoluteUri yang mencakup seluruh URI yang disimpan dalam instans Uri, termasuk semua fragmen dan string kueri. string (diperlukan)
Nama pengguna Nama pengguna untuk menyambungkan ke server WebProxy string

BackendTlsProperties

Nama Deskripsi Nilai
validateCertificateChain Bendera yang menunjukkan apakah validasi rantai sertifikat SSL harus dilakukan saat menggunakan sertifikat yang ditandatangani sendiri untuk host backend ini. bool
validateCertificateName Bendera yang menunjukkan apakah validasi nama sertifikat SSL harus dilakukan saat menggunakan sertifikat yang ditandatangani sendiri untuk host backend ini. bool

Definisi sumber daya Terraform (penyedia AzAPI)

Jenis sumber daya layanan/backend dapat disebarkan dengan operasi yang menargetkan:

  • Grup sumber daya

Untuk daftar properti yang diubah di setiap versi API, lihat mengubah log.

Format sumber daya

Untuk membuat sumber daya Microsoft.ApiManagement/service/backends, tambahkan Terraform berikut ke templat Anda.

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

Nilai properti

layanan/backend

Nama Deskripsi Nilai
jenis Jenis sumber daya "Microsoft.ApiManagement/service/backends@2023-05-01-preview"
nama Nama sumber daya string (diperlukan)

Batas karakter: 1-80

Karakter yang valid:
Alfanumerik dan tanda hubung.

Mulai dengan huruf, dan akhiri dengan alfanumerik.
parent_id ID sumber daya yang merupakan induk untuk sumber daya ini. ID untuk sumber daya jenis: layanan
properti Properti kontrak entitas backend. BackendContractProperties

BackendContractProperties

Nama Deskripsi Nilai
circuitBreaker Konfigurasi Pemutus Sirkuit Backend BackendCircuitBreaker
informasi masuk Properti Kontrak Kredensial Backend BackendCredentialsContract
deskripsi Deskripsi Backend. string
kumpulan BackendBaseParametersPool
properti Kontrak Properti Backend BackendProperties
protokol Protokol komunikasi backend. "http"
"sabun" (diperlukan)
proksi Properti Kontrak gateway backend BackendProxyContract
resourceId Uri Manajemen Sumber Daya di Sistem Eksternal. URL ini dapat menjadi Id Sumber Daya Arm dari Logic Apps, Aplikasi Fungsi, atau Aplikasi API. string
judul Judul Backend. string
Tls Properti TLS Backend BackendTlsProperties
jenis Jenis backend. Backend dapat berupa Tunggal atau Kumpulan. "Kumpulan"
"Tunggal"
url Runtime Url of the Backend. string (diperlukan)

BackendCircuitBreaker

Nama Deskripsi Nilai
aturan Aturan untuk tersandung backend. CircuitBreakerRule[]

CircuitBreakerRule

Nama Deskripsi Nilai
failureCondition Kondisi untuk tersandung pemutus sirkuit. CircuitBreakerFailureCondition
nama Nama aturan. string
tripDuration Durasi sirkuit akan tersandung. string

CircuitBreakerFailureCondition

Nama Deskripsi Nilai
jumlah Ambang batas untuk membuka sirkuit. int
errorReasons Alasan kesalahan yang dianggap sebagai kegagalan. string[]
Interval Interval di mana kegagalan dihitung. string
persentase Ambang batas untuk membuka sirkuit. int
statusCodeRanges Rentang kode status yang dianggap sebagai kegagalan. FailureStatusCodeRange[]

FailureStatusCodeRange

Nama Deskripsi Nilai
maks Kode status http maksimum. int
mnt Kode status http minimum. int

BackendCredentialsContract

Nama Deskripsi Nilai
otorisasi Autentikasi header otorisasi BackendAuthorizationHeaderCredentials
sertifikat Daftar Thumbprint Sertifikat Klien. Akan diabaikan jika certificatesIds disediakan. string[]
certificateIds Daftar Id Sertifikat Klien. string[]
header Deskripsi Parameter Header. BackendCredentialsContractHeader
query Deskripsi Parameter Kueri. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nama Deskripsi Nilai
parameter Nilai Parameter Autentikasi. string (diperlukan)
skema Nama Skema Autentikasi. string (diperlukan)

BackendCredentialsContractHeader

Nama Deskripsi Nilai
{customized property} string[]

BackendCredentialsContractQuery

Nama Deskripsi Nilai
{customized property} string[]

BackendBaseParametersPool

Nama Deskripsi Nilai
services Daftar entitas backend milik kumpulan. BackendPoolItem[]

BackendPoolItem

Nama Deskripsi Nilai
id Id ARM unik dari entitas backend. Id ARM harus merujuk ke entitas backend yang sudah ada. string (diperlukan)

BackendProperties

Nama Deskripsi Nilai
serviceFabricCluster Properti Kluster Service Fabric Backend BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Nama Deskripsi Nilai
clientCertificateId Id sertifikat klien untuk titik akhir manajemen. string
clientCertificatethumbprint Thumbprint sertifikat klien untuk titik akhir manajemen. Akan diabaikan jika certificatesIds disediakan string
managementEndpoints Titik akhir manajemen kluster. string[] (diperlukan)
maxPartitionResolutionRetries Jumlah maksimum percobaan ulang saat mencoba menyelesaikan partisi. int
serverCertificateThumbprints Thumbprints layanan manajemen kluster sertifikat digunakan untuk komunikasi tls string[]
serverX509Names Kumpulan Nama Sertifikat Server X509 X509CertificateName[]

X509CertificateName

Nama Deskripsi Nilai
issuerCertificateThumbprint Thumbprint untuk Penerbit Sertifikat. string
nama Nama Umum Sertifikat. string

BackendProxyContract

Nama Deskripsi Nilai
kata sandi Kata sandi untuk menyambungkan ke Server WebProxy string
url Properti AbsoluteUri Server WebProxy yang mencakup seluruh URI yang disimpan dalam instans Uri, termasuk semua fragmen dan string kueri. string (diperlukan)
Nama pengguna Nama pengguna untuk menyambungkan ke server WebProxy string

BackendTlsProperties

Nama Deskripsi Nilai
validateCertificateChain Bendera yang menunjukkan apakah validasi rantai sertifikat SSL harus dilakukan saat menggunakan sertifikat yang ditandatangani sendiri untuk host backend ini. bool
validateCertificateName Bendera yang menunjukkan apakah validasi nama sertifikat SSL harus dilakukan saat menggunakan sertifikat yang ditandatangani sendiri untuk host backend ini. bool