Služba Microsoft.ApiManagement/back-endy 2023-03-01-preview

Článek
01/18/2024

Definice prostředku Bicep

Typ prostředku service/back-ends je možné nasadit s operacemi, které cílí na:

Skupiny prostředků – viz příkazy nasazení skupiny prostředků.

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/back-ends, přidejte do šablony následující bicep.

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

Hodnoty vlastností

služba/back-endy

Název	Description	Hodnota
name	Název prostředku Přečtěte si, jak nastavit názvy a typy pro podřízené prostředky v Bicepu.	string (povinné) Limit počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a spojovníky. Začněte písmenem a končite alfanumerickými číslicemi.
Nadřazené	V nástroji Bicep můžete zadat nadřazený prostředek pro podřízený prostředek. Tuto vlastnost stačí přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek. Další informace najdete v tématu Podřízený prostředek mimo nadřazený prostředek.	Symbolický název prostředku typu: service
properties	Vlastnosti kontraktu entity back-endu	Back-endContractProperties

Back-endContractProperties

Název	Description	Hodnota
jistič	Konfigurace jističe back-endu	BackendCircuitBreaker
Přihlašovací údaje	Vlastnosti kontraktu přihlašovacích údajů back-endu	BackendCredentialsContract
description	Popis back-endu.	řetězec
properties	Kontrakt vlastností back-endu	Vlastnosti back-endu
Protokol	Komunikační protokol back-endu.	'http' "mýdlo" (povinné)
proxy	Vlastnosti kontraktu back-endové brány	BackendProxyContract
resourceId	Identifikátor URI správy prostředku v externím systému. Tato adresa URL může být ID prostředku ARM pro Logic Apps, Function Apps nebo API Apps.	řetězec
title	Název back-endu.	řetězec
Tls	Vlastnosti protokolu TLS back-endu	BackendTlsProperties
url	Adresa URL modulu runtime back-endu	string (povinné)

BackendCircuitBreaker

Název	Description	Hodnota
pravidla	Pravidla pro zakopnutí back-endu	CircuitBreakerRule[]

CircuitBreakerRule

Název	Description	Hodnota
failureCondition	Podmínky pro vykopnutí jističe.	CircuitBreakerFailureCondition
name	Název pravidla.	řetězec
tripDuration	Doba trvání, po kterou se okruh vykopne.	řetězec

CircuitBreakerFailureCondition

Název	Description	Hodnota
count	Prahová hodnota pro otevření okruhu.	int
chybové důvody	Důvody chyb, které se považují za selhání.	string[]
interval	Interval, během kterého se chyby počítají.	řetězec
procentuální_hodnota	Prahová hodnota pro otevření okruhu.	int
statusCodeRanges	Rozsahy stavových kódů, které se považují za selhání.	FailureStatusCodeRange[]

FailureStatusCodeRange

Název	Description	Hodnota
max	Maximální stavový kód HTTP	int
min	Minimální stavový kód HTTP.	int

BackendCredentialsContract

Název	Description	Hodnota
autorizace	Ověřování pomocí autorizační hlavičky	BackendAuthorizationHeaderCredentials
certifikát	Seznam kryptografických otisků klientských certifikátů Pokud jsou k dispozici identifikátory certificatesId, budou ignorovány.	string[]
id certifikátu	Seznam ID klientských certifikátů	string[]
header	Popis parametru hlavičky.	BackendCredentialsContractHeader
query	Popis parametru dotazu	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Název	Description	Hodnota
parameter	Hodnota parametru ověřování	string (povinné)
scheme	Název schématu ověřování.	string (povinné)

BackendCredentialsContractHeader

Název	Description	Hodnota
{přizpůsobená vlastnost}		string[]

BackendCredentialsContractQuery

Název	Description	Hodnota
{přizpůsobená vlastnost}		string[]

Vlastnosti back-endu

Název	Description	Hodnota
serviceFabricCluster	Vlastnosti back-endového clusteru Service Fabric	BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Název	Description	Hodnota
clientCertificateId	ID klientského certifikátu pro koncový bod správy.	řetězec
clientCertificatethumbprint	Kryptografický otisk klientského certifikátu pro koncový bod správy. Pokud jsou k dispozici identifikátory certificatesId, bude se ignorovat.	řetězec
koncové body správy	Koncový bod správy clusteru.	string[] (povinné)
maxPartitionResolutionRetries	Maximální počet opakování při pokusu o překlad oddílu	int
serverCertificateThumbprints	Kryptografické otisky certifikátů, které služba pro správu clusteru používá ke komunikaci tls	string[]
serverX509Název	Kolekce názvů certifikátů serveru X509	X509CertificateName[]

