Megosztás a következőn keresztül:

Microsoft.ApiManagement szolgáltatás/háttérrendszer

  • Cikk

Bicep-erőforrásdefiníció

A szolgáltatás/háttérrendszer erőforrástípusa üzembe helyezhető olyan műveletekkel, amelyek a következő célokat célják:

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.

Erőforrás formátuma

Microsoft.ApiManagement/service/backends erőforrás létrehozásához adja hozzá a következő Bicep-et a sablonhoz.

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

Tulajdonságértékek

szolgáltatás/háttérrendszer

Név Leírás Érték
name Az erőforrás neve

Megtudhatja, hogyan állíthatja be a gyermekerőforrások nevét és típusát a Bicepben.		 sztring (kötelező)

Karakterkorlát: 1-80

Érvényes karakterek:
Alfanumerikák és kötőjelek.

Kezdje betűvel és végződéssel alfanumerikussal.
Szülő A Bicepben megadhatja egy gyermekerőforrás szülőerőforrását. Ezt a tulajdonságot csak akkor kell hozzáadnia, ha a gyermekerőforrás a szülőerőforráson kívül van deklarálva.

További információ: Gyermekerőforrás a szülőerőforráson kívül.		 A típus erőforrásának szimbolikus neve: szolgáltatás
properties Háttér entitásszerződés tulajdonságai. BackendContractProperties

BackendContractProperties

Név Leírás Érték
circuitBreaker Háttér áramkör-megszakító konfigurációja BackendCircuitBreaker
hitelesítő adatok Háttérbeli hitelesítő adatok szerződésének tulajdonságai BackendCredentialsContract
leírás Háttér leírása. sztring
Medence BackendBaseParametersPool
properties Háttértulajdonságok szerződése Háttértulajdonságok
Protokoll Háttérbeli kommunikációs protokoll. "http"
"szappan" (kötelező)
proxy Háttérátjáró szerződésének tulajdonságai BackendProxyContract
resourceId Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Függvényalkalmazások vagy az API-alkalmazások ARM-erőforrás-azonosítója. sztring
cím Háttércím. sztring
Tls Háttérbeli TLS-tulajdonságok BackendTlsProperties
típus A háttérrendszer típusa. A háttérrendszer lehet önálló vagy készlet. "Készlet"
'Single'
url A háttérrendszer futtatókörnyezeti URL-címe. sztring (kötelező)

BackendCircuitBreaker

Név Leírás Érték
szabályok A háttérrendszer bemásolásának szabályai. CircuitBreakerRule[]

CircuitBreakerRule

Név Leírás Érték
failureCondition Az áramkör-megszakító bemásolásának feltételei. CircuitBreakerFailureCondition
name A szabály neve. sztring
tripDuration A kapcsolatcsoport megbotlásához szükséges időtartam. sztring

CircuitBreakerFailureCondition

Név Leírás Érték
count A kapcsolatcsoport megnyitásának küszöbértéke. int
errorReasons A hiba okai, amelyek hibának minősülnek. sztring[]
interval A hibák számbavételének időköze. sztring
percentage A kapcsolatcsoport megnyitásának küszöbértéke. int
statusCodeRanges Az állapotkód-tartományok, amelyek hibásnak minősülnek. FailureStatusCodeRange[]

FailureStatusCodeRange

Név Leírás Érték
max. A maximális HTTP-állapotkód. int
p A minimális HTTP-állapotkód. int

BackendCredentialsContract

Név Leírás Érték
engedélyezés Engedélyezési fejléc hitelesítése BackendAuthorizationHeaderCredentials
tanúsítvány Ügyféltanúsítvány ujjlenyomatainak listája. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva. sztring[]
certificateIds Ügyféltanúsítvány-azonosítók listája. sztring[]
fejléc Fejlécparaméter leírása. BackendCredentialsContractHeader
query Lekérdezési paraméter leírása. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Név Leírás Érték
parameter Hitelesítési paraméter értéke. sztring (kötelező)
Rendszer Hitelesítési séma neve. sztring (kötelező)

BackendCredentialsContractHeader

Név Leírás Érték
{customized property} sztring[]

BackendCredentialsContractQuery

Név Leírás Érték
{customized property} sztring[]

BackendBaseParametersPool

Név Leírás Érték
services A készlethez tartozó háttérentitások listája. BackendPoolItem[]

BackendPoolItem

Név Leírás Érték
id A háttérentitás egyedi ARM-azonosítója. Az ARM-azonosítónak egy már meglévő háttérentitásra kell hivatkoznia. sztring (kötelező)

BackendProperties

