Compartilhar via

Serviço/back-ends microsoft.apiManagement 2023-03-01-preview

  • Artigo

Definição de recurso do Bicep

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

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de 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-03-01-preview' = {
  parent: resourceSymbolicName
  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'
    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
    }
    url: 'string'
  }
}

Valores de propriedade

BackendAuthorizationHeaderCredentials

Nome Descrição Valor
parâmetro Valor do parâmetro de autenticação. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
esquema Nome do Esquema de Autenticação. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)

BackendCircuitBreaker

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

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. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Propriedades Contrato de propriedades de back-end back-endProperties
protocolo Protocolo de comunicação de back-end. 'http'
'soap' (obrigatório)
procuração 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. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
título Título de back-end. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
tls Propriedades do TLS de back-end back-endTlsProperties
url Url de runtime do back-end. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)

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[]
cabeçalho Descrição do parâmetro de cabeçalho. BackendCredentialsContractHeader
consulta Descrição do parâmetro de consulta. BackendCredentialsContractQuery

BackendCredentialsContractHeader

Nome Descrição Valor

BackendCredentialsContractQuery

Nome Descrição Valor

BackendProperties

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

BackendProxyContract

Nome Descrição Valor
senha Senha para se conectar ao Servidor WebProxy corda
url Propriedade AbsoluteUri do Servidor WebProxy, que inclui todo o URI armazenado na instância do Uri, incluindo todos os fragmentos e cadeias de caracteres de consulta. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
nome de usuário Nome de usuário para se conectar ao servidor WebProxy corda

BackendServiceFabricClusterProperties

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

BackendTlsProperties

Nome Descrição Valor
validateCertificateChain Sinalizador indicando 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 indicando se a validação do nome do certificado SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. Bool

CircuitBreakerFailureCondition

Nome Descrição Valor
contar O limite para abrir o circuito. int
errorReasons Os motivos de erro que são considerados como falha. corda

Restrições:
Comprimento máximo = []
intervalo O intervalo durante o qual as falhas são contadas. corda
porcentagem O limite para abrir o circuito. int
statusCodeRanges Os intervalos de código de status considerados como falha. FailureStatusCodeRange[]

CircuitBreakerRule

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

FailureStatusCodeRange

Nome Descrição Valor
Max O código de status http máximo. int

Restrições:
Valor mínimo = 200
Valor máximo = 599
Min O código de status http mínimo. int

Restrições:
Valor mínimo = 200
Valor máximo = 599

Microsoft.ApiManagement/service/back-ends

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
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 do recurso do tipo: de serviço
Propriedades Propriedades do contrato de entidade de back-end. BackendContractProperties

X509CertificateName

Nome Descrição Valor
issuerCertificateThumbprint Impressão digital para o emissor do certificado. corda
nome Nome comum do certificado. corda

Definição de recurso de modelo do ARM

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

Para obter uma lista de propriedades alteradas em cada versão da API, consulte de 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-03-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",
    "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"
    },
    "url": "string"
  }
}

Valores de propriedade

BackendAuthorizationHeaderCredentials

Nome Descrição Valor
parâmetro Valor do parâmetro de autenticação. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
esquema Nome do Esquema de Autenticação. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)

BackendCircuitBreaker

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

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. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Propriedades Contrato de propriedades de back-end back-endProperties
protocolo Protocolo de comunicação de back-end. 'http'
'soap' (obrigatório)
procuração 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. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
título Título de back-end. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
tls Propriedades do TLS de back-end back-endTlsProperties
url Url de runtime do back-end. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)

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[]
cabeçalho Descrição do parâmetro de cabeçalho. BackendCredentialsContractHeader
consulta Descrição do parâmetro de consulta. BackendCredentialsContractQuery

BackendCredentialsContractHeader

Nome Descrição Valor

BackendCredentialsContractQuery

Nome Descrição Valor

BackendProperties

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

BackendProxyContract

Nome Descrição Valor
senha Senha para se conectar ao Servidor WebProxy corda
url Propriedade AbsoluteUri do Servidor WebProxy, que inclui todo o URI armazenado na instância do Uri, incluindo todos os fragmentos e cadeias de caracteres de consulta. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
nome de usuário Nome de usuário para se conectar ao servidor WebProxy corda

BackendServiceFabricClusterProperties

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

BackendTlsProperties

