Microsoft.ApiManagement-tjänst/serverdelar
Artikel 01/18/2024
1 deltagare
Feedback
I den här artikeln
Bicep-resursdefinition
Resurstypen tjänst/serverdel kan distribueras med åtgärder som mål:
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen .
Om du vill skapa en Resurs för Microsoft.ApiManagement/service/backends lägger du till följande Bicep i mallen.
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'
}
}
Egenskapsvärden
tjänst/serverdelar
Name
Beskrivning
Värde
name
ResursnamnetBicep .
sträng (krävs)
parent
I Bicep kan du ange den överordnade resursen för en underordnad resurs. Du behöver bara lägga till den här egenskapen när den underordnade resursen deklareras utanför den överordnade resursen.Underordnad resurs utanför överordnad resurs .
Symboliskt namn för resurs av typen: tjänst
properties
Egenskaper för serverdelsentitetskontrakt.
BackendContractProperties
BackendContractProperties
Name
Beskrivning
Värde
circuitBreaker
Konfiguration av backend-kretsbrytare
BackendCircuitBreaker
autentiseringsuppgifter
Egenskaper för kontrakt för serverdelsautentiseringsuppgifter
BackendCredentialsContract
beskrivning
Beskrivning av serverdelen.
sträng
Pool
BackendBaseParametersPool
properties
Kontrakt för serverdelsegenskaper
BackendProperties
Protokollet
Protokoll för serverdelskommunikation.
"http"
proxy
Egenskaper för serverdelsgatewaykontrakt
BackendProxyContract
resourceId
Hanterings-URI för resursen i det externa systemet. Den här URL:en kan vara armresurs-ID för Logic Apps, Funktionsappar eller API Apps.
sträng
title
Serverdelsrubrik.
sträng
Tls
Egenskaper för serverdels-TLS
BackendTlsProperties
typ
Typ av serverdel. En serverdel kan vara antingen Enskild eller Pool.
"Pool"
url
Körnings-URL för serverdelen.
sträng (krävs)
BackendCircuitBreaker
CircuitBreakerRule
Name
Beskrivning
Värde
failureCondition
Villkoren för att snubbla strömbrytaren.
CircuitBreakerFailureCondition
name
Regelnamnet.
sträng
tripDuration
Hur länge kretsen kommer att snubblas.
sträng
CircuitBreakerFailureCondition
Name
Beskrivning
Värde
count
Tröskelvärdet för att öppna kretsen.
int
errorReasons
De felorsaker som betraktas som fel.
string[]
interval
Det intervall under vilket felen räknas.
sträng
percentage
Tröskelvärdet för att öppna kretsen.
int
statusCodeRanges
De statuskodintervall som betraktas som fel.
FailureStatusCodeRange []
FailureStatusCodeRange
Name
Beskrivning
Värde
max
Maximal http-statuskod.
int
min
Minsta http-statuskod.
int
BackendCredentialsContract
Name
Beskrivning
Värde
parameter
Värdet för autentiseringsparametern.
sträng (krävs)
System
Namn på autentiseringsschema.
sträng (krävs)
Name
Beskrivning
Värde
{anpassad egenskap}
string[]
BackendCredentialsContractQuery
Name
Beskrivning
Värde
{anpassad egenskap}
string[]
BackendBaseParametersPool
Name
Beskrivning
Värde
services
Listan över serverdelsentiteter som tillhör en pool.
BackendPoolItem []
BackendPoolItem
Name
Beskrivning
Värde
id
Det unika ARM-ID:t för serverdelsentiteten. ARM-ID:t bör referera till en redan befintlig serverdelsentitet.
sträng (krävs)
BackendProperties
BackendServiceFabricClusterProperties
Name
Beskrivning
Värde
clientCertificateId
Klientcertifikat-ID för hanteringsslutpunkten.
sträng
clientCertificatethumbprint
Tumavtrycket för klientcertifikatet för hanteringsslutpunkten. Ignoreras om certificatesIds tillhandahålls
sträng
managementEndpoints
Slutpunkten för klusterhantering.
string[] (krävs)
maxPartitionResolutionRetries
Maximalt antal återförsök vid försök att lösa partitionen.
int
serverCertificateThumbprints
Tumavtryck för certifikat som klusterhanteringstjänsten använder för tls-kommunikation
string[]
serverX509Names
Server X509-certifikatnamnsamling
X509CertificateName []
X509CertificateName
Name
Beskrivning
Värde
issuerCertificateThumbprint
Tumavtryck för certifikatutfärdaren.
sträng
name
Eget namn på certifikatet.
sträng
BackendProxyContract
Name
Beskrivning
Värde
password
Lösenord för att ansluta till WebProxy Server
sträng
url
Egenskapen WebProxy Server AbsoluteUri som innehåller hela URI:n som lagras i URI-instansen, inklusive alla fragment och frågesträngar.
sträng (krävs)
användarnamn
Användarnamn för att ansluta till WebProxy-servern
sträng
BackendTlsEgenskaper
Name
Beskrivning
Värde
validateCertificateChain
Flagga som anger om validering av SSL-certifikatkedja ska utföras när du använder självsignerade certifikat för den här serverdelsvärden.
boolesk
validateCertificateName
Flagga som anger om validering av SSL-certifikatnamn ska göras när du använder självsignerade certifikat för den här serverdelsvärden.
boolesk
Resursdefinition för ARM-mall
Resurstypen tjänst/serverdelar kan distribueras med åtgärder som mål:
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen .
Om du vill skapa en Microsoft.ApiManagement/service/backends-resurs lägger du till följande JSON i mallen.
{
"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"
}
}
Egenskapsvärden
tjänst/serverdelar
Name
Beskrivning
Värde
typ
Resurstypen
"Microsoft.ApiManagement/service/backends"
apiVersion
Resurs-API-versionen
"2023-05-01-preview"
name
ResursnamnetJSON ARM-mallar .
sträng (krävs)
properties
Egenskaper för serverdelsentitetskontrakt.
BackendContractProperties
BackendContractProperties
Name
Beskrivning
Värde
circuitBreaker
Konfiguration av serverdelskretsbrytare
BackendCircuitBreaker
autentiseringsuppgifter
Egenskaper för kontrakt för serverdelsautentiseringsuppgifter
BackendCredentialsContract
beskrivning
Beskrivning av serverdelen.
sträng
Pool
BackendBaseParametersPool
properties
Kontrakt för serverdelsegenskaper
BackendProperties
Protokollet
Protokoll för serverdelskommunikation.
"http"
proxy
Egenskaper för serverdelsgatewaykontrakt
BackendProxyContract
resourceId
Hanterings-URI för resursen i det externa systemet. Den här URL:en kan vara armresurs-ID för Logic Apps, Function Apps eller API Apps.
sträng
title
Serverdelsrubrik.
sträng
Tls
Egenskaper för serverdels-TLS
BackendTlsEgenskaper
typ
Typ av serverdel. En serverdel kan vara antingen Enskild eller Pool.
"Pool"
url
Körnings-URL för serverdelen.
sträng (krävs)
BackendCircuitBreaker
CircuitBreakerRule
Name
Beskrivning
Värde
failureCondition
Villkoren för att snubbla kretsbrytaren.
CircuitBreakerFailureCondition
name
Regelnamnet.
sträng
tripDuration
Hur länge kretsen kommer att snubblas.
sträng
CircuitBreakerFailureCondition
Name
Beskrivning
Värde
count
Tröskelvärdet för att öppna kretsen.
int
errorReasons
De felorsaker som betraktas som fel.
string[]
interval
Det intervall under vilket felen räknas.
sträng
percentage
Tröskelvärdet för att öppna kretsen.
int
statusCodeRanges
Statuskodintervallen som betraktas som fel.
FailureStatusCodeRange []
FailureStatusCodeRange
Name
Beskrivning
Värde
max
Maximal http-statuskod.
int
min
Minsta http-statuskod.
int
BackendCredentialsContract
Name
Beskrivning
Värde
parameter
Autentiseringsparametervärde.
sträng (krävs)
System
Namn på autentiseringsschema.
sträng (krävs)
Name
Beskrivning
Värde
{anpassad egenskap}
string[]
BackendCredentialsContractQuery
Name
Beskrivning
Värde
{anpassad egenskap}
string[]
BackendBaseParametersPool
Name
Beskrivning
Värde
services
Listan över serverdelsentiteter som tillhör en pool.
BackendPoolItem []
BackendPoolItem
Name
Beskrivning
Värde
id
Det unika ARM-ID:t för serverdelsentiteten. ARM-ID:t bör referera till en redan befintlig serverdelsentitet.
sträng (krävs)
BackendProperties
BackendServiceFabricClusterProperties
Name
Beskrivning
Värde
clientCertificateId
Klientcertifikat-ID för hanteringsslutpunkten.
sträng
clientCertificatethumbprint
Tumavtrycket för klientcertifikatet för hanteringsslutpunkten. Ignoreras om certificatesIds tillhandahålls
sträng
managementEndpoints
Slutpunkten för klusterhantering.
string[] (krävs)
maxPartitionResolutionRetries
Maximalt antal återförsök vid försök att lösa partitionen.
int
serverCertificateThumbprints
Tumavtryck för certifikat som klusterhanteringstjänsten använder för TLS-kommunikation
string[]
serverX509Names
Server X509-certifikatnamnsamling
X509CertificateName []
X509CertificateName
Name
Beskrivning
Värde
issuerCertificateThumbprint
Tumavtryck för certifikatutfärdaren.
sträng
name
Eget namn på certifikatet.
sträng
BackendProxyContract
Name
Beskrivning
Värde
password
Lösenord för att ansluta till WebProxy-servern
sträng
url
Egenskapen WebProxy Server AbsoluteUri som innehåller hela URI:n som lagras i URI-instansen, inklusive alla fragment och frågesträngar.
sträng (krävs)
användarnamn
Användarnamn för att ansluta till WebProxy-servern
sträng
BackendTlsProperties
Name
Beskrivning
Värde
validateCertificateChain
Flagga som anger om SSL-certifikatkedjans validering ska utföras när du använder självsignerade certifikat för den här serverdelsvärden.
boolesk
validateCertificateName
Flagga som anger om SSL-certifikatets namnverifiering ska utföras när du använder självsignerade certifikat för den här serverdelsvärden.
boolesk
Resurstypen tjänst/serverdel kan distribueras med åtgärder som mål:
En lista över ändrade egenskaper i varje API-version finns i ändringsloggen .
Om du vill skapa en Resurs för Microsoft.ApiManagement/service/backends lägger du till följande Terraform i mallen.
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"
}
})
}
Egenskapsvärden
tjänst/serverdelar
Name
Beskrivning
Värde
typ
Resurstypen
"Microsoft.ApiManagement/service/backends@2023-05-01-preview"
name
Resursnamnet
sträng (krävs)
parent_id
ID för resursen som är överordnad för den här resursen.
ID för resurs av typen: tjänst
properties
Egenskaper för serverdelsentitetskontrakt.
BackendContractProperties
BackendContractProperties
Name
Beskrivning
Värde
circuitBreaker
Konfiguration av backend-kretsbrytare
BackendCircuitBreaker
autentiseringsuppgifter
Egenskaper för kontrakt för serverdelsautentiseringsuppgifter
BackendCredentialsContract
beskrivning
Beskrivning av serverdelen.
sträng
Pool
BackendBaseParametersPool
properties
Kontrakt för serverdelsegenskaper
BackendProperties
Protokollet
Protokoll för serverdelskommunikation.
"http"
proxy
Egenskaper för serverdelsgatewaykontrakt
BackendProxyContract
resourceId
Hanterings-URI för resursen i det externa systemet. Den här URL:en kan vara armresurs-ID för Logic Apps, Funktionsappar eller API Apps.
sträng
title
Serverdelsrubrik.
sträng
Tls
Egenskaper för serverdels-TLS
BackendTlsProperties
typ
Typ av serverdel. En serverdel kan vara antingen Enskild eller Pool.
"Pool"
url
Körnings-URL för serverdelen.
sträng (krävs)
BackendCircuitBreaker
CircuitBreakerRule
Name
Beskrivning
Värde
failureCondition
Villkoren för att snubbla strömbrytaren.
CircuitBreakerFailureCondition
name
Regelnamnet.
sträng
tripDuration
Hur länge kretsen kommer att snubblas.
sträng
CircuitBreakerFailureCondition
Name
Beskrivning
Värde
count
Tröskelvärdet för att öppna kretsen.
int
errorReasons
De felorsaker som betraktas som fel.
string[]
interval
Det intervall under vilket felen räknas.
sträng
percentage
Tröskelvärdet för att öppna kretsen.
int
statusCodeRanges
De statuskodintervall som betraktas som fel.
FailureStatusCodeRange []
FailureStatusCodeRange
Name
Beskrivning
Värde
max
Maximal http-statuskod.
int
min
Minsta http-statuskod.
int
BackendCredentialsContract
Name
Beskrivning
Värde
parameter
Autentiseringsparametervärde.
sträng (krävs)
System
Namn på autentiseringsschema.
sträng (krävs)
Name
Beskrivning
Värde
{anpassad egenskap}
string[]
BackendCredentialsContractQuery
Name
Beskrivning
Värde
{anpassad egenskap}
string[]
BackendBaseParametersPool
Name
Beskrivning
Värde
services
Listan över serverdelsentiteter som tillhör en pool.
BackendPoolItem []
BackendPoolItem
Name
Beskrivning
Värde
id
Det unika ARM-ID:t för serverdelsentiteten. ARM-ID:t bör referera till en redan befintlig serverdelsentitet.
sträng (krävs)
BackendProperties
BackendServiceFabricClusterEgenskaper
Name
Beskrivning
Värde
clientCertificateId
Klientcertifikat-ID för hanteringsslutpunkten.
sträng
clientCertificatethumbprint
Tumavtrycket för klientcertifikatet för hanteringsslutpunkten. Ignoreras om certificatesIds tillhandahålls
sträng
managementEndpoints
Slutpunkten för klusterhantering.
string[] (krävs)
maxPartitionResolutionRetries
Maximalt antal återförsök vid försök att lösa partitionen.
int
serverCertificateThumbprints
Tumavtryck för certifikat som klusterhanteringstjänsten använder för tls-kommunikation
string[]
serverX509Names
Server X509-certifikatnamnsamling
X509CertificateName []
X509CertificateName
Name
Beskrivning
Värde
issuerCertificateThumbprint
Tumavtryck för certifikatutfärdaren.
sträng
name
Eget namn på certifikatet.
sträng
BackendProxyContract
Name
Beskrivning
Värde
password
Lösenord för att ansluta till WebProxy Server
sträng
url
Egenskapen WebProxy Server AbsoluteUri som innehåller hela URI:n som lagras i URI-instansen, inklusive alla fragment och frågesträngar.
sträng (krävs)
användarnamn
Användarnamn för att ansluta till WebProxy-servern
sträng
BackendTlsEgenskaper
Name
Beskrivning
Värde
validateCertificateChain
Flagga som anger om validering av SSL-certifikatkedja ska utföras när du använder självsignerade certifikat för den här serverdelsvärden.
boolesk
validateCertificateName
Flagga som anger om validering av SSL-certifikatnamn ska göras när du använder självsignerade certifikat för den här serverdelsvärden.
boolesk