Név Leírás Érték
serviceFabricCluster Háttérbeli Service Fabric-fürt tulajdonságai BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Név Leírás Érték
clientCertificateId A felügyeleti végpont ügyféltanúsítvány-azonosítója. sztring
clientCertificatethumbprint A felügyeleti végpont ügyféltanúsítványának ujjlenyomata. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva sztring
managementEndpoints A fürtkezelési végpont. sztring[] (kötelező)
maxPartitionResolutionRetries A partíció feloldása során az újrapróbálkozások maximális száma. int
serverCertificateThumbprints A tanúsítványfürt-felügyeleti szolgáltatás tls-kommunikációhoz használt ujjlenyomatai sztring[]
serverX509Names Kiszolgáló X509-tanúsítványnevek gyűjteménye X509CertificateName[]

X509CertificateName

Név Leírás Érték
issuerCertificateThumbprint A tanúsítvány kiállítójának ujjlenyomata. sztring
name A tanúsítvány általános neve. sztring

BackendProxyContract

Név Leírás Érték
jelszó Jelszó a WebProxy-kiszolgálóhoz való csatlakozáshoz sztring
url WebProxy Server AbsoluteUri tulajdonság, amely tartalmazza az URI-példányban tárolt teljes URI-t, beleértve az összes töredéket és lekérdezési sztringet. sztring (kötelező)
username Felhasználónév a WebProxy-kiszolgálóhoz való csatlakozáshoz sztring

BackendTlsProperties

Név Leírás Érték
validateCertificateChain Jelző, amely azt jelzi, hogy az SSL-tanúsítványlánc érvényesítését el kell-e végezni, amikor önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez. logikai
validateCertificateName Jelző, amely azt jelzi, hogy az SSL-tanúsítvány nevének érvényesítését el kell-e végezni, amikor önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez. logikai

ARM-sablon erőforrásdefiníciója

A szolgáltatás/háttérrendszer erőforrástípusa üzembe helyezhető olyan műveletekkel, amelyek a következő célokat célják:

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.

Erőforrás formátuma

Microsoft.ApiManagement/service/backends erőforrás létrehozásához adja hozzá a következő JSON-t a sablonhoz.

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

Tulajdonságértékek

szolgáltatás/háttérrendszer

Név Leírás Érték
típus Az erőforrás típusa "Microsoft.ApiManagement/service/backends"
apiVersion Az erőforrás API-verziója "2023-05-01-preview"
name Az erőforrás neve

Megtudhatja, hogyan állíthatja be a gyermekerőforrások nevét és típusát A JSON ARM-sablonokban.		 sztring (kötelező)

Karakterkorlát: 1-80

Érvényes karakterek:
Alfanumerikák és kötőjelek.

Kezdje betűvel és végződéssel alfanumerikussal.
properties Háttér entitásszerződés tulajdonságai. BackendContractProperties

BackendContractProperties

Név Leírás Érték
circuitBreaker Háttér áramkör-megszakító konfigurációja BackendCircuitBreaker
hitelesítő adatok Háttérbeli hitelesítő adatok szerződésének tulajdonságai BackendCredentialsContract
leírás Háttér leírása. sztring
Medence BackendBaseParametersPool
properties Háttértulajdonságok szerződése Háttértulajdonságok
Protokoll Háttérbeli kommunikációs protokoll. "http"
"szappan" (kötelező)
proxy Háttérátjáró szerződésének tulajdonságai BackendProxyContract
resourceId Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Függvényalkalmazások vagy az API-alkalmazások ARM-erőforrás-azonosítója. sztring
cím Háttércím. sztring
Tls Háttérbeli TLS-tulajdonságok BackendTlsProperties
típus A háttérrendszer típusa. A háttérrendszer lehet önálló vagy készlet. "Készlet"
'Single'
url A háttérrendszer futtatókörnyezeti URL-címe. sztring (kötelező)

BackendCircuitBreaker

Név Leírás Érték
szabályok A háttérrendszer bemásolásának szabályai. CircuitBreakerRule[]

CircuitBreakerRule

Név Leírás Érték
failureCondition Az áramkör-megszakító bemásolásának feltételei. CircuitBreakerFailureCondition
name A szabály neve. sztring
tripDuration A kapcsolatcsoport megbotlásához szükséges időtartam. sztring

CircuitBreakerFailureCondition

Név Leírás Érték
count A kapcsolatcsoport megnyitásának küszöbértéke. int
errorReasons A hiba okai, amelyek hibának minősülnek. sztring[]
interval A hibák számbavételének időköze. sztring
percentage A kapcsolatcsoport megnyitásának küszöbértéke. int
statusCodeRanges A hibaként tekintett állapotkódtartományok. FailureStatusCodeRange[]

FailureStatusCodeRange

Név Leírás Érték
max. A http-állapotkód maximális száma. int
p A minimális HTTP-állapotkód. int

