Service/back-ends Microsoft.ApiManagement
Article
01/18/2024
1 contributeur
Commentaires
Dans cet article
Définition de ressource Bicep
Le type de ressource service/back-end peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications .
Pour créer une ressource Microsoft.ApiManagement/service/backends, ajoutez le Bicep suivant à votre modèle.
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'
}
}
Valeurs de propriétés
service/backends
Nom
Description
Valeur
name
Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans Bicep .
string (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique.
parent
Dans Bicep, vous pouvez spécifier la ressource parente pour une ressource enfant. Vous devez uniquement ajouter cette propriété lorsque la ressource enfant est déclarée en dehors de la ressource parente. Pour plus d’informations, consultez Ressource enfant en dehors de la ressource parente .
Nom symbolique de la ressource de type : service
properties
Propriétés du contrat d’entité back-end.
BackendContractProperties
BackendContractProperties
Nom
Description
Valeur
Disjoncteur
Configuration du disjoncteur principal
BackendCircuitBreaker
credentials
Propriétés du contrat d’informations d’identification du serveur principal
BackendCredentialsContract
description
Description du back-end.
string
pool
BackendBaseParametersPool
properties
Contrat de propriétés du back-end
BackendProperties
protocol
Protocole de communication back-end.
'http' 'soap' (obligatoire)
proxy
Propriétés du contrat de passerelle back-end
BackendProxyContract
resourceId
URI de gestion de la ressource dans le système externe. Cette URL peut être l’ID de ressource Arm de Logic Apps, Function Apps ou API Apps.
string
title
Titre du back-end.
string
Tls
Propriétés TLS du serveur principal
BackendTlsProperties
type
Type du serveur principal. Un serveur principal peut être un seul ou un pool.
'Pool' 'Single'
url
URL d’exécution du serveur principal.
string (obligatoire)
BackendCircuitBreaker
Nom
Description
Valeur
rules
Règles permettant de trébucher le back-end.
CircuitBreakerRule []
CircuitBreakerRule
Nom
Description
Valeur
failureCondition
Conditions de déclenchement du disjoncteur.
CircuitBreakerFailureCondition
name
Nom de la règle.
string
tripDuration
Durée pendant laquelle le circuit sera trébuché.
string
CircuitBreakerFailureCondition
Nom
Description
Valeur
count
Seuil d’ouverture du circuit.
int
errorReasons
Raisons d’erreur qui sont considérées comme des échecs.
string[]
interval
Intervalle pendant lequel les échecs sont comptés.
string
percentage
Seuil d’ouverture du circuit.
int
statusCodeRanges
Le status des plages de code qui sont considérées comme des échecs.
FailureStatusCodeRange []
FailureStatusCodeRange
Nom
Description
Valeur
max
Code http status maximal.
int
minute(s)
Code http status minimal.
int
BackendCredentialsContract
Nom
Description
Valeur
paramètre
Valeur du paramètre d’authentification.
string (obligatoire)
scheme
Nom du schéma d’authentification.
string (obligatoire)
Nom
Description
Valeur
{propriété personnalisée}
string[]
BackendCredentialsContractQuery
Nom
Description
Valeur
{propriété personnalisée}
string[]
BackendBaseParametersPool
Nom
Description
Valeur
services
Liste des entités back-end appartenant à un pool.
BackendPoolItem []
BackendPoolItem
Nom
Description
Valeur
id
ID ARM unique de l’entité back-end. L’ID ARM doit faire référence à une entité back-end déjà existante.
string (obligatoire)
BackendProperties
BackendServiceFabricClusterProperties
Nom
Description
Valeur
clientCertificateId
ID de certificat client pour le point de terminaison de gestion.
string
clientCertificatethumbprint
Empreinte du certificat client pour le point de terminaison de gestion. Sera ignoré si des id de certificats sont fournis
string
managementEndpoints
Point de terminaison de gestion du cluster.
string[] (obligatoire)
maxPartitionResolutionRetries
Nombre maximal de nouvelles tentatives lors de la tentative de résolution de la partition.
int
serverCertificateThumbprints
Utilisations des empreintes numériques du service de gestion de cluster de certificats pour la communication TLS
string[]
serverX509Names
Collection de noms de certificats Server X509
X509CertificateName []
X509CertificateName
Nom
Description
Valeur
issuerCertificateThumbprint
Empreinte numérique de l’émetteur du certificat.
string
name
Nom commun du certificat.
string
BackendProxyContract
Nom
Description
Valeur
mot de passe
Mot de passe pour se connecter au serveur WebProxy
string
url
Propriété AbsoluteUri du serveur WebProxy qui inclut l’URI entier stocké dans le instance URI, y compris tous les fragments et chaînes de requête.
chaîne (obligatoire)
username
Nom d’utilisateur pour se connecter au serveur WebProxy
string
BackendTlsProperties
Nom
Description
Valeur
validateCertificateChain
Indicateur indiquant si la validation de la chaîne de certificats SSL doit être effectuée lors de l’utilisation de certificats auto-signés pour cet hôte principal.
bool
validateCertificateName
Indicateur indiquant si la validation du nom de certificat SSL doit être effectuée lors de l’utilisation de certificats auto-signés pour cet hôte principal.
bool
Définition de ressources de modèle ARM
Le type de ressource service/back-end peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version de l’API, consultez journal des modifications .
Pour créer une ressource Microsoft.ApiManagement/service/backends, ajoutez le JSON suivant à votre modèle.
{
"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"
}
}
Valeurs de propriétés
service/backends
Nom
Description
Valeur
type
Type de ressource
« Microsoft.ApiManagement/service/backends »
apiVersion
Version de l’API de ressource
« 2023-05-01-preview »
name
Nom de la ressource Découvrez comment définir des noms et des types pour des ressources enfants dans des modèles ARM JSON .
chaîne (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique.
properties
Propriétés du contrat d’entité back-end.
BackendContractProperties
BackendContractProperties
Nom
Description
Valeur
Disjoncteur
Configuration du disjoncteur principal
BackendCircuitBreaker
credentials
Propriétés du contrat d’informations d’identification back-end
BackendCredentialsContract
description
Description du back-end.
string
pool
BackendBaseParametersPool
properties
Contrat de propriétés du back-end
BackendProperties
protocol
Protocole de communication back-end.
'http' 'soap' (obligatoire)
proxy
Propriétés du contrat de passerelle back-end
BackendProxyContract
resourceId
URI de gestion de la ressource dans le système externe. Cette URL peut être l’ID de ressource Arm de Logic Apps, Function Apps ou API Apps.
string
title
Titre du back-end.
string
Tls
Propriétés TLS du serveur principal
BackendTlsProperties
type
Type du serveur principal. Un serveur principal peut être un seul ou un pool.
'Pool' 'Single'
url
URL d’exécution du serveur principal.
string (obligatoire)
BackendCircuitBreaker
Nom
Description
Valeur
rules
Règles permettant de trébucher le back-end.
CircuitBreakerRule []
CircuitBreakerRule
Nom
Description
Valeur
failureCondition
Conditions de déclenchement du disjoncteur.
CircuitBreakerFailureCondition
name
Nom de la règle.
string
tripDuration
Durée pendant laquelle le circuit sera trébuché.
string
CircuitBreakerFailureCondition
Nom
Description
Valeur
count
Seuil d’ouverture du circuit.
int
errorReasons
Raisons d’erreur qui sont considérées comme des échecs.
string[]
interval
Intervalle pendant lequel les échecs sont comptés.
string
percentage
Seuil d’ouverture du circuit.
int
statusCodeRanges
Le status des plages de code qui sont considérées comme des échecs.
FailureStatusCodeRange []
FailureStatusCodeRange
Nom
Description
Valeur
max
Code http status maximal.
int
minute(s)
Code http status minimal.
int
BackendCredentialsContract
Nom
Description
Valeur
paramètre
Valeur du paramètre d’authentification.
string (obligatoire)
scheme
Nom du schéma d’authentification.
string (obligatoire)
Nom
Description
Valeur
{propriété personnalisée}
string[]
BackendCredentialsContractQuery
Nom
Description
Valeur
{propriété personnalisée}
string[]
BackendBaseParametersPool
Nom
Description
Valeur
services
Liste des entités back-end appartenant à un pool.
BackendPoolItem []
BackendPoolItem
Nom
Description
Valeur
id
ID ARM unique de l’entité back-end. L’ID ARM doit faire référence à une entité back-end déjà existante.
string (obligatoire)
BackendProperties
BackendServiceFabricClusterProperties
Nom
Description
Valeur
clientCertificateId
ID de certificat client pour le point de terminaison de gestion.
string
clientCertificatethumbprint
Empreinte numérique du certificat client pour le point de terminaison de gestion. Sera ignoré si des id de certificats sont fournis
string
managementEndpoints
Point de terminaison de gestion du cluster.
string[] (obligatoire)
maxPartitionResolutionRetries
Nombre maximal de nouvelles tentatives lors de la tentative de résolution de la partition.
int
serverCertificateThumbprints
Empreintes numériques des certificats que le service de gestion de cluster utilise pour la communication tls
string[]
serverX509Names
Collection de noms de certificats Server X509
X509CertificateName []
X509CertificateName
Nom
Description
Valeur
issuerCertificateThumbprint
Empreinte numérique de l’émetteur du certificat.
string
name
Nom commun du certificat.
string
BackendProxyContract
Nom
Description
Valeur
mot de passe
Mot de passe pour se connecter au serveur WebProxy
string
url
Propriété AbsoluteUri du serveur WebProxy qui inclut l’URI entier stocké dans le instance URI, y compris tous les fragments et chaînes de requête.
string (obligatoire)
username
Nom d’utilisateur pour se connecter au serveur WebProxy
string
BackendTlsProperties
Nom
Description
Valeur
validateCertificateChain
Indicateur indiquant si la validation de la chaîne de certificats SSL doit être effectuée lors de l’utilisation de certificats auto-signés pour cet hôte principal.
bool
validateCertificateName
Indicateur indiquant si la validation du nom de certificat SSL doit être effectuée lors de l’utilisation de certificats auto-signés pour cet hôte principal.
bool
Le type de ressource service/back-end peut être déployé avec des opérations qui ciblent :
Pour obtenir la liste des propriétés modifiées dans chaque version d’API, consultez journal des modifications .
Pour créer une ressource Microsoft.ApiManagement/service/backends, ajoutez le Terraform suivant à votre modèle.
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"
}
})
}
Valeurs de propriétés
service/backends
Nom
Description
Valeur
type
Type de ressource
« Microsoft.ApiManagement/service/backends@2023-05-01-preview »
name
Nom de la ressource
string (obligatoire) Limite de caractères : 1-80 Caractères valides : Caractères alphanumériques et traits d’union. Doit commencer par une lettre et se terminer par un caractère alphanumérique.
parent_id
ID de la ressource qui est le parent de cette ressource.
ID de ressource de type : service
properties
Propriétés du contrat d’entité back-end.
BackendContractProperties
BackendContractProperties
Nom
Description
Valeur
Disjoncteur
Configuration du disjoncteur principal
BackendCircuitBreaker
credentials
Propriétés du contrat d’informations d’identification du serveur principal
BackendCredentialsContract
description
Description du back-end.
string
pool
BackendBaseParametersPool
properties
Contrat de propriétés du back-end
BackendProperties
protocol
Protocole de communication back-end.
« http » « soap » (obligatoire)
proxy
Propriétés du contrat de passerelle back-end
BackendProxyContract
resourceId
URI de gestion de la ressource dans le système externe. Cette URL peut être l’ID de ressource Arm de Logic Apps, Function Apps ou API Apps.
string
title
Titre du back-end.
string
Tls
Propriétés TLS du serveur principal
BackendTlsProperties
type
Type du serveur principal. Un serveur principal peut être un seul ou un pool.
« Pool » « Single »
url
URL d’exécution du serveur principal.
string (obligatoire)
BackendCircuitBreaker
Nom
Description
Valeur
rules
Règles permettant de trébucher le back-end.
CircuitBreakerRule []
CircuitBreakerRule
Nom
Description
Valeur
failureCondition
Conditions de déclenchement du disjoncteur.
CircuitBreakerFailureCondition
name
Nom de la règle.
string
tripDuration
Durée pendant laquelle le circuit sera trébuché.
string
CircuitBreakerFailureCondition
Nom
Description
Valeur
count
Seuil d’ouverture du circuit.
int
errorReasons
Raisons d’erreur qui sont considérées comme des échecs.
string[]
interval
Intervalle pendant lequel les échecs sont comptés.
string
percentage
Seuil d’ouverture du circuit.
int
statusCodeRanges
Le status des plages de code qui sont considérées comme des échecs.
FailureStatusCodeRange []
FailureStatusCodeRange
Nom
Description
Valeur
max
Code http status maximal.
int
minute(s)
Code http status minimal.
int
BackendCredentialsContract
Nom
Description
Valeur
paramètre
Valeur du paramètre d’authentification.
chaîne (obligatoire)
scheme
Nom du schéma d’authentification.
chaîne (obligatoire)
Nom
Description
Valeur
{propriété personnalisée}
string[]
BackendCredentialsContractQuery
Nom
Description
Valeur
{propriété personnalisée}
string[]
BackendBaseParametersPool
Nom
Description
Valeur
services
Liste des entités back-end appartenant à un pool.
BackendPoolItem []
BackendPoolItem
Nom
Description
Valeur
id
ID ARM unique de l’entité back-end. L’ID ARM doit faire référence à une entité back-end déjà existante.
chaîne (obligatoire)
BackendProperties
BackendServiceFabricClusterProperties
Nom
Description
Valeur
clientCertificateId
ID de certificat client pour le point de terminaison de gestion.
string
clientCertificatethumbprint
Empreinte du certificat client pour le point de terminaison de gestion. Sera ignoré si des id de certificats sont fournis
string
managementEndpoints
Point de terminaison de gestion du cluster.
string[] (obligatoire)
maxPartitionResolutionRetries
Nombre maximal de nouvelles tentatives lors de la tentative de résolution de la partition.
int
serverCertificateThumbprints
Utilisations des empreintes numériques du service de gestion de cluster de certificats pour la communication TLS
string[]
serverX509Names
Collection de noms de certificats Server X509
X509CertificateName []
X509CertificateName
Nom
Description
Valeur
issuerCertificateThumbprint
Empreinte numérique de l’émetteur du certificat.
string
name
Nom commun du certificat.
string
BackendProxyContract
Nom
Description
Valeur
mot de passe
Mot de passe pour se connecter au serveur WebProxy
string
url
Propriété AbsoluteUri du serveur WebProxy qui inclut l’URI entier stocké dans le instance URI, y compris tous les fragments et chaînes de requête.
chaîne (obligatoire)
username
Nom d’utilisateur pour se connecter au serveur WebProxy
string
BackendTlsProperties
Nom
Description
Valeur
validateCertificateChain
Indicateur indiquant si la validation de la chaîne de certificats SSL doit être effectuée lors de l’utilisation de certificats auto-signés pour cet hôte principal.
bool
validateCertificateName
Indicateur indiquant si la validation du nom de certificat SSL doit être effectuée lors de l’utilisation de certificats auto-signés pour cet hôte principal.
bool