Partilhar via

Serviço Microsoft.ApiManagement/backends 2021-12-01-preview

  • Artigo

Definição de recursos do bíceps

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

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

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/backends, adicione o seguinte Bicep ao seu modelo.

resource symbolicname 'Microsoft.ApiManagement/service/backends@2021-12-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    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

Designação Descrição Valor
parâmetro Valor do parâmetro de autenticação. string

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

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

BackendContractProperties

Designação Descrição Valor
Credenciais Propriedades do contrato de credenciais de back-end BackendCredentialsContract
Descrição Descrição do back-end. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
propriedades Contrato de propriedades de back-end BackendProperties
protocolo Protocolo de comunicação de back-end. «http»
'sabão' (obrigatório)
procuração Propriedades do contrato de proxy de back-end BackendProxyContract
resourceId Uri de Gestão do Recurso no Sistema Externo. Este url pode ser o Arm Resource Id de Aplicativos Lógicos, Aplicativos de Função ou Aplicativos de API. string

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
TLS Propriedades TLS de back-end BackendTlsProperties
URL url de tempo de execução do back-end. string

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

BackendCredentialsContract

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

BackendCredentialsContractHeader

Designação Descrição Valor

BackendCredentialsContractQuery

Designação Descrição Valor

BackendProperties

Designação Descrição Valor
serviceFabricCluster Propriedades do cluster do Backend Service Fabric BackendServiceFabricClusterProperties

BackendProxyContract

Designação Descrição Valor
palavra-passe Senha para se conectar ao WebProxy Server string
URL Propriedade WebProxy Server AbsoluteUri que inclui todo o URI armazenado na instância de Uri, incluindo todos os fragmentos e cadeias de caracteres de consulta. string

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

BackendServiceFabricClusterProperties

Designação Descrição Valor
clientCertificateId A ID do certificado do cliente para o ponto de extremidade de gerenciamento. string
clientCertificateimpressão digital A impressão digital do certificado do cliente para o ponto de extremidade de gerenciamento. Será ignorado se certificatesIds forem fornecidos string
gerenciamentoPontos finais O ponto de extremidade de gerenciamento de cluster. string[] (obrigatório)
maxPartitionResolutionRetries Número máximo de tentativas ao tentar resolver a partição. Int
serverCertificateImpressões digitais Impressões digitais de certificados que o serviço de gerenciamento de cluster usa para comunicação tls string[]
serverX509Nomes Coleção de Nomes de Certificados X509 do Servidor X509CertificateName[]

BackendTlsProperties

Designação 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

Microsoft.ApiManagement/service/backends

Designação Descrição Valor
Designação O nome do recurso string

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 para recurso do tipo: serviço
propriedades Propriedades de contrato de entidade de back-end. BackendContractProperties

X509CertificateName

Designação Descrição Valor
emissorCertificadoImpressão digital Impressão digital para o emissor do certificado. string
Designação Nome comum do certificado. string

Definição de recurso de modelo ARM

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

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

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/backends, adicione o seguinte JSON ao seu modelo.