BackendCredentialsContract

Név Leírás Érték
engedélyezés Engedélyezési fejléc hitelesítése BackendAuthorizationHeaderCredentials
tanúsítvány Ügyféltanúsítvány ujjlenyomatainak listája. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva. sztring[]
certificateIds Ügyféltanúsítvány-azonosítók listája. sztring[]
fejléc Fejlécparaméter leírása. Háttérbeli hitelesítő adatokContractHeader
query Lekérdezési paraméter leírása. HáttérbelicredentialsContractQuery

BackendAuthorizationHeaderCredentials

Név Leírás Érték
parameter Hitelesítési paraméter értéke. sztring (kötelező)
Rendszer Hitelesítési séma neve. sztring (kötelező)

BackendCredentialsContractHeader

Név Leírás Érték
{customized property} sztring[]

BackendCredentialsContractQuery

Név Leírás Érték
{customized property} sztring[]

BackendBaseParametersPool

Név Leírás Érték
services A készlethez tartozó háttérentitások listája. BackendPoolItem[]

BackendPoolItem

Név Leírás Érték
id A háttérentitás egyedi ARM-azonosítója. Az ARM-azonosítónak egy már meglévő háttérentitásra kell hivatkoznia. sztring (kötelező)

BackendProperties

Név Leírás Érték
serviceFabricCluster Háttérbeli Service Fabric-fürt tulajdonságai BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Név Leírás Érték
clientCertificateId A felügyeleti végpont ügyféltanúsítvány-azonosítója. sztring
clientCertificatethumbprint A felügyeleti végpont ügyféltanúsítvány-ujjlenyomata. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva sztring
managementEndpoints A fürtkezelési végpont. string[] (kötelező)
maxPartitionResolutionRetries A partíció feloldása során az újrapróbálkozások maximális száma. int
serverCertificateThumbprints A fürtkezelési szolgáltatás által a tls-kommunikációhoz használt tanúsítványok ujjlenyomatai sztring[]
serverX509Names Server X509-tanúsítványnévgyűjtemény X509CertificateName[]

X509CertificateName

Név Leírás Érték
issuerCertificateThumbprint A tanúsítvány kiállítójának ujjlenyomata. sztring
name A tanúsítvány köznapi neve. sztring

BackendProxyContract

Név Leírás Érték
jelszó Jelszó a WebProxy-kiszolgálóhoz való csatlakozáshoz sztring
url WebProxy Server AbsoluteUri tulajdonság, amely tartalmazza az URI-példányban tárolt teljes URI-t, beleértve az összes töredéket és lekérdezési sztringet. sztring (kötelező)
username Felhasználónév a WebProxy-kiszolgálóhoz való csatlakozáshoz sztring

BackendTlsProperties

Név Leírás Érték
validateCertificateChain Jelölő, amely jelzi, hogy az SSL-tanúsítványlánc érvényesítését el kell-e végezni, amikor önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez. logikai
validateCertificateName Jelölő, amely azt jelzi, hogy az SSL-tanúsítvány nevének érvényesítését el kell-e végezni, amikor önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez. logikai

Terraform -erőforrásdefiníció (AzAPI-szolgáltató)

A szolgáltatás/háttérrendszer erőforrástípusa olyan műveletekkel helyezhető üzembe, amelyek a következőket célják:

  • Erőforráscsoportok

Az egyes API-verziók módosított tulajdonságainak listáját a változásnaplóban találja.

Erőforrás formátuma

Microsoft.ApiManagement/service/backends erőforrás létrehozásához adja hozzá a következő Terraformot a sablonhoz.

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

Tulajdonságértékek

szolgáltatás/háttérrendszer

Név Leírás Érték
típus Az erőforrás típusa "Microsoft.ApiManagement/service/backends@2023-05-01-preview"
name Az erőforrás neve sztring (kötelező)

Karakterkorlát: 1-80

Érvényes karakterek:
Alfanumerikák és kötőjelek.

Kezdje betűvel és végződéssel alfanumerikussal.
parent_id Az erőforrás szülőjének azonosítója. A következő típusú erőforrás azonosítója: szolgáltatás
properties Háttér entitásszerződés tulajdonságai. BackendContractProperties

BackendContractProperties