X509Název certifikátu

Název	Description	Hodnota
issuerCertificateThumbprint	Kryptografický otisk vystavitele certifikátu.	řetězec
name	Běžný název certifikátu.	řetězec

BackendProxyContract

Název	Description	Hodnota
heslo	Heslo pro připojení k serveru WebProxy	řetězec
url	Vlastnost AbsoluteUri serveru WebProxy, která zahrnuje celý identifikátor URI uložený v instanci Uri, včetně všech fragmentů a řetězců dotazu.	string (povinné)
username	Uživatelské jméno pro připojení k serveru WebProxy	řetězec

BackendTlsProperties

Název	Description	Hodnota
validateCertificateChain	Příznak určující, jestli se má při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele provést ověření řetězu certifikátů SSL.	bool
validateCertificateName	Příznak určující, jestli se má při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele provést ověření názvu certifikátu SSL.	bool

Definice prostředku šablony ARM

Typ prostředku služby nebo back-endů je možné nasadit s operacemi, které cílí na:

Skupiny prostředků – viz příkazy pro nasazení skupin prostředků.

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/backends, přidejte do šablony následující kód JSON.

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

Hodnoty vlastností

služba /back-endy

Název	Description	Hodnota
typ	Typ prostředku	Microsoft.ApiManagement/service/backends
apiVersion	Verze rozhraní API prostředku	2023-03-01-preview
name	Název prostředku Podívejte se, jak nastavit názvy a typy pro podřízené prostředky v šablonách JSON ARM.	string (povinné) Omezení počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a pomlčky. Začněte písmenem a končíte alfanumerickými znaky.
properties	Vlastnosti kontraktu back-endové entity	BackendContractProperties

BackendContractProperties

Název	Description	Hodnota
jistič	Konfigurace jističe back-endu	BackendCircuitBreaker
Přihlašovací údaje	Vlastnosti kontraktu přihlašovacích údajů back-endu	BackendCredentialsContract
description	Popis back-endu	řetězec
properties	Kontrakt vlastností back-endu	Vlastnosti back-endu
Protokol	Komunikační protokol back-endu.	'http' "mýdlo" (povinné)
proxy	Vlastnosti kontraktu back-endové brány	BackendProxyContract
resourceId	Identifikátor URI správy prostředku v externím systému. Tato adresa URL může být ID prostředku ARM pro Logic Apps, Function Apps nebo API Apps.	řetězec
title	Název back-endu.	řetězec
Tls	Vlastnosti protokolu TLS back-endu	BackendTlsProperties
url	Adresa URL modulu runtime back-endu.	string (povinné)

BackendCircuitBreaker

Název	Description	Hodnota
pravidla	Pravidla pro zakopnutí back-endu	CircuitBreakerRule[]

CircuitBreakerRule

Název	Description	Hodnota
failureCondition	Podmínky pro vykopnutí jističe.	CircuitBreakerFailureCondition
name	Název pravidla.	řetězec
tripDuration	Doba trvání, po kterou se okruh vykopne.	řetězec

CircuitBreakerFailureCondition

Název	Description	Hodnota
count	Prahová hodnota pro otevření okruhu.	int
chybové důvody	Příčiny chyb, které se považují za selhání.	string[]
interval	Interval, během kterého se chyby počítají.	řetězec
procentuální_hodnota	Prahová hodnota pro otevření okruhu.	int
statusCodeRanges	Rozsahy stavových kódů, které se považují za selhání.	FailureStatusCodeRange[]

FailureStatusCodeRange

Název	Description	Hodnota
max	Maximální stavový kód HTTP.	int
min	Minimální stavový kód HTTP.	int

BackendCredentialsContract

Název	Description	Hodnota
autorizace	Ověřování autorizační hlavičky	BackendAuthorizationHeaderCredentials
certifikát	Seznam kryptografických otisků klientských certifikátů Pokud jsou k dispozici identifikátory certificatesId, budou ignorovány.	string[]
id certifikátu	Seznam ID klientských certifikátů	string[]
header	Popis parametru záhlaví.	BackendCredentialsContractHeader
query	Popis parametru dotazu	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Název	Description	Hodnota
parameter	Hodnota parametru ověřování.	string (povinné)
scheme	Název schématu ověřování.	string (povinné)

