Servicio Microsoft.ApiManagement/back-end
Artículo 01/18/2024
1 colaborador
Comentarios
En este artículo
Definición de recursos de Bicep
El tipo de recurso service/backends se puede implementar con operaciones destinadas a:
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios .
Para crear un recurso Microsoft.ApiManagement/service/backends, agregue el siguiente bicep a la plantilla.
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'
}
}
Valores de propiedad
service/backends
Nombre
Descripción
Value
name
El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en Bicep .
string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico.
primario
En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario. Para más información, consulte Recurso secundario fuera del recurso primario .
Nombre simbólico del recurso de tipo: servicio
properties
Propiedades del contrato de entidad de back-end.
BackendContractProperties
BackendContractProperties
Nombre
Descripción
Valor
Disyuntor
Configuración del disyuntor de back-end
BackendCircuitBreaker
credentials
Propiedades del contrato de credenciales de back-end
BackendCredentialsContract
description
Descripción del back-end.
string
pool
BackendBaseParametersPool
properties
Contrato de propiedades de back-end
BackendProperties
protocol
Protocolo de comunicación back-end.
'http' 'soap' (obligatorio)
proxy
Propiedades del contrato de puerta de enlace de back-end
BackendProxyContract
resourceId
Uri de administración del recurso en sistema externo. Esta dirección URL puede ser el identificador de recurso de Arm de Logic Apps, Function Apps o API Apps.
string
title
Título del back-end.
string
Tls
Propiedades de TLS de back-end
BackendTlsProperties
tipo
Tipo del back-end. Un back-end puede ser Single o Pool.
'Pool' 'Single'
url
Dirección URL del entorno de ejecución del back-end.
string (obligatorio)
BackendCircuitBreaker
Nombre
Descripción
Valor
reglas
Reglas para el recorrido del back-end.
CircuitBreakerRule []
CircuitBreakerRule
Nombre
Descripción
Valor
failureCondition
Condiciones para viajar por el disyuntor.
CircuitBreakerFailureCondition
name
Nombre de la regla.
string
tripDuration
Duración del recorrido del circuito.
string
CircuitBreakerFailureCondition
Nombre
Descripción
Value
count
Umbral para abrir el circuito.
int
errorReasons
Los motivos de error que se consideran erróneos.
string[]
interval
Intervalo durante el que se cuentan los errores.
string
percentage
Umbral para abrir el circuito.
int
statusCodeRanges
Intervalos de código de estado que se consideran erróneos.
FailureStatusCodeRange []
FailureStatusCodeRange
Nombre
Descripción
Valor
max
El código de estado HTTP máximo.
int
min.
El código de estado HTTP mínimo.
int
BackendCredentialsContract
Nombre
Descripción
Valor
parámetro
Valor del parámetro de autenticación.
string (obligatorio)
scheme
Nombre del esquema de autenticación.
string (obligatorio)
Nombre
Descripción
Valor
{propiedad personalizada}
string[]
BackendCredentialsContractQuery
Nombre
Descripción
Valor
{propiedad personalizada}
string[]
BackendBaseParametersPool
Nombre
Descripción
Valor
services
Lista de entidades de back-end que pertenecen a un grupo.
BackendPoolItem []
BackendPoolItem
Nombre
Descripción
Value
id
Identificador único de ARM de la entidad de back-end. El identificador de ARM debe hacer referencia a una entidad de back-end ya existente.
string (obligatorio)
BackendProperties
BackendServiceFabricClusterProperties
Nombre
Descripción
Valor
clientCertificateId
Identificador de certificado de cliente para el punto de conexión de administración.
string
clientCertificatethumbprint
Huella digital del certificado de cliente para el punto de conexión de administración. Se omitirá si se proporcionan certificatesIds.
string
managementEndpoints
Punto de conexión de administración de clústeres.
string[] (obligatorio)
maxPartitionResolutionRetries
Número máximo de reintentos al intentar resolver la partición.
int
serverCertificateThumbprints
Huellas digitales del servicio de administración de clústeres de certificados usa para la comunicación tls
string[]
serverX509Names
Colección de nombres de certificado X509 de servidor
X509CertificateName []
X509CertificateName
Nombre
Descripción
Valor
issuerCertificateThumbprint
Huella digital del emisor del certificado.
string
name
Nombre común del certificado.
string
BackendProxyContract
Nombre
Descripción
Valor
password
Contraseña para conectarse al servidor WebProxy
string
url
Propiedad AbsoluteUri del servidor WebProxy que incluye todo el URI almacenado en la instancia de Uri, incluidos todos los fragmentos y cadenas de consulta.
string (obligatorio)
username
Nombre de usuario para conectarse al servidor WebProxy
string
BackendTlsProperties
Nombre
Descripción
Valor
validateCertificateChain
Marca que indica si se debe realizar la validación de la cadena de certificados SSL al usar certificados autofirmados para este host de back-end.
bool
validateCertificateName
Marca que indica si se debe realizar la validación del nombre del certificado SSL al usar certificados autofirmados para este host de back-end.
bool
Definición de recursos de plantilla de ARM
El tipo de recurso service/backends se puede implementar con operaciones destinadas a:
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios .
Para crear un recurso Microsoft.ApiManagement/service/backends, agregue el siguiente JSON a la plantilla.
{
"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"
}
}
Valores de propiedad
service/backends
Nombre
Descripción
Value
type
Tipo de recurso
"Microsoft.ApiManagement/service/backends"
apiVersion
La versión de la API de recursos
"2023-05-01-preview"
name
El nombre del recurso Vea cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM JSON .
string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico.
properties
Propiedades del contrato de entidad de back-end.
BackendContractProperties
BackendContractProperties
Nombre
Descripción
Valor
Disyuntor
Configuración del disyuntor de back-end
BackendCircuitBreaker
credentials
Propiedades del contrato de credenciales de back-end
BackendCredentialsContract
description
Descripción del back-end.
string
pool
BackendBaseParametersPool
properties
Contrato de propiedades de back-end
BackendProperties
protocol
Protocolo de comunicación back-end.
'http' 'soap' (obligatorio)
proxy
Propiedades del contrato de puerta de enlace de back-end
BackendProxyContract
resourceId
Uri de administración del recurso en sistema externo. Esta dirección URL puede ser el identificador de recurso de Arm de Logic Apps, Function Apps o API Apps.
string
title
Título del back-end.
string
Tls
Propiedades de TLS de back-end
BackendTlsProperties
tipo
Tipo del back-end. Un back-end puede ser Single o Pool.
'Pool' 'Single'
url
Dirección URL del entorno de ejecución del back-end.
string (obligatorio)
BackendCircuitBreaker
Nombre
Descripción
Valor
reglas
Reglas para el recorrido del back-end.
CircuitBreakerRule []
CircuitBreakerRule
Nombre
Descripción
Valor
failureCondition
Condiciones para viajar por el disyuntor.
CircuitBreakerFailureCondition
name
Nombre de la regla.
string
tripDuration
Duración durante la cual se realizará el recorrido del circuito.
string
CircuitBreakerFailureCondition
Nombre
Descripción
Value
count
Umbral para abrir el circuito.
int
errorReasons
Los motivos de error que se consideran erróneos.
string[]
interval
Intervalo durante el que se cuentan los errores.
string
percentage
Umbral para abrir el circuito.
int
statusCodeRanges
Intervalos de código de estado que se consideran errores.
FailureStatusCodeRange []
FailureStatusCodeRange
Nombre
Descripción
Valor
max
El código de estado HTTP máximo.
int
min.
El código de estado http mínimo.
int
BackendCredentialsContract
Nombre
Descripción
Valor
parámetro
Valor del parámetro de autenticación.
string (obligatorio)
scheme
Nombre del esquema de autenticación.
string (obligatorio)
Nombre
Descripción
Valor
{propiedad personalizada}
string[]
BackendCredentialsContractQuery
Nombre
Descripción
Valor
{propiedad personalizada}
string[]
BackendBaseParametersPool
Nombre
Descripción
Valor
services
Lista de entidades de back-end que pertenecen a un grupo.
BackendPoolItem []
BackendPoolItem
Nombre
Descripción
Value
id
Identificador único de ARM de la entidad de back-end. El identificador de ARM debe hacer referencia a una entidad de back-end ya existente.
string (obligatorio)
BackendProperties
BackendServiceFabricClusterProperties
Nombre
Descripción
Valor
clientCertificateId
Identificador de certificado de cliente para el punto de conexión de administración.
string
clientCertificatethumbprint
Huella digital del certificado de cliente para el punto de conexión de administración. Se omitirá si se proporcionan certificatesIds.
string
managementEndpoints
Punto de conexión de administración de clústeres.
string[] (obligatorio)
maxPartitionResolutionRetries
Número máximo de reintentos al intentar resolver la partición.
int
serverCertificateThumbprints
Huellas digitales del servicio de administración de clústeres de certificados usa para la comunicación tls
string[]
serverX509Names
Colección de nombres de certificado X509 de servidor
X509CertificateName []
X509CertificateName
Nombre
Descripción
Valor
issuerCertificateThumbprint
Huella digital del emisor del certificado.
string
name
Nombre común del certificado.
string
BackendProxyContract
Nombre
Descripción
Valor
password
Contraseña para conectarse al servidor WebProxy
string
url
Propiedad AbsoluteUri del servidor WebProxy que incluye todo el URI almacenado en la instancia de Uri, incluidos todos los fragmentos y cadenas de consulta.
string (obligatorio)
username
Nombre de usuario para conectarse al servidor WebProxy
string
BackendTlsProperties
Nombre
Descripción
Valor
validateCertificateChain
Marca que indica si se debe realizar la validación de la cadena de certificados SSL al usar certificados autofirmados para este host de back-end.
bool
validateCertificateName
Marca que indica si se debe realizar la validación del nombre del certificado SSL al usar certificados autofirmados para este host de back-end.
bool
El tipo de recurso service/backends se puede implementar con operaciones destinadas a:
Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios .
Para crear un recurso Microsoft.ApiManagement/service/backends, agregue el siguiente terraform a la plantilla.
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"
}
})
}
Valores de propiedad
service/backends
Nombre
Descripción
Value
type
Tipo de recurso
"Microsoft.ApiManagement/service/backends@2023-05-01-preview"
name
El nombre del recurso
string (obligatorio) Límite de caracteres: 1-80 Caracteres válidos: Caracteres alfanuméricos y guiones. Comience con una letra y termine con un carácter alfanumérico.
parent_id
Identificador del recurso que es el elemento primario de este recurso.
Identificador del recurso de tipo: servicio
properties
Propiedades del contrato de entidad de back-end.
BackendContractProperties
BackendContractProperties
Nombre
Descripción
Valor
Disyuntor
Configuración del disyuntor de back-end
BackendCircuitBreaker
credentials
Propiedades del contrato de credenciales de back-end
BackendCredentialsContract
description
Descripción del back-end.
string
pool
BackendBaseParametersPool
properties
Contrato de propiedades de back-end
BackendProperties
protocol
Protocolo de comunicación back-end.
"http" "soap" (obligatorio)
proxy
Propiedades del contrato de puerta de enlace de back-end
BackendProxyContract
resourceId
Uri de administración del recurso en sistema externo. Esta dirección URL puede ser el identificador de recurso de Arm de Logic Apps, Function Apps o API Apps.
string
title
Título del back-end.
string
Tls
Propiedades de TLS de back-end
BackendTlsProperties
tipo
Tipo del back-end. Un back-end puede ser Single o Pool.
"Grupo" "Single"
url
Dirección URL del entorno de ejecución del back-end.
string (obligatorio)
BackendCircuitBreaker
Nombre
Descripción
Valor
reglas
Reglas para el recorrido del back-end.
CircuitBreakerRule []
CircuitBreakerRule
Nombre
Descripción
Valor
failureCondition
Condiciones para viajar por el disyuntor.
CircuitBreakerFailureCondition
name
Nombre de la regla.
string
tripDuration
Duración durante la cual se realizará el recorrido del circuito.
string
CircuitBreakerFailureCondition
Nombre
Descripción
Value
count
Umbral para abrir el circuito.
int
errorReasons
Los motivos de error que se consideran erróneos.
string[]
interval
Intervalo durante el que se cuentan los errores.
string
percentage
Umbral para abrir el circuito.
int
statusCodeRanges
Intervalos de código de estado que se consideran errores.
FailureStatusCodeRange []
FailureStatusCodeRange
Nombre
Descripción
Valor
max
El código de estado HTTP máximo.
int
min.
El código de estado http mínimo.
int
BackendCredentialsContract
Nombre
Descripción
Valor
parámetro
Valor del parámetro de autenticación.
string (obligatorio)
scheme
Nombre del esquema de autenticación.
string (obligatorio)
Nombre
Descripción
Valor
{propiedad personalizada}
string[]
BackendCredentialsContractQuery
Nombre
Descripción
Valor
{propiedad personalizada}
string[]
BackendBaseParametersPool
Nombre
Descripción
Valor
services
Lista de entidades de back-end que pertenecen a un grupo.
BackendPoolItem []
BackendPoolItem
Nombre
Descripción
Value
id
Identificador único de ARM de la entidad de back-end. El identificador de ARM debe hacer referencia a una entidad de back-end ya existente.
string (obligatorio)
BackendProperties
BackendServiceFabricClusterProperties
Nombre
Descripción
Valor
clientCertificateId
Identificador de certificado de cliente para el punto de conexión de administración.
string
clientCertificatethumbprint
Huella digital del certificado de cliente para el punto de conexión de administración. Se omitirá si se proporcionan certificatesIds.
string
managementEndpoints
Punto de conexión de administración de clústeres.
string[] (obligatorio)
maxPartitionResolutionRetries
Número máximo de reintentos al intentar resolver la partición.
int
serverCertificateThumbprints
Huellas digitales del servicio de administración de clústeres de certificados usa para la comunicación tls
string[]
serverX509Names
Colección de nombres de certificado X509 de servidor
X509CertificateName []
X509CertificateName
Nombre
Descripción
Valor
issuerCertificateThumbprint
Huella digital del emisor del certificado.
string
name
Nombre común del certificado.
string
BackendProxyContract
Nombre
Descripción
Valor
password
Contraseña para conectarse al servidor WebProxy
string
url
Propiedad AbsoluteUri del servidor WebProxy que incluye todo el URI almacenado en la instancia de Uri, incluidos todos los fragmentos y cadenas de consulta.
string (obligatorio)
username
Nombre de usuario para conectarse al servidor WebProxy
string
BackendTlsProperties
Nombre
Descripción
Valor
validateCertificateChain
Marca que indica si se debe realizar la validación de la cadena de certificados SSL al usar certificados autofirmados para este host de back-end.
bool
validateCertificateName
Marca que indica si se debe realizar la validación del nombre del certificado SSL al usar certificados autofirmados para este host de back-end.
bool