Név Leírás Érték
circuitBreaker Háttér áramkör-megszakító konfigurációja BackendCircuitBreaker
hitelesítő adatok Háttérbeli hitelesítő adatok szerződésének tulajdonságai BackendCredentialsContract
leírás Háttér leírása. sztring
Medence BackendBaseParametersPool
properties Háttértulajdonságok szerződése Háttértulajdonságok
Protokoll Háttérbeli kommunikációs protokoll. "http"
"szappan" (kötelező)
proxy Háttérátjáró szerződésének tulajdonságai BackendProxyContract
resourceId Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Függvényalkalmazások vagy az API-alkalmazások ARM-erőforrás-azonosítója. sztring
cím Háttércím. sztring
Tls Háttérbeli TLS-tulajdonságok BackendTlsProperties
típus A háttérrendszer típusa. A háttérrendszer lehet önálló vagy készlet. "Készlet"
"Önálló"
url A háttérrendszer futtatókörnyezeti URL-címe. sztring (kötelező)

BackendCircuitBreaker

Név Leírás Érték
szabályok A háttérrendszer bemásolásának szabályai. CircuitBreakerRule[]

CircuitBreakerRule

Név Leírás Érték
failureCondition Az áramkör-megszakító bemásolásának feltételei. CircuitBreakerFailureCondition
name A szabály neve. sztring
tripDuration A kapcsolatcsoport megbotlásához szükséges időtartam. sztring

CircuitBreakerFailureCondition

Név Leírás Érték
count A kapcsolatcsoport megnyitásának küszöbértéke. int
errorReasons A hiba okai, amelyek hibának minősülnek. sztring[]
interval A hibák számbavételének időköze. sztring
percentage A kapcsolatcsoport megnyitásának küszöbértéke. int
statusCodeRanges A hibaként tekintett állapotkódtartományok. FailureStatusCodeRange[]

FailureStatusCodeRange

Név Leírás Érték
max. A http-állapotkód maximális száma. int
p A minimális HTTP-állapotkód. int

BackendCredentialsContract

Név Leírás Érték
engedélyezés Engedélyezési fejléc hitelesítése BackendAuthorizationHeaderCredentials
tanúsítvány Ügyféltanúsítvány ujjlenyomatainak listája. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva. sztring[]
certificateIds Ügyféltanúsítvány-azonosítók listája. sztring[]
fejléc Fejlécparaméter leírása. Háttérbeli hitelesítő adatokContractHeader
query Lekérdezési paraméter leírása. HáttérbelicredentialsContractQuery

BackendAuthorizationHeaderCredentials

Név Leírás Érték
parameter Hitelesítési paraméter értéke. sztring (kötelező)
Rendszer Hitelesítési séma neve. sztring (kötelező)

Háttérbeli hitelesítő adatokContractHeader

Név Leírás Érték
{testreszabott tulajdonság} sztring[]

HáttérbelicredentialsContractQuery

Név Leírás Érték
{testreszabott tulajdonság} sztring[]

BackendBaseParametersPool

Név Leírás Érték
services A készlethez tartozó háttérentitások listája. BackendPoolItem[]

BackendPoolItem

Név Leírás Érték
id A háttérentitás egyedi ARM-azonosítója. Az ARM-azonosítónak egy már meglévő háttérentitásra kell hivatkoznia. sztring (kötelező)

Háttértulajdonságok

Név Leírás Érték
serviceFabricCluster Háttérszolgáltatás-hálófürt tulajdonságai BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Név Leírás Érték
clientCertificateId A felügyeleti végpont ügyféltanúsítvány-azonosítója. sztring
clientCertificatethumbprint A felügyeleti végpont ügyféltanúsítványának ujjlenyomata. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva sztring
managementEndpoints A fürtkezelési végpont. sztring[] (kötelező)
maxPartitionResolutionRetries A partíció feloldása során az újrapróbálkozások maximális száma. int
serverCertificateThumbprints A tanúsítványfürt-felügyeleti szolgáltatás tls-kommunikációhoz használt ujjlenyomatai sztring[]
serverX509Names Kiszolgáló X509-tanúsítványnevek gyűjteménye X509CertificateName[]

X509CertificateName

Név Leírás Érték
issuerCertificateThumbprint A tanúsítvány kiállítójának ujjlenyomata. sztring
name A tanúsítvány általános neve. sztring

BackendProxyContract

Név Leírás Érték
jelszó Jelszó a WebProxy-kiszolgálóhoz való csatlakozáshoz sztring
url WebProxy Server AbsoluteUri tulajdonság, amely tartalmazza az URI-példányban tárolt teljes URI-t, beleértve az összes töredéket és lekérdezési sztringet. sztring (kötelező)
username Felhasználónév a WebProxy-kiszolgálóhoz való csatlakozáshoz sztring

BackendTlsProperties

Név Leírás Érték
validateCertificateChain Jelző, amely azt jelzi, hogy az SSL-tanúsítványlánc érvényesítését el kell-e végezni, amikor önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez. logikai
validateCertificateName Jelző, amely azt jelzi, hogy az SSL-tanúsítvány nevének érvényesítését el kell-e végezni, amikor önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez. logikai