Serviço/back-ends Microsoft.ApiManagement 2024-05-01
- última
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
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@2024-05-01' = {
parent: resourceSymbolicName
name: 'string'
properties: {
circuitBreaker: {
rules: [
{
acceptRetryAfter: bool
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'
priority: int
weight: int
}
]
}
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
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) |
BackendBaseParametersPool
Nome | Descrição | Valor |
---|---|---|
Serviços | A lista de entidades de back-end que pertencem a um pool. | BackendPoolItem [] |
BackendCircuitBreaker
Nome | Descrição | Valor |
---|---|---|
réguas | As regras para tropeçar no back-end. | CircuitBreakerRule [] |
BackendContractProperties
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 |
---|
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) |
prioridade | A prioridade da entidade de back-end no pool de back-end. Deve estar entre 0 e 100. Ele também poderá ser nulo se o valor não for especificado. | int Restrições: Valor mínimo = 0 Valor máximo = 100 |
peso | O peso da entidade de back-end no pool de back-end. Deve estar entre 0 e 100. Ele também poderá ser nulo se o valor não for especificado. | int Restrições: Valor mínimo = 0 Valor máximo = 100 |
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
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 |
---|---|---|
acceptRetryAfter | sinalizador para aceitar Retry-After cabeçalho do back-end. | Bool |
failureCondition | As condições para despir o disjuntor. | |
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:
- 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": "2024-05-01",
"name": "string",
"properties": {
"circuitBreaker": {
"rules": [
{
"acceptRetryAfter": "bool",
"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",
"priority": "int",
"weight": "int"
}
]
},
"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
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) |
BackendBaseParametersPool
Nome | Descrição | Valor |
---|---|---|
Serviços | A lista de entidades de back-end que pertencem a um pool. | BackendPoolItem [] |
BackendCircuitBreaker
Nome | Descrição | Valor |
---|---|---|
réguas | As regras para tropeçar no back-end. | CircuitBreakerRule [] |
BackendContractProperties
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 |
---|
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) |
prioridade | A prioridade da entidade de back-end no pool de back-end. Deve estar entre 0 e 100. Ele também poderá ser nulo se o valor não for especificado. | int Restrições: Valor mínimo = 0 Valor máximo = 100 |
peso | O peso da entidade de back-end no pool de back-end. Deve estar entre 0 e 100. Ele também poderá ser nulo se o valor não for especificado. | int Restrições: Valor mínimo = 0 Valor máximo = 100 |
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
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 |
---|---|---|
acceptRetryAfter | sinalizador para aceitar Retry-After cabeçalho do back-end. | Bool |
failureCondition | As condições para despir o disjuntor. | |
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
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@2024-05-01"
name = "string"
body = jsonencode({
properties = {
circuitBreaker = {
rules = [
{
acceptRetryAfter = bool
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"
priority = int
weight = int
}
]
}
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
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) |
BackendBaseParametersPool
Nome | Descrição | Valor |
---|---|---|
Serviços | A lista de entidades de back-end que pertencem a um pool. | BackendPoolItem [] |
BackendCircuitBreaker
Nome | Descrição | Valor |
---|---|---|
réguas | As regras para tropeçar no back-end. | CircuitBreakerRule [] |
BackendContractProperties
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 |
---|
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) |
prioridade | A prioridade da entidade de back-end no pool de back-end. Deve estar entre 0 e 100. Ele também poderá ser nulo se o valor não for especificado. | int Restrições: Valor mínimo = 0 Valor máximo = 100 |
peso | O peso da entidade de back-end no pool de back-end. Deve estar entre 0 e 100. Ele também poderá ser nulo se o valor não for especificado. | int Restrições: Valor mínimo = 0 Valor máximo = 100 |
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
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 |
---|---|---|
acceptRetryAfter | sinalizador para aceitar Retry-After cabeçalho do back-end. | Bool |
failureCondition | As condições para despir o disjuntor. | |
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@2024-05-01" |
X509CertificateName
Nome | Descrição | Valor |
---|---|---|
issuerCertificateThumbprint | Impressão digital para o emissor do certificado. | corda |
nome | Nome comum do certificado. | corda |