BackendCredentialsContractHeader

Název	Description	Hodnota
{přizpůsobená vlastnost}		string[]

BackendCredentialsContractQuery

Název	Description	Hodnota
{přizpůsobená vlastnost}		string[]

Vlastnosti back-endu

Název	Description	Hodnota
serviceFabricCluster	Vlastnosti back-endu clusteru Service Fabric	BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Název	Description	Hodnota
clientCertificateId	ID klientského certifikátu pro koncový bod správy	řetězec
clientCertificatethumbprint	Kryptografický otisk klientského certifikátu pro koncový bod správy. Pokud jsou k dispozici identifikátory certificatesId, budou ignorovány.	řetězec
správaEndpoints	Koncový bod správy clusteru.	string[] (povinné)
maxPartitionResolutionRetries	Maximální počet opakování při pokusu o vyřešení oddílu	int
serverCertificateThumbprints	Kryptografické otisky certifikátů, které služba pro správu clusteru používá ke komunikaci tls	string[]
serverX509Names	Kolekce názvů certifikátů serveru X509	X509CertificateName[]

X509CertificateName

Název	Description	Hodnota
issuerCertificateThumbprint	Kryptografický otisk vystavitele certifikátu.	řetězec
name	Běžný název certifikátu.	řetězec

BackendProxyContract

Název	Description	Hodnota
heslo	Heslo pro připojení k serveru WebProxy	řetězec
url	Vlastnost AbsoluteUri serveru WebProxy, která zahrnuje celý identifikátor URI uložený v instanci URI, včetně všech fragmentů a řetězců dotazů.	string (povinné)
username	Uživatelské jméno pro připojení k serveru WebProxy	řetězec

BackendTlsProperties

Název	Description	Hodnota
validateCertificateChain	Příznak označující, jestli se má při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele provést ověření řetězu certifikátů SSL.	bool
validateCertificateName	Příznak označující, jestli se má při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele provést ověření názvu certifikátu SSL.	bool

Definice prostředku Terraformu (zprostředkovatele AzAPI)

Typ prostředku service/back-ends je možné nasadit s operacemi, které cílí na:

Skupiny prostředků

Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn.

Formát prostředku

Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/backends, přidejte do šablony následující Terraform.

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

Hodnoty vlastností

služba/back-endy

Název	Description	Hodnota
typ	Typ prostředku	Microsoft.ApiManagement/service/backends@2023-03-01-preview
name	Název prostředku	string (povinné) Limit počtu znaků: 1–80 Platné znaky: Alfanumerické znaky a spojovníky. Začněte písmenem a končite alfanumerickými číslicemi.
parent_id	ID prostředku, který je nadřazený pro tento prostředek.	ID prostředku typu: service
properties	Vlastnosti kontraktu entity back-endu	Back-endContractProperties

Back-endContractProperties

Název	Description	Hodnota
jistič	Konfigurace jističe back-endu	BackendCircuitBreaker
Přihlašovací údaje	Vlastnosti kontraktu přihlašovacích údajů back-endu	BackendCredentialsContract
description	Popis back-endu.	řetězec
properties	Kontrakt vlastností back-endu	Vlastnosti back-endu
Protokol	Komunikační protokol back-endu.	"http" "soap" (povinné)
proxy	Vlastnosti kontraktu back-endové brány	BackendProxyContract
resourceId	Identifikátor URI správy prostředku v externím systému. Tato adresa URL může být ID prostředku ARM pro Logic Apps, Function Apps nebo API Apps.	řetězec
title	Název back-endu.	řetězec
Tls	Vlastnosti protokolu TLS back-endu	BackendTlsProperties
url	Adresa URL modulu runtime back-endu	string (povinné)

BackendCircuitBreaker

Název	Description	Hodnota
pravidla	Pravidla pro zakopnutí back-endu	CircuitBreakerRule[]

CircuitBreakerRule

Název	Description	Hodnota
failureCondition	Podmínky pro vykopnutí jističe.	CircuitBreakerFailureCondition
name	Název pravidla.	řetězec
tripDuration	Doba trvání, po kterou se okruh vykopne.	řetězec

CircuitBreakerFailureCondition

