Serviço/back-ends Microsoft.ApiManagement 2022-08-01

Artigo
07/24/2024

Definição de recurso do Bicep

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

Grupos de recursos - Consulte comandos de implantação do grupo 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 Bicep a seguir ao modelo.

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

service/back-ends

Nome	Descrição	Valor
nome	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: Alfanuméricos e hifens. Comece com letra e termine com 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 do recurso do tipo: de serviço
Propriedades	Propriedades do contrato de entidade de back-end.	BackendContractProperties

BackendContractProperties

Nome	Descrição	Valor
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 = 2000
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 = 2000
título	Título de back-end.	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 300
tls	Propriedades do TLS de back-end	back-endTlsProperties
url	Url de runtime do back-end.	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000

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[] Restrições: Comprimento máximo = 32
certificateIds	Lista de IDs de certificado do cliente.	string[] Restrições: Comprimento máximo = 32
cabeçalho	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) Restrições: Comprimento mínimo = 1 Comprimento máximo = 300
esquema	Nome do Esquema de Autenticação.	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 100

BackendCredentialsContractHeader

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

BackendCredentialsContractQuery

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

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.	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 []

X509CertificateName

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

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.	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000
nome de usuário	Nome de usuário para se conectar ao servidor WebProxy	corda

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

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:

Grupos de recursos - Consulte comandos de implantação do grupo 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 JSON a seguir ao modelo.

{
  "type": "Microsoft.ApiManagement/service/backends",
  "apiVersion": "2022-08-01",
  "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

service/back-ends

Nome	Descrição	Valor
tipo	O tipo de recurso	'Microsoft.ApiManagement/service/backends'
apiVersion	A versão da API do recurso	'2022-08-01'
nome	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: Alfanuméricos e hifens. Comece com letra e termine com alfanumérico.
Propriedades	Propriedades do contrato de entidade de back-end.	BackendContractProperties

BackendContractProperties

Nome	Descrição	Valor
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 = 2000
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 = 2000
título	Título de back-end.	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 300
tls	Propriedades do TLS de back-end	back-endTlsProperties
url	Url de runtime do back-end.	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000

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[] Restrições: Comprimento máximo = 32
certificateIds	Lista de IDs de certificado do cliente.	string[] Restrições: Comprimento máximo = 32
cabeçalho	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) Restrições: Comprimento mínimo = 1 Comprimento máximo = 300
esquema	Nome do Esquema de Autenticação.	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 100

BackendCredentialsContractHeader

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

BackendCredentialsContractQuery

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

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.	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 []

X509CertificateName

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

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.	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000
nome de usuário	Nome de usuário para se conectar ao servidor WebProxy	corda

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

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@2022-08-01"
  name = "string"
  parent_id = "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

service/back-ends

Nome	Descrição	Valor
tipo	O tipo de recurso	"Microsoft.ApiManagement/service/backends@2022-08-01"
nome	O nome do recurso	cadeia de caracteres (obrigatório) Limite de caracteres: 1 a 80 Caracteres válidos: Alfanuméricos e hifens. Comece com letra e termine com alfanumérico.
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

BackendContractProperties

Nome	Descrição	Valor
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 = 2000
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 = 2000
título	Título de back-end.	corda Restrições: Comprimento mínimo = 1 Comprimento máximo = 300
tls	Propriedades do TLS de back-end	back-endTlsProperties
url	Url de runtime do back-end.	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000

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[] Restrições: Comprimento máximo = 32
certificateIds	Lista de IDs de certificado do cliente.	string[] Restrições: Comprimento máximo = 32
cabeçalho	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) Restrições: Comprimento mínimo = 1 Comprimento máximo = 300
esquema	Nome do Esquema de Autenticação.	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 100

BackendCredentialsContractHeader

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

BackendCredentialsContractQuery

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

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.	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 []

X509CertificateName

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

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.	cadeia de caracteres (obrigatório) Restrições: Comprimento mínimo = 1 Comprimento máximo = 2000
nome de usuário	Nome de usuário para se conectar ao servidor WebProxy	corda

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

Compartilhar via

Serviço/back-ends Microsoft.ApiManagement 2022-08-01

Definição de recurso do Bicep

Formato de recurso

Valores de propriedade

service/back-ends

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterProperties

X509CertificateName

BackendProxyContract

BackendTlsProperties

Definição de recurso de modelo do ARM

Formato de recurso

Valores de propriedade

service/back-ends

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterProperties

X509CertificateName

BackendProxyContract

BackendTlsProperties

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

Formato de recurso

Valores de propriedade

service/back-ends

BackendContractProperties

BackendCredentialsContract

BackendAuthorizationHeaderCredentials

BackendCredentialsContractHeader

BackendCredentialsContractQuery

BackendProperties

BackendServiceFabricClusterProperties

X509CertificateName

BackendProxyContract

BackendTlsProperties

Comentários

Recursos adicionais