Compartilhar via

Serviço/back-ends Microsoft.ApiManagement

  • Artigo

Definição de recurso do Bicep

O tipo de recurso de serviço/back-ends pode ser implantado com operações direcionadas:

Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service/back-ends, adicione o Bicep a seguir ao modelo.

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 propriedade

serviço/back-ends

Nome Descrição Valor
name O nome do recurso

Veja como definir nomes e tipos para recursos filho no Bicep.		 cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.
pai No Bicep, você pode especificar o recurso pai para um recurso filho. Você só precisa adicionar essa propriedade quando o recurso filho é declarado fora do recurso pai.

Para obter mais informações, consulte Recurso filho fora do recurso pai.		 Nome simbólico para o recurso do tipo: serviço
properties Propriedades do contrato de entidade de back-end. BackendContractProperties

BackendContractProperties

Nome Descrição Valor
circuitBreaker Configuração do disjuntor de back-end BackendCircuitBreaker
credenciais Propriedades do contrato de credenciais de back-end BackendCredentialsContract
descrição Descrição do back-end. string
pool BackendBaseParametersPool
properties Contrato de propriedades de back-end BackendProperties
protocolo Protocolo de comunicação de back-end. 'http'
'soap' (obrigatório)
proxy Propriedades do contrato do gateway de back-end BackendProxyContract
resourceId URI de gerenciamento do recurso no sistema externo. Essa URL pode ser a ID de Recurso do Arm de Aplicativos Lógicos, Aplicativos de Funções ou Aplicativos de API. string
título Título de back-end. string
Tls Propriedades do TLS de back-end BackendTlsProperties
tipo Tipo do back-end. Um back-end pode ser Único ou Pool. 'Pool'
'Single'
url URL de runtime do back-end. cadeia de caracteres (obrigatório)

BackendCircuitBreaker

Nome Descrição Valor
regras As regras para tropeçar no back-end. CircuitBreakerRule[]

CircuitBreakerRule

Nome Descrição Valor
failureCondition As condições para tropeço do disjuntor. CircuitBreakerFailureCondition
name O nome da regra. string
tripDuration A duração para a qual o circuito será tropeçado. string

CircuitBreakerFailureCondition

Nome Descrição Valor
count O limite para abrir o circuito. INT
errorReasons Os motivos de erro que são considerados como falha. string[]
intervalo O intervalo durante o qual as falhas são contadas. string
percentage O limite para abrir o circuito. INT
statusCodeRanges O status intervalos de código que são considerados como falha. FailureStatusCodeRange[]

FailureStatusCodeRange

Nome Descrição Valor
max O código http status máximo. INT
min O código http status mínimo. INT

BackendCredentialsContract

Nome Descrição Valor
autorização Autenticação de cabeçalho de autorização BackendAuthorizationHeaderCredentials
certificado Lista de impressões digitais do certificado do cliente. Serão ignorados se certificatesIds forem fornecidos. string[]
certificateIds Lista de IDs de certificado do cliente. string[]
header Descrição do parâmetro de cabeçalho. BackendCredentialsContractHeader
Consulta Descrição do parâmetro de consulta. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nome Descrição Valor
parâmetro Valor do parâmetro de autenticação. cadeia de caracteres (obrigatório)
scheme Nome do esquema de autenticação. cadeia de caracteres (obrigatório)

BackendCredentialsContractHeader

Nome Descrição Valor
{propriedade personalizada} string[]

BackendCredentialsContractQuery

Nome Descrição Valor
{propriedade personalizada} string[]

BackendBaseParametersPool

Nome Descrição Valor
services A lista de entidades de back-end pertencentes a um pool. BackendPoolItem[]

BackendPoolItem

Nome Descrição Valor
id A ID exclusiva do ARM da entidade de back-end. A ID do ARM deve se referir a uma entidade de back-end já existente. cadeia de caracteres (obrigatório)

BackendProperties

