Servicio Microsoft.ApiManagement/back-end

Definición de recursos de Bicep

El tipo de recurso service/backends se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/backends, agregue lo siguiente a la plantilla de Bicep.

resource symbolicname 'Microsoft.ApiManagement/service/backends@2025-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    azureRegion: 'string'
    circuitBreaker: {
      rules: [
        {
          acceptRetryAfter: bool
          failureCondition: {
            count: int
            errorReasons: [
              'string'
            ]
            interval: 'string'
            percentage: int
            statusCodeRanges: [
              {
                max: int
                min: int
              }
            ]
          }
          failureResponse: {
            statusCode: 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: {
      failureResponse: {
        statusCode: int
      }
      services: [
        {
          id: 'string'
          preferredCarbonEmission: 'string'
          priority: int
          weight: int
        }
      ]
      sessionAffinity: {
        sessionId: {
          name: 'string'
          source: '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: {
      serverCertificateThumbprints: [
        'string'
      ]
      serverX509Names: [
        {
          issuerCertificateThumbprint: 'string'
          name: 'string'
        }
      ]
      validateCertificateChain: bool
      validateCertificateName: bool
    }
    type: 'string'
    url: 'string'
  }
}

Valores de propiedad

Microsoft.ApiManagement/service/back-ends

BackendAuthorizationHeaderCredentials

BackendBaseParametersPool

BackendCircuitBreaker

BackendContractProperties

BackendCredentialsContract

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendFailureResponse

BackendPoolItem

BackendProperties

BackendProxyContract

BackendServiceFabricClusterProperties

BackendSessionAffinity

BackendSessionId

BackendTlsProperties

Condición de falloInterruptor de circuito

Regla de disyuntor

FailureStatusCodeRange

X509CertificateName

Definición de recursos de plantilla de ARM

El tipo de recurso service/backends se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/backends, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.ApiManagement/service/backends",
  "apiVersion": "2025-03-01-preview",
  "name": "string",
  "properties": {
    "azureRegion": "string",
    "circuitBreaker": {
      "rules": [
        {
          "acceptRetryAfter": "bool",
          "failureCondition": {
            "count": "int",
            "errorReasons": [ "string" ],
            "interval": "string",
            "percentage": "int",
            "statusCodeRanges": [
              {
                "max": "int",
                "min": "int"
              }
            ]
          },
          "failureResponse": {
            "statusCode": "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": {
      "failureResponse": {
        "statusCode": "int"
      },
      "services": [
        {
          "id": "string",
          "preferredCarbonEmission": "string",
          "priority": "int",
          "weight": "int"
        }
      ],
      "sessionAffinity": {
        "sessionId": {
          "name": "string",
          "source": "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": {
      "serverCertificateThumbprints": [ "string" ],
      "serverX509Names": [
        {
          "issuerCertificateThumbprint": "string",
          "name": "string"
        }
      ],
      "validateCertificateChain": "bool",
      "validateCertificateName": "bool"
    },
    "type": "string",
    "url": "string"
  }
}

Valores de propiedad

Microsoft.ApiManagement/service/back-ends

BackendAuthorizationHeaderCredentials

BackendBaseParametersPool

BackendCircuitBreaker

BackendContractProperties

BackendCredentialsContract

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendFailureResponse

BackendPoolItem

BackendProperties

BackendProxyContract

BackendServiceFabricClusterProperties

BackendSessionAffinity

BackendSessionId

BackendTlsProperties

Condición de falloInterruptor de circuito

Regla de disyuntor

FailureStatusCodeRange

X509CertificateName

Ejemplos de uso

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso service/backends se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/backends, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/backends@2025-03-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      azureRegion = "string"
      circuitBreaker = {
        rules = [
          {
            acceptRetryAfter = bool
            failureCondition = {
              count = int
              errorReasons = [
                "string"
              ]
              interval = "string"
              percentage = int
              statusCodeRanges = [
                {
                  max = int
                  min = int
                }
              ]
            }
            failureResponse = {
              statusCode = 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 = {
        failureResponse = {
          statusCode = int
        }
        services = [
          {
            id = "string"
            preferredCarbonEmission = "string"
            priority = int
            weight = int
          }
        ]
        sessionAffinity = {
          sessionId = {
            name = "string"
            source = "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 = {
        serverCertificateThumbprints = [
          "string"
        ]
        serverX509Names = [
          {
            issuerCertificateThumbprint = "string"
            name = "string"
          }
        ]
        validateCertificateChain = bool
        validateCertificateName = bool
      }
      type = "string"
      url = "string"
    }
  }
}

Valores de propiedad

Microsoft.ApiManagement/service/back-ends

BackendAuthorizationHeaderCredentials

BackendBaseParametersPool

BackendCircuitBreaker

BackendContractProperties

BackendCredentialsContract

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendFailureResponse

BackendPoolItem

BackendProperties

BackendProxyContract

BackendServiceFabricClusterProperties

BackendSessionAffinity

BackendSessionId

BackendTlsProperties

Condición de falloInterruptor de circuito

Regla de disyuntor

FailureStatusCodeRange

X509CertificateName

Ejemplos de uso

Ejemplos de Terraform

Un ejemplo básico de implementación de back-end dentro de un servicio de administración de API.

terraform {
  required_providers {
    azapi = {
      source = "Azure/azapi"
    }
  }
}

provider "azapi" {
  skip_provider_registration = false
}

variable "resource_name" {
  type    = string
  default = "acctest0001"
}

variable "location" {
  type    = string
  default = "westeurope"
}

resource "azapi_resource" "resourceGroup" {
  type     = "Microsoft.Resources/resourceGroups@2020-06-01"
  name     = var.resource_name
  location = var.location
}

resource "azapi_resource" "service" {
  type      = "Microsoft.ApiManagement/service@2021-08-01"
  parent_id = azapi_resource.resourceGroup.id
  name      = var.resource_name
  location  = var.location
  body = {
    properties = {
      certificates = [
      ]
      customProperties = {
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Ssl30" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls10" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Backend.Protocols.Tls11" = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls10"         = "false"
        "Microsoft.WindowsAzure.ApiManagement.Gateway.Security.Protocols.Tls11"         = "false"
      }
      disableGateway      = false
      publicNetworkAccess = "Enabled"
      publisherEmail      = "pub1@email.com"
      publisherName       = "pub1"
      virtualNetworkType  = "None"
    }
    sku = {
      capacity = 0
      name     = "Consumption"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}

resource "azapi_resource" "backend" {
  type      = "Microsoft.ApiManagement/service/backends@2021-08-01"
  parent_id = azapi_resource.service.id
  name      = var.resource_name
  body = {
    properties = {
      protocol = "http"
      url      = "https://acctest"
    }
  }
  schema_validation_enabled = false
  response_export_values    = ["*"]
}