Servicio Microsoft.ApiManagement/workspaces/backends 2024-05-01
El tipo de recurso service/workspaces/backends se puede implementar con operaciones que tienen como destino:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
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/workspaces/backends, agregue el siguiente bicep a la plantilla.
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/backends@2024-05-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
circuitBreaker: {
rules: [
{
acceptRetryAfter: bool
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'
priority: int
weight: int
}
]
}
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'
}
}
Nombre | Descripción | Valor |
---|---|---|
parámetro | Valor del parámetro de autenticación. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 300 (obligatorio) |
esquema | Nombre del esquema de autenticación. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 100 (obligatorio) |
Nombre | Descripción | Valor |
---|---|---|
servicios | Lista de entidades de back-end que pertenecen a un grupo. | backendPoolItem[] |
Nombre | Descripción | Valor |
---|---|---|
reglas | Reglas para realizar el recorrido del back-end. | circuitBreakerRule[] |
Nombre | Descripción | Valor |
---|---|---|
circuitBreaker | Configuración del disyuntor de back-end | backendCircuitBreaker de |
credenciales | Propiedades del contrato de credenciales de back-end | backendCredentialsContract |
descripción | Descripción del back-end. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000 |
piscina | backendBaseParametersPool | |
Propiedades | Contrato de propiedades de back-end | backendProperties de |
protocolo | 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. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000 |
título | Título de back-end. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 300 |
tls | Propiedades tls de back-end | backendTlsProperties |
tipo | Tipo del back-end. Un back-end puede ser Single o Pool. | 'Pool' 'Single' |
URL | Dirección URL en tiempo de ejecución del back-end. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000 (obligatorio) |
Nombre | Descripción | Valor |
---|---|---|
autorización | Autenticación de encabezado de autorización | BackendAuthorizationHeaderCredentials |
certificado | Lista de huellas digitales de certificado de cliente. Se omitirá si se proporcionan certificatesIds. | string[] |
certificateIds | Lista de identificadores de certificado de cliente. | string[] |
encabezado | Descripción del parámetro de encabezado. | backendCredentialsContractHeader |
consulta | Descripción del parámetro de consulta. | backendCredentialsContractQuery |
Nombre | Descripción | Valor |
---|
Nombre | Descripción | Valor |
---|
Nombre | Descripción | Valor |
---|---|---|
identificación | Identificador único de ARM de la entidad back-end. El identificador de ARM debe hacer referencia a una entidad de back-end ya existente. | string (obligatorio) |
prioridad | Prioridad de la entidad de back-end en el grupo de back-end. Debe estar comprendido entre 0 y 100. También puede ser NULL si no se especifica el valor. | Int Restricciones: Valor mínimo = 0 Valor máximo = 100 |
peso | Peso de la entidad de back-end en el grupo de back-end. Debe estar comprendido entre 0 y 100. También puede ser NULL si no se especifica el valor. | Int Restricciones: Valor mínimo = 0 Valor máximo = 100 |
Nombre | Descripción | Valor |
---|---|---|
serviceFabricCluster | Propiedades del clúster de Service Fabric de back-end | BackendServiceFabricClusterProperties |
Nombre | Descripción | Valor |
---|---|---|
contraseña | Contraseña para conectarse al servidor WebProxy | cuerda |
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. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000 (obligatorio) |
nombre de usuario | Nombre de usuario para conectarse al servidor WebProxy | cuerda |
Nombre | Descripción | Valor |
---|---|---|
clientCertificateId | Identificador de certificado de cliente para el punto de conexión de administración. | cuerda |
clientCertificatethumbprint | Huella digital del certificado de cliente para el punto de conexión de administración. Se omitirá si se proporcionan certificatesIds. | cuerda |
managementEndpoints | Punto de conexión de administración del clúster. | 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 Server X509 Certificate Names | X509CertificateName[] |
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 |
Nombre | Descripción | Valor |
---|---|---|
contar | Umbral para abrir el circuito. | Int |
errorReasons | Los motivos de error que se consideran erróneos. | cuerda Restricciones: Longitud máxima = 200[] |
intervalo | Intervalo durante el que se cuentan los errores. | cuerda |
porcentaje | Umbral para abrir el circuito. | Int |
statusCodeRanges | Intervalos de código de estado que se consideran erróneos. | failureStatusCodeRange[] |
Nombre | Descripción | Valor |
---|---|---|
máximo | Código de estado HTTP máximo. | Int Restricciones: Valor mínimo = 200 Valor máximo = 599 |
min | Código de estado http mínimo. | Int Restricciones: Valor mínimo = 200 Valor máximo = 599 |
Nombre | Descripción | Valor |
---|---|---|
nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 80 (obligatorio) |
padre | 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 obtener más información, consulte recurso secundario fuera del recurso primario. |
Nombre simbólico del recurso de tipo: servicio o áreas de trabajo |
Propiedades | Propiedades del contrato de entidad de back-end. | BackendContractProperties |
Nombre | Descripción | Valor |
---|---|---|
issuerCertificateThumbprint | Huella digital del emisor del certificado. | cuerda |
nombre | Nombre común del certificado. | cuerda |
El tipo de recurso service/workspaces/backends se puede implementar con operaciones que tienen como destino:
- grupos de recursos: consulte comandos de implementación de grupos de recursos
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/workspaces/backends, agregue el siguiente JSON a la plantilla.
{
"type": "Microsoft.ApiManagement/service/workspaces/backends",
"apiVersion": "2024-05-01",
"name": "string",
"properties": {
"circuitBreaker": {
"rules": [
{
"acceptRetryAfter": "bool",
"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",
"priority": "int",
"weight": "int"
}
]
},
"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"
}
}
Nombre | Descripción | Valor |
---|---|---|
parámetro | Valor del parámetro de autenticación. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 300 (obligatorio) |
esquema | Nombre del esquema de autenticación. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 100 (obligatorio) |
Nombre | Descripción | Valor |
---|---|---|
servicios | Lista de entidades de back-end que pertenecen a un grupo. | backendPoolItem[] |
Nombre | Descripción | Valor |
---|---|---|
reglas | Reglas para realizar el recorrido del back-end. | circuitBreakerRule[] |
Nombre | Descripción | Valor |
---|---|---|
circuitBreaker | Configuración del disyuntor de back-end | backendCircuitBreaker de |
credenciales | Propiedades del contrato de credenciales de back-end | backendCredentialsContract |
descripción | Descripción del back-end. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000 |
piscina | backendBaseParametersPool | |
Propiedades | Contrato de propiedades de back-end | backendProperties de |
protocolo | 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. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000 |
título | Título de back-end. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 300 |
tls | Propiedades tls de back-end | backendTlsProperties |
tipo | Tipo del back-end. Un back-end puede ser Single o Pool. | 'Pool' 'Single' |
URL | Dirección URL en tiempo de ejecución del back-end. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000 (obligatorio) |
Nombre | Descripción | Valor |
---|---|---|
autorización | Autenticación de encabezado de autorización | BackendAuthorizationHeaderCredentials |
certificado | Lista de huellas digitales de certificado de cliente. Se omitirá si se proporcionan certificatesIds. | string[] |
certificateIds | Lista de identificadores de certificado de cliente. | string[] |
encabezado | Descripción del parámetro de encabezado. | backendCredentialsContractHeader |
consulta | Descripción del parámetro de consulta. | backendCredentialsContractQuery |
Nombre | Descripción | Valor |
---|
Nombre | Descripción | Valor |
---|
Nombre | Descripción | Valor |
---|---|---|
identificación | Identificador único de ARM de la entidad back-end. El identificador de ARM debe hacer referencia a una entidad de back-end ya existente. | string (obligatorio) |
prioridad | Prioridad de la entidad de back-end en el grupo de back-end. Debe estar comprendido entre 0 y 100. También puede ser NULL si no se especifica el valor. | Int Restricciones: Valor mínimo = 0 Valor máximo = 100 |
peso | Peso de la entidad de back-end en el grupo de back-end. Debe estar comprendido entre 0 y 100. También puede ser NULL si no se especifica el valor. | Int Restricciones: Valor mínimo = 0 Valor máximo = 100 |
Nombre | Descripción | Valor |
---|---|---|
serviceFabricCluster | Propiedades del clúster de Service Fabric de back-end | BackendServiceFabricClusterProperties |
Nombre | Descripción | Valor |
---|---|---|
contraseña | Contraseña para conectarse al servidor WebProxy | cuerda |
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. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000 (obligatorio) |
nombre de usuario | Nombre de usuario para conectarse al servidor WebProxy | cuerda |
Nombre | Descripción | Valor |
---|---|---|
clientCertificateId | Identificador de certificado de cliente para el punto de conexión de administración. | cuerda |
clientCertificatethumbprint | Huella digital del certificado de cliente para el punto de conexión de administración. Se omitirá si se proporcionan certificatesIds. | cuerda |
managementEndpoints | Punto de conexión de administración del clúster. | 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 Server X509 Certificate Names | X509CertificateName[] |
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 |
Nombre | Descripción | Valor |
---|---|---|
contar | Umbral para abrir el circuito. | Int |
errorReasons | Los motivos de error que se consideran erróneos. | cuerda Restricciones: Longitud máxima = 200[] |
intervalo | Intervalo durante el que se cuentan los errores. | cuerda |
porcentaje | Umbral para abrir el circuito. | Int |
statusCodeRanges | Intervalos de código de estado que se consideran erróneos. | failureStatusCodeRange[] |
Nombre | Descripción | Valor |
---|---|---|
máximo | Código de estado HTTP máximo. | Int Restricciones: Valor mínimo = 200 Valor máximo = 599 |
min | Código de estado http mínimo. | Int Restricciones: Valor mínimo = 200 Valor máximo = 599 |
Nombre | Descripción | Valor |
---|---|---|
issuerCertificateThumbprint | Huella digital del emisor del certificado. | cuerda |
nombre | Nombre común del certificado. | cuerda |
El tipo de recurso service/workspaces/backends se puede implementar con operaciones que tienen como destino:
- grupos de recursos de
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/workspaces/backends, agregue el siguiente terraform a la plantilla.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/backends@2024-05-01"
name = "string"
body = jsonencode({
properties = {
circuitBreaker = {
rules = [
{
acceptRetryAfter = bool
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"
priority = int
weight = int
}
]
}
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"
}
})
}
Nombre | Descripción | Valor |
---|---|---|
parámetro | Valor del parámetro de autenticación. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 300 (obligatorio) |
esquema | Nombre del esquema de autenticación. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 100 (obligatorio) |
Nombre | Descripción | Valor |
---|---|---|
servicios | Lista de entidades de back-end que pertenecen a un grupo. | backendPoolItem[] |
Nombre | Descripción | Valor |
---|---|---|
reglas | Reglas para realizar el recorrido del back-end. | circuitBreakerRule[] |
Nombre | Descripción | Valor |
---|---|---|
circuitBreaker | Configuración del disyuntor de back-end | backendCircuitBreaker de |
credenciales | Propiedades del contrato de credenciales de back-end | backendCredentialsContract |
descripción | Descripción del back-end. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000 |
piscina | backendBaseParametersPool | |
Propiedades | Contrato de propiedades de back-end | backendProperties de |
protocolo | 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. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000 |
título | Título de back-end. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 300 |
tls | Propiedades tls de back-end | backendTlsProperties |
tipo | Tipo del back-end. Un back-end puede ser Single o Pool. | 'Pool' 'Single' |
URL | Dirección URL en tiempo de ejecución del back-end. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000 (obligatorio) |
Nombre | Descripción | Valor |
---|---|---|
autorización | Autenticación de encabezado de autorización | BackendAuthorizationHeaderCredentials |
certificado | Lista de huellas digitales de certificado de cliente. Se omitirá si se proporcionan certificatesIds. | string[] |
certificateIds | Lista de identificadores de certificado de cliente. | string[] |
encabezado | Descripción del parámetro de encabezado. | backendCredentialsContractHeader |
consulta | Descripción del parámetro de consulta. | backendCredentialsContractQuery |
Nombre | Descripción | Valor |
---|
Nombre | Descripción | Valor |
---|
Nombre | Descripción | Valor |
---|---|---|
identificación | Identificador único de ARM de la entidad back-end. El identificador de ARM debe hacer referencia a una entidad de back-end ya existente. | string (obligatorio) |
prioridad | Prioridad de la entidad de back-end en el grupo de back-end. Debe estar comprendido entre 0 y 100. También puede ser NULL si no se especifica el valor. | Int Restricciones: Valor mínimo = 0 Valor máximo = 100 |
peso | Peso de la entidad de back-end en el grupo de back-end. Debe estar comprendido entre 0 y 100. También puede ser NULL si no se especifica el valor. | Int Restricciones: Valor mínimo = 0 Valor máximo = 100 |
Nombre | Descripción | Valor |
---|---|---|
serviceFabricCluster | Propiedades del clúster de Service Fabric de back-end | BackendServiceFabricClusterProperties |
Nombre | Descripción | Valor |
---|---|---|
contraseña | Contraseña para conectarse al servidor WebProxy | cuerda |
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. | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 2000 (obligatorio) |
nombre de usuario | Nombre de usuario para conectarse al servidor WebProxy | cuerda |
Nombre | Descripción | Valor |
---|---|---|
clientCertificateId | Identificador de certificado de cliente para el punto de conexión de administración. | cuerda |
clientCertificatethumbprint | Huella digital del certificado de cliente para el punto de conexión de administración. Se omitirá si se proporcionan certificatesIds. | cuerda |
managementEndpoints | Punto de conexión de administración del clúster. | 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 Server X509 Certificate Names | X509CertificateName[] |
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 |
Nombre | Descripción | Valor |
---|---|---|
contar | Umbral para abrir el circuito. | Int |
errorReasons | Los motivos de error que se consideran erróneos. | cuerda Restricciones: Longitud máxima = 200[] |
intervalo | Intervalo durante el que se cuentan los errores. | cuerda |
porcentaje | Umbral para abrir el circuito. | Int |
statusCodeRanges | Intervalos de código de estado que se consideran erróneos. | failureStatusCodeRange[] |
Nombre | Descripción | Valor |
---|---|---|
máximo | Código de estado HTTP máximo. | Int Restricciones: Valor mínimo = 200 Valor máximo = 599 |
min | Código de estado http mínimo. | Int Restricciones: Valor mínimo = 200 Valor máximo = 599 |
Nombre | Descripción | Valor |
---|---|---|
nombre | El nombre del recurso | cuerda Restricciones: Longitud mínima = 1 Longitud máxima = 80 (obligatorio) |
parent_id | Identificador del recurso que es el elemento primario de este recurso. | Identificador del recurso de tipo: servicio o áreas de trabajo |
Propiedades | Propiedades del contrato de entidad de back-end. | BackendContractProperties |
tipo | El tipo de recurso | "Microsoft.ApiManagement/service/workspaces/backends@2024-05-01" |
Nombre | Descripción | Valor |
---|---|---|
issuerCertificateThumbprint | Huella digital del emisor del certificado. | cuerda |
nombre | Nombre común del certificado. | cuerda |