{
  "type": "Microsoft.ApiManagement/service/backends",
  "apiVersion": "2021-12-01-preview",
  "name": "string",
  "properties": {
    "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

Designação Descrição Valor
parâmetro Valor do parâmetro de autenticação. string

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

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

BackendContractProperties

Designação Descrição Valor
Credenciais Propriedades do contrato de credenciais de back-end BackendCredentialsContract
Descrição Descrição do back-end. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
propriedades Contrato de propriedades de back-end BackendProperties
protocolo Protocolo de comunicação de back-end. «http»
'sabão' (obrigatório)
procuração Propriedades do contrato de proxy de back-end BackendProxyContract
resourceId Uri de Gestão do Recurso no Sistema Externo. Este url pode ser o Arm Resource Id de Aplicativos Lógicos, Aplicativos de Função ou Aplicativos de API. string

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
TLS Propriedades TLS de back-end BackendTlsProperties
URL url de tempo de execução do back-end. string

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

BackendCredentialsContract

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

BackendCredentialsContractHeader

Designação Descrição Valor

BackendCredentialsContractQuery

Designação Descrição Valor

BackendProperties

Designação Descrição Valor
serviceFabricCluster Propriedades do cluster do Backend Service Fabric BackendServiceFabricClusterProperties

BackendProxyContract

Designação Descrição Valor
palavra-passe Senha para se conectar ao WebProxy Server string
URL Propriedade WebProxy Server AbsoluteUri que inclui todo o URI armazenado na instância de Uri, incluindo todos os fragmentos e cadeias de caracteres de consulta. string

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

BackendServiceFabricClusterProperties

Designação Descrição Valor
clientCertificateId A ID do certificado do cliente para o ponto de extremidade de gerenciamento. string
clientCertificateimpressão digital A impressão digital do certificado do cliente para o ponto de extremidade de gerenciamento. Será ignorado se certificatesIds forem fornecidos string
gerenciamentoPontos finais O ponto de extremidade de gerenciamento de cluster. string[] (obrigatório)
maxPartitionResolutionRetries Número máximo de tentativas ao tentar resolver a partição. Int
serverCertificateImpressões digitais Impressões digitais de certificados que o serviço de gerenciamento de cluster usa para comunicação tls string[]
serverX509Nomes Coleção de Nomes de Certificados X509 do Servidor X509CertificateName[]

BackendTlsProperties

Designação 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

Microsoft.ApiManagement/service/backends

Designação Descrição Valor
apiVersion A versão api '2021-12-01-pré-visualização'
Designação O nome do recurso string

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

X509CertificateName

Designação Descrição Valor
emissorCertificadoImpressão digital Impressão digital para o emissor do certificado. string
Designação Nome comum do certificado. string

Definição de recursos Terraform (provedor AzAPI)

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

  • Grupos de recursos

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

Formato do recurso

Para criar um recurso Microsoft.ApiManagement/service/backends, adicione o seguinte Terraform ao seu modelo.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/backends@2021-12-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      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

Designação Descrição Valor
parâmetro Valor do parâmetro de autenticação. string

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

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

BackendContractProperties

Designação Descrição Valor
Credenciais Propriedades do contrato de credenciais de back-end BackendCredentialsContract
Descrição Descrição do back-end. string

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
propriedades Contrato de propriedades de back-end BackendProperties
protocolo Protocolo de comunicação de back-end. «http»
'sabão' (obrigatório)
procuração Propriedades do contrato de proxy de back-end BackendProxyContract
resourceId Uri de Gestão do Recurso no Sistema Externo. Este url pode ser o Arm Resource Id de Aplicativos Lógicos, Aplicativos de Função ou Aplicativos de API. string

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

Restrições:
Comprimento mínimo = 1
Comprimento máximo = 1
TLS Propriedades TLS de back-end BackendTlsProperties
URL url de tempo de execução do back-end. string

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

BackendCredentialsContract

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

BackendCredentialsContractHeader

Designação Descrição Valor

BackendCredentialsContractQuery

Designação Descrição Valor

BackendProperties

Designação Descrição Valor
serviceFabricCluster Propriedades do cluster do Backend Service Fabric BackendServiceFabricClusterProperties

BackendProxyContract

Designação Descrição Valor
palavra-passe Senha para se conectar ao WebProxy Server string
URL Propriedade WebProxy Server AbsoluteUri que inclui todo o URI armazenado na instância de Uri, incluindo todos os fragmentos e cadeias de caracteres de consulta. string

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

BackendServiceFabricClusterProperties

Designação Descrição Valor
clientCertificateId A ID do certificado do cliente para o ponto de extremidade de gerenciamento. string
clientCertificateimpressão digital A impressão digital do certificado do cliente para o ponto de extremidade de gerenciamento. Será ignorado se certificatesIds forem fornecidos string
gerenciamentoPontos finais O ponto de extremidade de gerenciamento de cluster. string[] (obrigatório)
maxPartitionResolutionRetries Número máximo de tentativas ao tentar resolver a partição. Int
serverCertificateImpressões digitais Impressões digitais de certificados que o serviço de gerenciamento de cluster usa para comunicação tls string[]
serverX509Nomes Coleção de Nomes de Certificados X509 do Servidor X509CertificateName[]

BackendTlsProperties

Designação 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

Microsoft.ApiManagement/service/backends

Designação Descrição Valor
Designação O nome do recurso string

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

X509CertificateName

Designação Descrição Valor
emissorCertificadoImpressão digital Impressão digital para o emissor do certificado. string
Designação Nome comum do certificado. string