Nome Descrição Valor
validateCertificateChain Sinalizador indicando 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 indicando se a validação do nome do certificado SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. Bool

CircuitBreakerFailureCondition

Nome Descrição Valor
contar O limite para abrir o circuito. int
errorReasons Os motivos de erro que são considerados como falha. corda

Restrições:
Comprimento máximo = []
intervalo O intervalo durante o qual as falhas são contadas. corda
porcentagem O limite para abrir o circuito. int
statusCodeRanges Os intervalos de código de status considerados como falha. FailureStatusCodeRange[]

CircuitBreakerRule

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

FailureStatusCodeRange

Nome Descrição Valor
Max O código de status http máximo. int

Restrições:
Valor mínimo = 200
Valor máximo = 599
Min O código de status http mínimo. int

Restrições:
Valor mínimo = 200
Valor máximo = 599

Microsoft.ApiManagement/service/back-ends

Nome Descrição Valor
apiVersion A versão da API '2023-03-01-preview'
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
Propriedades Propriedades do contrato de entidade de back-end. BackendContractProperties
tipo O tipo de recurso 'Microsoft.ApiManagement/service/backends'

X509CertificateName

Nome Descrição Valor
issuerCertificateThumbprint Impressão digital para o emissor do certificado. corda
nome Nome comum do certificado. corda

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

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

  • grupos de recursos

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

Formato de recurso

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/backends@2023-03-01-preview"
  name = "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"
      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
      }
      url = "string"
    }
  })
}

Valores de propriedade

BackendAuthorizationHeaderCredentials

Nome Descrição Valor
parâmetro Valor do parâmetro de autenticação. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
esquema Nome do Esquema de Autenticação. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)

BackendCircuitBreaker

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

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. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
Propriedades Contrato de propriedades de back-end back-endProperties
protocolo Protocolo de comunicação de back-end. 'http'
'soap' (obrigatório)
procuração 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. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
título Título de back-end. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
tls Propriedades do TLS de back-end back-endTlsProperties
url Url de runtime do back-end. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)

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[]
cabeçalho Descrição do parâmetro de cabeçalho. BackendCredentialsContractHeader
consulta Descrição do parâmetro de consulta. BackendCredentialsContractQuery

BackendCredentialsContractHeader

Nome Descrição Valor

BackendCredentialsContractQuery

Nome Descrição Valor

BackendProperties

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

BackendProxyContract

Nome Descrição Valor
senha Senha para se conectar ao Servidor WebProxy corda
url Propriedade AbsoluteUri do Servidor WebProxy, que inclui todo o URI armazenado na instância do Uri, incluindo todos os fragmentos e cadeias de caracteres de consulta. corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
nome de usuário Nome de usuário para se conectar ao servidor WebProxy corda

BackendServiceFabricClusterProperties

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

BackendTlsProperties

Nome Descrição Valor
validateCertificateChain Sinalizador indicando 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 indicando se a validação do nome do certificado SSL deve ser feita ao usar certificados autoassinados para esse host de back-end. Bool

CircuitBreakerFailureCondition

Nome Descrição Valor
contar O limite para abrir o circuito. int
errorReasons Os motivos de erro que são considerados como falha. corda

Restrições:
Comprimento máximo = []
intervalo O intervalo durante o qual as falhas são contadas. corda
porcentagem O limite para abrir o circuito. int
statusCodeRanges Os intervalos de código de status considerados como falha. FailureStatusCodeRange[]

CircuitBreakerRule

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

FailureStatusCodeRange

Nome Descrição Valor
Max O código de status http máximo. int

Restrições:
Valor mínimo = 200
Valor máximo = 599
Min O código de status http mínimo. int

Restrições:
Valor mínimo = 200
Valor máximo = 599

Microsoft.ApiManagement/service/back-ends

Nome Descrição Valor
nome O nome do recurso corda

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1 (obrigatório)
parent_id A ID do recurso que é o pai desse recurso. ID do recurso do tipo: serviço
Propriedades Propriedades do contrato de entidade de back-end. BackendContractProperties
tipo O tipo de recurso "Microsoft.ApiManagement/service/backends@2023-03-01-preview"

X509CertificateName

Nome Descrição Valor
issuerCertificateThumbprint Impressão digital para o emissor do certificado. corda
nome Nome comum do certificado. corda