Název	Description	Hodnota
count	Prahová hodnota pro otevření okruhu.	int
chybové důvody	Příčiny chyb, které se považují za selhání.	string[]
interval	Interval, během kterého se chyby počítají.	řetězec
procentuální_hodnota	Prahová hodnota pro otevření okruhu.	int
statusCodeRanges	Rozsahy stavových kódů, které se považují za selhání.	FailureStatusCodeRange[]

FailureStatusCodeRange

Název	Description	Hodnota
max	Maximální stavový kód HTTP.	int
min	Minimální stavový kód HTTP.	int

BackendCredentialsContract

Název	Description	Hodnota
autorizace	Ověřování autorizační hlavičky	BackendAuthorizationHeaderCredentials
certifikát	Seznam kryptografických otisků klientských certifikátů Pokud jsou k dispozici identifikátory certificatesId, budou ignorovány.	string[]
id certifikátu	Seznam ID klientských certifikátů	string[]
header	Popis parametru záhlaví.	BackendCredentialsContractHeader
query	Popis parametru dotazu	BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Název	Description	Hodnota
parameter	Hodnota parametru ověřování.	string (povinné)
scheme	Název schématu ověřování.	string (povinné)

BackendCredentialsContractHeader

Název	Description	Hodnota
{přizpůsobená vlastnost}		string[]

BackendCredentialsContractQuery

Název	Description	Hodnota
{přizpůsobená vlastnost}		string[]

Vlastnosti back-endu

Název	Description	Hodnota
serviceFabricCluster	Vlastnosti back-endového clusteru Service Fabric	BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Název	Description	Hodnota
clientCertificateId	ID klientského certifikátu pro koncový bod správy.	řetězec
clientCertificatethumbprint	Kryptografický otisk klientského certifikátu pro koncový bod správy. Pokud jsou k dispozici identifikátory certificatesId, bude se ignorovat.	řetězec
koncové body správy	Koncový bod správy clusteru.	string[] (povinné)
maxPartitionResolutionRetries	Maximální počet opakování při pokusu o překlad oddílu	int
serverCertificateThumbprints	Kryptografické otisky certifikátů, které služba pro správu clusteru používá ke komunikaci tls	string[]
serverX509Název	Kolekce názvů certifikátů serveru X509	X509CertificateName[]

X509Název certifikátu

Název	Description	Hodnota
issuerCertificateThumbprint	Kryptografický otisk vystavitele certifikátu.	řetězec
name	Běžný název certifikátu.	řetězec

BackendProxyContract

Název	Description	Hodnota
heslo	Heslo pro připojení k serveru WebProxy	řetězec
url	Vlastnost AbsoluteUri serveru WebProxy, která zahrnuje celý identifikátor URI uložený v instanci Uri, včetně všech fragmentů a řetězců dotazu.	string (povinné)
username	Uživatelské jméno pro připojení k serveru WebProxy	řetězec

BackendTlsProperties

Název	Description	Hodnota
validateCertificateChain	Příznak určující, jestli se má při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele provést ověření řetězu certifikátů SSL.	bool
validateCertificateName	Příznak určující, jestli se má při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele provést ověření názvu certifikátu SSL.	bool

Služba Microsoft.ApiManagement/back-endy 2023-03-01-preview

Definice prostředku Bicep

Formát prostředku

Hodnoty vlastností

služba/back-endy

Back-endContractProperties

BackendCircuitBreaker

CircuitBreakerRule

CircuitBreakerFailureCondition

FailureStatusCodeRange

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

Vlastnosti back-endu

BackendServiceFabricClusterProperties

X509Název certifikátu

BackendProxyContract

BackendTlsProperties

Definice prostředku šablony ARM

Formát prostředku

Hodnoty vlastností

služba /back-endy

BackendContractProperties

BackendCircuitBreaker

CircuitBreakerRule

CircuitBreakerFailureCondition

FailureStatusCodeRange

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

Vlastnosti back-endu

BackendServiceFabricClusterProperties

X509CertificateName

BackendProxyContract

BackendTlsProperties

Definice prostředku Terraformu (zprostředkovatele AzAPI)

Formát prostředku

Hodnoty vlastností

služba/back-endy

Back-endContractProperties

BackendCircuitBreaker

CircuitBreakerRule

CircuitBreakerFailureCondition

FailureStatusCodeRange

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

Vlastnosti back-endu

BackendServiceFabricClusterProperties

X509Název certifikátu

BackendProxyContract

BackendTlsProperties

Další materiály