Aracılığıyla paylaş

Microsoft.ApiManagement hizmeti/arka uçları 2021-12-01-preview

  • Makale

Bicep kaynak tanımı

Hizmet/arka uç kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service/backends kaynağı oluşturmak için şablonunuza aşağıdaki Bicep'i ekleyin.

resource symbolicname 'Microsoft.ApiManagement/service/backends@2021-12-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'
  }
}

Özellik değerleri

hizmet/arka uçlar

Ad Açıklama Değer
name Kaynak adı

Bicep'te alt kaynaklar için adları ve türleri ayarlamayı öğrenin.		 dize (gerekli)

Karakter sınırı: 1-80

Geçerli karakterler:
Alfasayısal değerler ve kısa çizgiler.

Harfle başlayın ve alfasayısal ile bitirin.
Üst Bicep'te bir alt kaynağın üst kaynağını belirtebilirsiniz. Bu özelliği yalnızca alt kaynak üst kaynağın dışında bildirildiğinde eklemeniz gerekir.

Daha fazla bilgi için bkz . Üst kaynağın dışındaki alt kaynak.		 Şu tür kaynak için sembolik ad: hizmet
properties Arka uç varlık sözleşmesi özellikleri. BackendContractProperties

BackendContractProperties

Ad Açıklama Değer
Kimlik bilgileri Arka Uç Kimlik Bilgileri Sözleşme Özellikleri BackendCredentialsContract
açıklama Arka Uç Açıklaması. string
properties Arka Uç Özellikleri sözleşmesi BackendProperties
protokol Arka uç iletişim protokolü. 'http'
'soap' (gerekli)
proxy Arka Uç Proxy Sözleşmesi Özellikleri BackendProxyContract
resourceId Dış Sistemdeki Kaynağın Yönetim Uri'si. Bu url Logic Apps, İşlev Uygulamaları veya API Apps'in Arm Kaynak Kimliği olabilir. string
başlık Arka Uç Başlığı. string
Tls Arka Uç TLS Özellikleri BackendTlsProperties
url Arka Ucun Çalışma Zamanı Url'si. dize (gerekli)

BackendCredentialsContract

Ad Açıklama Değer
yetkilendirme Yetkilendirme üst bilgisi kimlik doğrulaması BackendAuthorizationHeaderCredentials
sertifika İstemci Sertifikası Parmak İzleri listesi. CertificatesId'ler sağlanırsa yoksayılır. string[]
certificateId'ler İstemci Sertifikası Kimliklerinin listesi. string[]
üst bilgi Üst Bilgi Parametresi açıklaması. BackendCredentialsContractHeader
query Sorgu Parametresi açıklaması. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Ad Açıklama Değer
parametre Kimlik Doğrulama Parametresi değeri. dize (gerekli)
düzen Kimlik Doğrulama Düzeni adı. dize (gerekli)

BackendCredentialsContractHeader

Ad Açıklama Değer
{özelleştirilmiş özellik} string[]

BackendCredentialsContractQuery

Ad Açıklama Değer
{özelleştirilmiş özellik} string[]

BackendProperties

Ad Açıklama Değer
serviceFabricCluster Arka Uç Service Fabric Küme Özellikleri BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Ad Açıklama Değer
clientCertificateId Yönetim uç noktası için istemci sertifika kimliği. string
clientCertificatethumbprint Yönetim uç noktası için istemci sertifikası parmak izi. CertificatesId'ler sağlanırsa yoksayılır string
managementEndpoints Küme yönetimi uç noktası. string[] (gerekli)
maxPartitionResolutionRetries Bölümü çözümlemeye çalışırken en fazla yeniden deneme sayısı. int
serverCertificateThumbprints Küme yönetim hizmetinin tls iletişimi için kullandığı sertifikaların parmak izleri string[]
serverX509Names Sunucu X509 Sertifika Adları Koleksiyonu X509CertificateName[]

X509CertificateName

Ad Açıklama Değer
issuerCertificateThumbprint Sertifikayı Veren için parmak izi. string
name Sertifikanın Ortak Adı. string

BackendProxyContract

Ad Açıklama Değer
password WebProxy Sunucusuna bağlanmak için parola string
url Tüm parçalar ve sorgu dizeleri dahil olmak üzere Uri örneğinde depolanan tüm URI'yi içeren WebProxy Server AbsoluteUri özelliği. dize (gerekli)
username WebProxy sunucusuna bağlanmak için kullanıcı adı string

BackendTlsProperties

Ad Açıklama Değer
validateCertificateChain Bu arka uç konağı için otomatik olarak imzalanan sertifikalar kullanılırken SSL sertifika zinciri doğrulamasının yapılıp yapılmayacağını gösteren bayrak. bool
validateCertificateName Bu arka uç konağı için otomatik olarak imzalanan sertifikalar kullanılırken SSL sertifika adı doğrulamasının yapılıp yapılmayacağını gösteren bayrak. bool

