Služba Microsoft.ApiManagement/ back-endy
Článek 01/18/2024
1 přispěvatel
Váš názor
V tomto článku
Definice prostředku Bicep
Typ prostředku služby nebo back-endů je možné nasadit s operacemi, které cílí na:
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn .
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/backends, přidejte do šablony následující bicep.
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'
}
}
Hodnoty vlastností
služba /back-endy
Název
Description
Hodnota
name
Název prostředkunástroji Bicep .
string (povinné)
Nadřazené
V nástroji Bicep můžete zadat nadřazený prostředek podřízeného prostředku. Tuto vlastnost stačí přidat pouze v případě, že je podřízený prostředek deklarován mimo nadřazený prostředek.Podřízený prostředek mimo nadřazený prostředek .
Symbolický název prostředku typu service
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
Bazén
BackendBaseParametersPool
properties
Kontrakt vlastností back-endu
Vlastnosti back-endu
Protokol
Komunikační protokol back-endu.
'http'
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
typ
Typ back-endu Back-end může být buď single, nebo fond.
'Bazén'
url
Adresa URL modulu runtime back-endu.
string (povinné)
BackendCircuitBreaker
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 bude okruh vykopáv.
ř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
parameter
Hodnota parametru ověřování
string (povinné)
scheme
Název schématu ověřování.
string (povinné)
Název
Description
Hodnota
{přizpůsobená vlastnost}
string[]
BackendCredentialsContractQuery
Název
Description
Hodnota
{přizpůsobená vlastnost}
string[]
BackendBaseParametersPool
Název
Description
Hodnota
services
Seznam back-endových entit patřících do fondu.
BackendPoolItem []
BackendPoolItem
Název
Description
Hodnota
id
Jedinečné ID ARM back-endové entity. ID ARM by mělo odkazovat na již existující entitu back-endu.
string (povinné)
Vlastnosti back-endu
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 šablony ARM
Typ prostředku service/back-ends je možné nasadit s operacemi, které cílí na:
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn .
Pokud chcete vytvořit prostředek Microsoft.ApiManagement/service/back-ends, přidejte do šablony následující kód JSON.
{
"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"
}
}
Hodnoty vlastností
služba/back-endy
Název
Description
Hodnota
typ
Typ prostředku
Microsoft.ApiManagement/service/back-ends
apiVersion
Verze rozhraní API prostředků
'2023-05-01-preview'
name
Název prostředkušablonách JSON ARM .
string (povinné)
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
Bazén
BackendBaseParametersPool
properties
Kontrakt vlastností back-endu
Vlastnosti back-endu
Protokol
Komunikační protokol back-endu.
'http'
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
typ
Typ back-endu. Back-end může být single nebo pool.
'Bazén'
url
Adresa URL modulu runtime back-endu
string (povinné)
BackendCircuitBreaker
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
parameter
Hodnota parametru ověřování.
string (povinné)
scheme
Název schématu ověřování.
string (povinné)
Název
Description
Hodnota
{přizpůsobená vlastnost}
string[]
BackendCredentialsContractQuery
Název
Description
Hodnota
{přizpůsobená vlastnost}
string[]
BackendBaseParametersPool
Název
Description
Hodnota
services
Seznam back-endových entit patřících do fondu.
BackendPoolItem []
BackendPoolItem
Název
Description
Hodnota
id
Jedinečné ID ARM back-endové entity. ID ARM by mělo odkazovat na již existující entitu back-endu.
string (povinné)
Vlastnosti back-endu
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
Typ prostředku service/back-ends je možné nasadit s operacemi, které cílí na:
Seznam změněných vlastností v jednotlivých verzích rozhraní API najdete v protokolu změn .
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-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"
}
})
}
Hodnoty vlastností
služba/back-endy
Název
Description
Hodnota
typ
Typ prostředku
Microsoft.ApiManagement/service/backends@2023-05-01-preview
name
Název prostředku
string (povinné)
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
Bazén
BackendBaseParametersPool
properties
Kontrakt vlastností back-endu
Vlastnosti back-endu
Protokol
Komunikační protokol back-endu.
"http"
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
typ
Typ back-endu. Back-end může být single nebo pool.
"Bazén"
url
Adresa URL modulu runtime back-endu
string (povinné)
BackendCircuitBreaker
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
parameter
Hodnota parametru ověřování
string (povinné)
scheme
Název schématu ověřování.
string (povinné)
Název
Description
Hodnota
{přizpůsobená vlastnost}
string[]
BackendCredentialsContractQuery
Název
Description
Hodnota
{přizpůsobená vlastnost}
string[]
BackendBaseParametersPool
Název
Description
Hodnota
services
Seznam back-endových entit patřících do fondu.
BackendPoolItem []
BackendPoolItem
Název
Description
Hodnota
id
Jedinečné ID ARM back-endové entity. ID ARM by mělo odkazovat na již existující entitu back-endu.
string (povinné)
Vlastnosti back-endu
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ů 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