Nome Descrição Valor
serviceFabricCluster Propriedades do cluster do Service Fabric de back-end BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Nome Descrição Valor
clientCertificateId A ID do certificado do cliente para o ponto de extremidade de gerenciamento. string
clientCertificatethumbprint A impressão digital do certificado do cliente para o ponto de extremidade de gerenciamento. Será ignorado se certificatesIds forem fornecidos string
managementEndpoints O ponto de extremidade de gerenciamento de cluster. string[] (obrigatório)
maxPartitionResolutionRetries Número máximo de tentativas ao tentar resolve a partição. INT
serverCertificateThumbprints Impressões digitais dos certificados que o serviço de gerenciamento de cluster usa para comunicação tls string[]
serverX509Names Coleção Server X509 Certificate Names X509CertificateName[]

X509CertificateName

Nome Descrição Valor
issuerCertificateThumbprint Impressão digital do Emissor do Certificado. string
name Nome comum do certificado. string

BackendProxyContract

Nome Descrição Valor
password Senha para se conectar ao Servidor WebProxy string
url Propriedade AbsoluteUri do Servidor WebProxy, que inclui todo o URI armazenado na instância de URI, incluindo todos os fragmentos e cadeias de caracteres de consulta. cadeia de caracteres (obrigatório)
Nome de Usuário Nome de usuário para se conectar ao servidor WebProxy string

BackendTlsProperties

Nome Descrição Valor
validateCertificateChain Sinalizador que indica se a validação da cadeia de certificados SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. bool
validateCertificateName Sinalizador que indica se a validação do nome do certificado SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. bool

Definição de recurso de modelo do ARM

O tipo de recurso de serviço/back-ends pode ser implantado com operações direcionadas:

Para obter uma lista das propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service/back-ends, adicione o JSON a seguir ao modelo.