ARM şablonu kaynak tanımı

Hizmet/arka uç kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service/backends kaynağı oluşturmak için şablonunuza aşağıdaki JSON'u ekleyin.

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

Özellik değerleri

hizmet/arka uçlar

Ad Açıklama Değer
tür Kaynak türü 'Microsoft.ApiManagement/service/backends'
apiVersion Kaynak API'sinin sürümü '2021-12-01-preview'
name Kaynak adı

Bkz. JSON ARM şablonlarında alt kaynaklar için adları ve türleri ayarlama.		 dize (gerekli)

Karakter sınırı: 1-80

Geçerli karakterler:
Alfasayısallar ve kısa çizgiler.

Harfle başlayın ve alfasayısal ile bitirin.
properties Arka uç varlık sözleşmesi özellikleri. BackendContractProperties

BackendContractProperties

Ad Açıklama Değer
Kimlik bilgileri Arka Uç Kimlik Bilgileri Sözleşme Özellikleri BackendCredentialsContract
açıklama Arka Uç Açıklaması. string
properties Arka Uç Özellikleri sözleşmesi BackendProperties
protokol Arka uç iletişim protokolü. 'http'
'soap' (gerekli)
proxy Arka Uç Ara Sunucu Sözleşmesi Özellikleri BackendProxyContract
resourceId Dış Sistemdeki Kaynağın Yönetim Uri'si. Bu url Logic Apps, İşlev Uygulamaları veya API Apps'in Arm Kaynak Kimliği olabilir. string
başlık Arka Uç Başlığı. string
Tls Arka Uç TLS Özellikleri BackendTlsProperties
url Arka Ucun Çalışma Zamanı Url'si. dize (gerekli)

BackendCredentialsContract

Ad Açıklama Değer
yetkilendirme Yetkilendirme üst bilgisi kimlik doğrulaması BackendAuthorizationHeaderCredentials
sertifika İstemci Sertifikası Parmak İzleri listesi. CertificatesId'ler sağlanırsa yoksayılır. dize[]
certificateIds İstemci Sertifika Kimliklerinin listesi. dize[]
üst bilgi Üst Bilgi Parametresi açıklaması. BackendCredentialsContractHeader
query Sorgu Parametresi açıklaması. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Ad Açıklama Değer
parametre Kimlik Doğrulama Parametresi değeri. dize (gerekli)
düzen Kimlik Doğrulama Düzeni adı. dize (gerekli)

BackendCredentialsContractHeader

Ad Açıklama Değer
{özelleştirilmiş özellik} dize[]

BackendCredentialsContractQuery

Ad Açıklama Değer
{özelleştirilmiş özellik} dize[]

BackendProperties

Ad Açıklama Değer
serviceFabricCluster Arka Uç Service Fabric Küme Özellikleri BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Ad Açıklama Değer
clientCertificateId Yönetim uç noktası için istemci sertifika kimliği. string
clientCertificatethumbprint Yönetim uç noktası için istemci sertifikası parmak izi. CertificatesId'ler sağlanırsa yoksayılır string
managementEndpoints Küme yönetimi uç noktası. string[] (gerekli)
maxPartitionResolutionRetries Bölümü çözümlemeye çalışırken en fazla yeniden deneme sayısı. int
serverCertificateThumbprints Küme yönetim hizmetinin tls iletişimi için kullandığı sertifikaların parmak izleri dize[]
serverX509Names Sunucu X509 Sertifika Adları Koleksiyonu X509CertificateName[]

X509CertificateName

Ad Açıklama Değer
issuerCertificateThumbprint Sertifikayı Veren için parmak izi. string
name Sertifikanın Ortak Adı. string

BackendProxyContract

Ad Açıklama Değer
password WebProxy Sunucusuna bağlanmak için parola string
url Tüm parçalar ve sorgu dizeleri dahil olmak üzere Uri örneğinde depolanan URI'nin tamamını içeren WebProxy Server AbsoluteUri özelliği. dize (gerekli)
username WebProxy sunucusuna bağlanmak için kullanıcı adı string

BackendTlsProperties

Ad Açıklama Değer
validateCertificateChain Bu arka uç konağı için otomatik olarak imzalanan sertifikalar kullanılırken SSL sertifika zinciri doğrulamasının yapılıp yapılmayacağını belirten bayrak. bool
validateCertificateName Bu arka uç konağı için otomatik olarak imzalanan sertifikalar kullanılırken SSL sertifika adı doğrulamasının yapılıp yapılmayacağını belirten bayrak. bool

Terraform (AzAPI sağlayıcısı) kaynak tanımı

Hizmet/arka uç kaynak türü, aşağıdakileri hedefleyen işlemlerle dağıtılabilir:

  • Kaynak grupları

Her API sürümünde değiştirilen özelliklerin listesi için bkz. değişiklik günlüğü.

Kaynak biçimi

Microsoft.ApiManagement/service/backends kaynağı oluşturmak için aşağıdaki Terraform'u şablonunuza ekleyin.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/backends@2021-12-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"
    }
  })
}

Özellik değerleri

hizmet/arka uçlar

Ad Açıklama Değer
tür Kaynak türü "Microsoft.ApiManagement/service/backends@2021-12-01-preview"
name Kaynak adı dize (gerekli)

Karakter sınırı: 1-80

Geçerli karakterler:
Alfasayısallar ve kısa çizgiler.

Harfle başlayın ve alfasayısal ile bitirin.
parent_id Bu kaynağın üst öğesi olan kaynağın kimliği. Kaynak türü: hizmet kimliği
properties Arka uç varlık sözleşmesi özellikleri. BackendContractProperties

BackendContractProperties

Ad Açıklama Değer
Kimlik bilgileri Arka Uç Kimlik Bilgileri Sözleşme Özellikleri BackendCredentialsContract
açıklama Arka Uç Açıklaması. string
properties Arka Uç Özellikleri sözleşmesi BackendProperties
protokol Arka uç iletişim protokolü. "http"
"soap" (gerekli)
proxy Arka Uç Ara Sunucu Sözleşmesi Özellikleri BackendProxyContract
resourceId Dış Sistemdeki Kaynağın Yönetim Uri'si. Bu url Logic Apps, İşlev Uygulamaları veya API Apps'in Arm Kaynak Kimliği olabilir. string
başlık Arka Uç Başlığı. string
Tls Arka Uç TLS Özellikleri BackendTlsProperties
url Arka Ucun Çalışma Zamanı Url'si. dize (gerekli)

BackendCredentialsContract

Ad Açıklama Değer
yetkilendirme Yetkilendirme üst bilgisi kimlik doğrulaması BackendAuthorizationHeaderCredentials
sertifika İstemci Sertifikası Parmak İzleri listesi. CertificatesId'ler sağlanırsa yoksayılır. string[]
certificateId'ler İstemci Sertifikası Kimliklerinin listesi. string[]
üst bilgi Üst Bilgi Parametresi açıklaması. BackendCredentialsContractHeader
query Sorgu Parametresi açıklaması. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Ad Açıklama Değer
parametre Kimlik Doğrulama Parametresi değeri. dize (gerekli)
düzen Kimlik Doğrulama Düzeni adı. dize (gerekli)

BackendCredentialsContractHeader

Ad Açıklama Değer
{özelleştirilmiş özellik} string[]

BackendCredentialsContractQuery

Ad Açıklama Değer
{özelleştirilmiş özellik} string[]

BackendProperties

Ad Açıklama Değer
serviceFabricCluster Arka Uç Service Fabric Küme Özellikleri BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Ad Açıklama Değer
clientCertificateId Yönetim uç noktası için istemci sertifika kimliği. string
clientCertificatethumbprint Yönetim uç noktası için istemci sertifikası parmak izi. CertificatesId'ler sağlanırsa yoksayılır string
managementEndpoints Küme yönetimi uç noktası. string[] (gerekli)
maxPartitionResolutionRetries Bölümü çözümlemeye çalışırken en fazla yeniden deneme sayısı. int
serverCertificateThumbprints Küme yönetim hizmetinin tls iletişimi için kullandığı sertifikaların parmak izleri string[]
serverX509Names Sunucu X509 Sertifika Adları Koleksiyonu X509CertificateName[]

X509CertificateName

Ad Açıklama Değer
issuerCertificateThumbprint Sertifikayı Veren için parmak izi. string
name Sertifikanın Ortak Adı. string

BackendProxyContract

Ad Açıklama Değer
password WebProxy Sunucusuna bağlanmak için parola string
url Tüm parçalar ve sorgu dizeleri dahil olmak üzere Uri örneğinde depolanan tüm URI'yi içeren WebProxy Server AbsoluteUri özelliği. dize (gerekli)
username WebProxy sunucusuna bağlanmak için kullanıcı adı string

BackendTlsProperties

Ad Açıklama Değer
validateCertificateChain Bu arka uç konağı için otomatik olarak imzalanan sertifikalar kullanılırken SSL sertifika zinciri doğrulamasının yapılıp yapılmayacağını gösteren bayrak. bool
validateCertificateName Bu arka uç konağı için otomatik olarak imzalanan sertifikalar kullanılırken SSL sertifika adı doğrulamasının yapılıp yapılmayacağını gösteren bayrak. bool