{
  "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 propriedade

serviço/back-ends

Nome Descrição Valor
tipo O tipo de recurso 'Microsoft.ApiManagement/service/backends'
apiVersion A versão da API do recurso '2023-05-01-preview'
name O nome do recurso

Veja como definir nomes e tipos para recursos filho em modelos do ARM JSON.		 cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.
properties Propriedades do contrato de entidade de back-end. BackendContractProperties

BackendContractProperties

Nome Descrição Valor
circuitBreaker Configuração do disjuntor de back-end BackendCircuitBreaker
credenciais Propriedades do contrato de credenciais de back-end BackendCredentialsContract
descrição Descrição do back-end. string
pool BackendBaseParametersPool
properties Contrato de propriedades de back-end BackendProperties
protocolo Protocolo de comunicação de back-end. 'http'
'soap' (obrigatório)
proxy Propriedades do contrato do gateway de back-end BackendProxyContract
resourceId Uri de gerenciamento do recurso no sistema externo. Essa URL pode ser a ID de Recurso arm de Aplicativos Lógicos, Aplicativos de Funções ou Aplicativos de API. string
título Título de back-end. string
Tls Propriedades do TLS de back-end BackendTlsProperties
tipo Tipo do back-end. Um back-end pode ser Single ou Pool. 'Pool'
'Single'
url Url de runtime do back-end. cadeia de caracteres (obrigatório)

BackendCircuitBreaker

Nome Descrição Valor
regras As regras para tropeçar no back-end. CircuitBreakerRule[]

CircuitBreakerRule

Nome Descrição Valor
failureCondition As condições para tropeçar no disjuntor. CircuitBreakerFailureCondition
name O nome da regra. string
tripDuration A duração para a qual o circuito será tropeçado. string

CircuitBreakerFailureCondition

Nome Descrição Valor
count O limite para abrir o circuito. INT
errorReasons Os motivos de erro que são considerados como falha. string[]
intervalo O intervalo durante o qual as falhas são contadas. string
percentage O limite para abrir o circuito. INT
statusCodeRanges O status intervalos de código que são considerados como falha. FailureStatusCodeRange[]

FailureStatusCodeRange

Nome Descrição Valor
max O código http status máximo. INT
min O código http status mínimo. INT

BackendCredentialsContract

Nome Descrição Valor
autorização Autenticação de cabeçalho de autorização BackendAuthorizationHeaderCredentials
certificado Lista de impressões digitais do certificado do cliente. Serão ignorados se certificatesIds forem fornecidos. string[]
certificateIds Lista de IDs de certificado do cliente. string[]
header Descrição do parâmetro de cabeçalho. BackendCredentialsContractHeader
Consulta Descrição do parâmetro de consulta. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nome Descrição Valor
parâmetro Valor do parâmetro de autenticação. cadeia de caracteres (obrigatório)
scheme Nome do esquema de autenticação. cadeia de caracteres (obrigatório)

BackendCredentialsContractHeader

Nome Descrição Valor
{propriedade personalizada} string[]

BackendCredentialsContractQuery

Nome Descrição Valor
{propriedade personalizada} string[]

BackendBaseParametersPool

Nome Descrição Valor
services A lista de entidades de back-end pertencentes a um pool. BackendPoolItem[]

BackendPoolItem

Nome Descrição Valor
id A ID exclusiva do ARM da entidade de back-end. A ID do ARM deve se referir a uma entidade de back-end já existente. cadeia de caracteres (obrigatório)

BackendProperties

Nome Descrição Valor
serviceFabricCluster Propriedades do cluster do Service Fabric de back-end BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Nome Descrição Valor
clientCertificateId A ID do certificado do cliente para o ponto de extremidade de gerenciamento. string
clientCertificatethumbprint A impressão digital do certificado do cliente para o ponto de extremidade de gerenciamento. Serão ignorados se certificatesIds forem fornecidos string
managementEndpoints O ponto de extremidade de gerenciamento de cluster. string[] (obrigatório)
maxPartitionResolutionRetries Número máximo de repetições ao tentar resolve a partição. INT
serverCertificateThumbprints Impressões digitais dos certificados que o serviço de gerenciamento de cluster usa para comunicação tls string[]
serverX509Names Coleção De Nomes de Certificado X509 do Servidor X509CertificateName[]

X509CertificateName

Nome Descrição Valor
issuerCertificateThumbprint Impressão digital para o emissor do certificado. string
name Nome Comum do Certificado. string

BackendProxyContract

Nome Descrição Valor
password Senha para se conectar ao Servidor WebProxy string
url Propriedade AbsoluteUri do Servidor WebProxy, que inclui todo o URI armazenado na instância de Uri, incluindo todos os fragmentos e cadeias de caracteres de consulta. cadeia de caracteres (obrigatório)
Nome de Usuário Nome de usuário para se conectar ao servidor WebProxy string

BackendTlsProperties

Nome Descrição Valor
validateCertificateChain Sinalizador que indica se a validação da cadeia de certificados SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. bool
validateCertificateName Sinalizador que indica se a validação do nome do certificado SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. bool

Definição de recurso do Terraform (provedor AzAPI)

O tipo de recurso de serviço/back-ends pode ser implantado com operações direcionadas:

  • Grupos de recursos

Para obter uma lista de propriedades alteradas em cada versão da API, consulte log de alterações.

Formato de recurso

Para criar um recurso Microsoft.ApiManagement/service/back-ends, adicione o Terraform a seguir ao modelo.

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 propriedade

serviço/back-ends

Nome Descrição Valor
tipo O tipo de recurso "Microsoft.ApiManagement/service/backends@2023-05-01-preview"
name O nome do recurso cadeia de caracteres (obrigatório)

Limite de caracteres: 1 a 80

Caracteres válidos:
Caracteres alfanuméricos e hifens.

Comece com uma letra e termine com um caractere alfanumérico.
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: serviço
properties Propriedades do contrato de entidade de back-end. BackendContractProperties

BackendContractProperties

Nome Descrição Valor
circuitBreaker Configuração do disjuntor de back-end BackendCircuitBreaker
credenciais Propriedades do contrato de credenciais de back-end BackendCredentialsContract
descrição Descrição do back-end. string
pool BackendBaseParametersPool
properties Contrato de propriedades de back-end BackendProperties
protocolo Protocolo de comunicação de back-end. "http"
"soap" (obrigatório)
proxy Propriedades do contrato do gateway de back-end BackendProxyContract
resourceId Uri de gerenciamento do recurso no sistema externo. Essa URL pode ser a ID de Recurso arm de Aplicativos Lógicos, Aplicativos de Funções ou Aplicativos de API. string
título Título de back-end. string
Tls Propriedades do TLS de back-end BackendTlsProperties
tipo Tipo do back-end. Um back-end pode ser Single ou Pool. "Pool"
"Single"
url Url de runtime do back-end. cadeia de caracteres (obrigatório)

BackendCircuitBreaker

Nome Descrição Valor
regras As regras para tropeçar no back-end. CircuitBreakerRule[]

CircuitBreakerRule

Nome Descrição Valor
failureCondition As condições para tropeçar no disjuntor. CircuitBreakerFailureCondition
name O nome da regra. string
tripDuration A duração para a qual o circuito será tropeçado. string

CircuitBreakerFailureCondition

Nome Descrição Valor
count O limite para abrir o circuito. INT
errorReasons Os motivos de erro que são considerados como falha. string[]
intervalo O intervalo durante o qual as falhas são contadas. string
percentage O limite para abrir o circuito. INT
statusCodeRanges O status intervalos de código que são considerados como falha. FailureStatusCodeRange[]

FailureStatusCodeRange

Nome Descrição Valor
max O código http status máximo. INT
min O código http status mínimo. INT

BackendCredentialsContract

Nome Descrição Valor
autorização Autenticação de cabeçalho de autorização BackendAuthorizationHeaderCredentials
certificado Lista de impressões digitais do certificado do cliente. Serão ignorados se certificatesIds forem fornecidos. string[]
certificateIds Lista de IDs de certificado do cliente. string[]
header Descrição do parâmetro de cabeçalho. BackendCredentialsContractHeader
Consulta Descrição do parâmetro de consulta. BackendCredentialsContractQuery

BackendAuthorizationHeaderCredentials

Nome Descrição Valor
parâmetro Valor do parâmetro de autenticação. cadeia de caracteres (obrigatório)
scheme Nome do esquema de autenticação. cadeia de caracteres (obrigatório)

BackendCredentialsContractHeader

Nome Descrição Valor
{propriedade personalizada} string[]

BackendCredentialsContractQuery

Nome Descrição Valor
{propriedade personalizada} string[]

BackendBaseParametersPool

Nome Descrição Valor
services A lista de entidades de back-end pertencentes a um pool. BackendPoolItem[]

BackendPoolItem

Nome Descrição Valor
id A ID exclusiva do ARM da entidade de back-end. A ID do ARM deve se referir a uma entidade de back-end já existente. cadeia de caracteres (obrigatório)

BackendProperties

Nome Descrição Valor
serviceFabricCluster Propriedades do cluster do Service Fabric de back-end BackendServiceFabricClusterProperties

BackendServiceFabricClusterProperties

Nome Descrição Valor
clientCertificateId A ID do certificado do cliente para o ponto de extremidade de gerenciamento. string
clientCertificatethumbprint A impressão digital do certificado do cliente para o ponto de extremidade de gerenciamento. Serão ignorados se certificatesIds forem fornecidos string
managementEndpoints O ponto de extremidade de gerenciamento de cluster. string[] (obrigatório)
maxPartitionResolutionRetries Número máximo de repetições ao tentar resolve a partição. INT
serverCertificateThumbprints Impressões digitais dos certificados que o serviço de gerenciamento de cluster usa para comunicação tls string[]
serverX509Names Coleção De Nomes de Certificado X509 do Servidor X509CertificateName[]

X509CertificateName

Nome Descrição Valor
issuerCertificateThumbprint Impressão digital do Emissor do Certificado. string
name Nome comum do certificado. string

BackendProxyContract

Nome Descrição Valor
password Senha para se conectar ao Servidor WebProxy string
url Propriedade AbsoluteUri do Servidor WebProxy, que inclui todo o URI armazenado na instância de URI, incluindo todos os fragmentos e cadeias de caracteres de consulta. cadeia de caracteres (obrigatório)
Nome de Usuário Nome de usuário para se conectar ao servidor WebProxy string

BackendTlsProperties

Nome Descrição Valor
validateCertificateChain Sinalizador que indica se a validação da cadeia de certificados SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. bool
validateCertificateName Sinalizador que indica se a validação do nome do certificado SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. bool