Compartilhar via

Backend - Create Or Update

Serviço:
API Management
Versão da API:
2024-05-01

Cria ou atualiza um back-end.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}?api-version=2024-05-01

Parâmetros de URI

Nome Em Obrigatório Tipo Description
backendId
 path True

string

minLength: 1
maxLength: 80

Identificador da entidade back-end. Deve ser exclusivo na instância atual do serviço de Gerenciamento de API.
resourceGroupName
 path True

string

minLength: 1
maxLength: 90

O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
serviceName
 path True

string

minLength: 1
maxLength: 50
pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

O nome do serviço de Gerenciamento de API.
subscriptionId
 path True

string (uuid)

A ID da assinatura de destino. O valor deve ser uma UUID.
api-version
 query True

string

minLength: 1

A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome Obrigatório Tipo Description
If-Match

string

ETag da Entidade. Não é necessário ao criar uma entidade, mas necessário ao atualizar uma entidade.

Corpo da solicitação

Nome Tipo Description
properties.circuitBreaker

BackendCircuitBreaker

Configuração do disjuntor de back-end
properties.credentials

BackendCredentialsContract

Propriedades do contrato de credenciais de back-end
properties.description

string

minLength: 1
maxLength: 2000

Descrição do back-end.
properties.pool

Pool

properties.properties

BackendProperties

Contrato de propriedades de back-end
properties.protocol

BackendProtocol

Protocolo de comunicação de back-end. Obrigatório quando o tipo de back-end é 'Único'.
properties.proxy

BackendProxyContract

Propriedades do contrato do gateway de back-end
properties.resourceId

string

minLength: 1
maxLength: 2000

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.
properties.title

string

minLength: 1
maxLength: 300

Título de back-end.
properties.tls

BackendTlsProperties

Propriedades do TLS de back-end
properties.type

BackendType

Tipo de back-end. Um back-end pode ser Único ou Pool.
properties.url

string

minLength: 1
maxLength: 2000

Url de runtime do back-end. Obrigatório quando o tipo de back-end é 'Único'.

Respostas

Nome Tipo Description
200 OK

BackendContract

O back-end existente foi atualizado com êxito.

Cabeçalhos

ETag: string
201 Created

BackendContract

O back-end foi criado com êxito.

Cabeçalhos

ETag: string
Other Status Codes

ErrorResponse

Resposta de erro que descreve por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome Description
user_impersonation representar sua conta de usuário

Exemplos

ApiManagementCreateBackendProxyBackend
ApiManagementCreateBackendServiceFabric
ApiManagementCreateBackendWithPriorityBasedLoadBalancer
ApiManagementCreateBackendWithSimpleLoadBalancer
ApiManagementCreateBackendWithWeightedLoadBalancer

ApiManagementCreateBackendProxyBackend

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend?api-version=2024-05-01

{
  "properties": {
    "description": "description5308",
    "url": "https://backendname2644/",
    "protocol": "http",
    "tls": {
      "validateCertificateChain": true,
      "validateCertificateName": true
    },
    "proxy": {
      "url": "http://192.168.1.1:8080",
      "username": "Contoso\\admin",
      "password": "<password>"
    },
    "credentials": {
      "query": {
        "sv": [
          "xx",
          "bb",
          "cc"
        ]
      },
      "header": {
        "x-my-1": [
          "val1",
          "val2"
        ]
      },
      "authorization": {
        "scheme": "Basic",
        "parameter": "opensesma"
      }
    }
  }
}

Resposta de exemplo

Código de status:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "proxybackend",
  "properties": {
    "description": "description5308",
    "url": "https://backendname2644/",
    "protocol": "http",
    "credentials": {
      "query": {
        "sv": [
          "xx",
          "bb",
          "cc"
        ]
      },
      "header": {
        "x-my-1": [
          "val1",
          "val2"
        ]
      },
      "authorization": {
        "scheme": "Basic",
        "parameter": "opensesma"
      }
    },
    "proxy": {
      "url": "http://192.168.1.1:8080",
      "username": "Contoso\\admin",
      "password": "<password>"
    },
    "tls": {
      "validateCertificateChain": false,
      "validateCertificateName": false
    }
  }
}
Código de status:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "proxybackend",
  "properties": {
    "description": "description5308",
    "url": "https://backendname2644/",
    "protocol": "http",
    "credentials": {
      "query": {
        "sv": [
          "xx",
          "bb",
          "cc"
        ]
      },
      "header": {
        "x-my-1": [
          "val1",
          "val2"
        ]
      },
      "authorization": {
        "scheme": "Basic",
        "parameter": "opensesma"
      }
    },
    "proxy": {
      "url": "http://192.168.1.1:8080",
      "username": "Contoso\\admin",
      "password": "<password>"
    },
    "tls": {
      "validateCertificateChain": false,
      "validateCertificateName": false
    }
  }
}

ApiManagementCreateBackendServiceFabric

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend?api-version=2024-05-01

{
  "properties": {
    "description": "Service Fabric Test App 1",
    "protocol": "http",
    "url": "fabric:/mytestapp/mytestservice",
    "properties": {
      "serviceFabricCluster": {
        "managementEndpoints": [
          "https://somecluster.com"
        ],
        "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
        "serverX509Names": [
          {
            "name": "ServerCommonName1",
            "issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
          }
        ],
        "maxPartitionResolutionRetries": 5
      }
    }
  }
}

Resposta de exemplo

Código de status:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "sfbackend",
  "properties": {
    "description": "Service Fabric Test App 1",
    "url": "fabric:/mytestapp/mytestservice",
    "protocol": "http",
    "properties": {
      "serviceFabricCluster": {
        "managementEndpoints": [
          "https://somecluster.com"
        ],
        "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
        "serverX509Names": [
          {
            "name": "ServerCommonName1",
            "issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
          }
        ],
        "maxPartitionResolutionRetries": 5
      }
    }
  }
}
Código de status:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "sfbackend",
  "properties": {
    "description": "Service Fabric Test App 1",
    "url": "fabric:/mytestapp/mytestservice",
    "protocol": "http",
    "properties": {
      "serviceFabricCluster": {
        "managementEndpoints": [
          "https://somecluster.com"
        ],
        "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
        "serverX509Names": [
          {
            "name": "ServerCommonName1",
            "issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
          }
        ],
        "maxPartitionResolutionRetries": 5
      }
    }
  }
}

ApiManagementCreateBackendWithPriorityBasedLoadBalancer

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/priority-based-load-balancer?api-version=2024-05-01

{
  "properties": {
    "type": "Pool",
    "pool": {
      "services": [
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1",
          "priority": 1
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2",
          "priority": 1
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-3",
          "priority": 2
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-4",
          "priority": 2
        }
      ]
    }
  }
}

Resposta de exemplo

Código de status:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/priority-based-load-balancer",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "priority-based-load-balancer",
  "properties": {
    "title": null,
    "type": "Pool",
    "url": null,
    "protocol": null,
    "pool": {
      "services": [
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1",
          "priority": 1
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2",
          "priority": 1
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-3",
          "priority": 2
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-4",
          "priority": 2
        }
      ]
    }
  }
}
Código de status:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/priority-based-load-balancer",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "priority-based-load-balancer",
  "properties": {
    "title": null,
    "type": "Pool",
    "url": null,
    "protocol": null,
    "pool": {
      "services": [
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1",
          "priority": 1
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2",
          "priority": 1
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-3",
          "priority": 2
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-4",
          "priority": 2
        }
      ]
    }
  }
}

ApiManagementCreateBackendWithSimpleLoadBalancer

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/simple-load-balancer?api-version=2024-05-01

{
  "properties": {
    "type": "Pool",
    "pool": {
      "services": [
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1"
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2"
        }
      ]
    }
  }
}

Resposta de exemplo

Código de status:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/simple-load-balancer",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "simple-load-balancer",
  "properties": {
    "title": null,
    "type": "Pool",
    "url": null,
    "protocol": null,
    "pool": {
      "services": [
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1"
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2"
        }
      ]
    }
  }
}
Código de status:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/simple-load-balancer",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "simple-load-balancer",
  "properties": {
    "title": null,
    "type": "Pool",
    "url": null,
    "protocol": null,
    "pool": {
      "services": [
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1"
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2"
        }
      ]
    }
  }
}

ApiManagementCreateBackendWithWeightedLoadBalancer

Solicitação de exemplo

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/weighted-load-balancer?api-version=2024-05-01

{
  "properties": {
    "type": "Pool",
    "pool": {
      "services": [
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1",
          "weight": 75
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2",
          "weight": 25
        }
      ]
    }
  }
}

Resposta de exemplo

Código de status:
201 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/weighted-load-balancer",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "weighted-load-balancer",
  "properties": {
    "title": null,
    "type": "Pool",
    "url": null,
    "protocol": null,
    "pool": {
      "services": [
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1",
          "weight": 75
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2",
          "weight": 25
        }
      ]
    }
  }
}
Código de status:
200 
{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/weighted-load-balancer",
  "type": "Microsoft.ApiManagement/service/backends",
  "name": "weighted-load-balancer",
  "properties": {
    "title": null,
    "type": "Pool",
    "url": null,
    "protocol": null,
    "pool": {
      "services": [
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-1",
          "weight": 75
        },
        {
          "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/backend-2",
          "weight": 25
        }
      ]
    }
  }
}

Definições

Nome Description
BackendAuthorizationHeaderCredentials

Informações do cabeçalho de autorização.
BackendCircuitBreaker

A configuração do disjuntor de back-end
BackendContract

Detalhes do back-end.
BackendCredentialsContract

Detalhes das credenciais usadas para se conectar ao back-end.
BackendPoolItem

Informações de serviço do pool de back-end
BackendProperties

Propriedades específicas para o Tipo de Back-end.
BackendProtocol

Protocolo de comunicação de back-end. Obrigatório quando o tipo de back-end é 'Único'.
BackendProxyContract

Detalhes do servidor WebProxy de back-end a ser usado na solicitação de back-end.
BackendServiceFabricClusterProperties

Propriedades do back-end de tipo do Service Fabric.
BackendTlsProperties

Propriedades que controlam a validação de certificado TLS.
BackendType

Tipo de back-end. Um back-end pode ser Único ou Pool.
CircuitBreakerFailureCondition

As condições de viagem do disjuntor
CircuitBreakerRule

Configuração de regra para tripar o back-end.
ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail

O detalhe do erro.
ErrorResponse

Resposta de erro
FailureStatusCodeRange

O intervalo de códigos de status http de falha
Pool
X509CertificateName

Propriedades do servidor X509Names.

BackendAuthorizationHeaderCredentials

Objeto

Informações do cabeçalho de autorização.

Nome Tipo Description
parameter

string

minLength: 1
maxLength: 300

Valor do parâmetro de autenticação.
scheme

string

minLength: 1
maxLength: 100

Nome do Esquema de Autenticação.

BackendCircuitBreaker

Objeto

A configuração do disjuntor de back-end

Nome Tipo Description
rules

CircuitBreakerRule[]

As regras para tropeçar no back-end.

BackendContract

Objeto

Detalhes do back-end.

Nome Tipo Description
id

string

ID de recurso totalmente qualificada para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

O nome do recurso
properties.circuitBreaker

BackendCircuitBreaker

Configuração do disjuntor de back-end
properties.credentials

BackendCredentialsContract

Propriedades do contrato de credenciais de back-end
properties.description

string

minLength: 1
maxLength: 2000

Descrição do back-end.
properties.pool

Pool

properties.properties

BackendProperties

Contrato de propriedades de back-end
properties.protocol

BackendProtocol

Protocolo de comunicação de back-end. Obrigatório quando o tipo de back-end é 'Único'.
properties.proxy

BackendProxyContract

Propriedades do contrato do gateway de back-end
properties.resourceId

string

minLength: 1
maxLength: 2000

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.
properties.title

string

minLength: 1
maxLength: 300

Título de back-end.
properties.tls

BackendTlsProperties

Propriedades do TLS de back-end
properties.type

BackendType

Tipo de back-end. Um back-end pode ser Único ou Pool.
properties.url

string

minLength: 1
maxLength: 2000

Url de runtime do back-end. Obrigatório quando o tipo de back-end é 'Único'.
type

string

O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Objeto

Detalhes das credenciais usadas para se conectar ao back-end.

Nome Tipo Description
authorization

BackendAuthorizationHeaderCredentials

Autenticação de cabeçalho de autorização
certificate

string[]

Lista de impressões digitais do certificado do cliente. Serão ignorados se certificatesIds forem fornecidos.
certificateIds

string[]

Lista de IDs de certificado do cliente.
header

object

Descrição do parâmetro de cabeçalho.
query

object

Descrição do parâmetro de consulta.

BackendPoolItem

Objeto

Informações de serviço do pool de back-end

Nome Tipo Description
id

string (arm-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.
priority

integer (int32)

minimum: 0
maximum: 100

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

integer (int32)

minimum: 0
maximum: 100

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.

BackendProperties

Objeto

Propriedades específicas para o Tipo de Back-end.

Nome Tipo Description
serviceFabricCluster

BackendServiceFabricClusterProperties

Propriedades do cluster do Service Fabric de back-end

BackendProtocol

Enumeração

Protocolo de comunicação de back-end. Obrigatório quando o tipo de back-end é 'Único'.

Valor Description
http

O back-end é um serviço RESTful.
soap

O back-end é um serviço SOAP.

BackendProxyContract

Objeto

Detalhes do servidor WebProxy de back-end a ser usado na solicitação de back-end.

Nome Tipo Description
password

string

Senha para se conectar ao Servidor WebProxy
url

string

minLength: 1
maxLength: 2000

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

string

Nome de usuário para se conectar ao servidor WebProxy

BackendServiceFabricClusterProperties

Objeto

Propriedades do back-end de tipo do Service Fabric.

Nome Tipo Description
clientCertificateId

string

A ID do certificado do cliente para o ponto de extremidade de gerenciamento.
clientCertificatethumbprint

string

A impressão digital do certificado do cliente para o ponto de extremidade de gerenciamento. Serão ignorados se certificatesIds forem fornecidos
managementEndpoints

string[]

O ponto de extremidade de gerenciamento do cluster.
maxPartitionResolutionRetries

integer (int32)

Número máximo de repetições ao tentar resolver a partição.
serverCertificateThumbprints

string[]

Impressões digitais do serviço de gerenciamento de cluster de certificados usa para comunicação tls
serverX509Names

X509CertificateName[]

Coleção de nomes de certificado X509 do servidor

BackendTlsProperties

Objeto

Propriedades que controlam a validação de certificado TLS.

Nome Tipo Valor padrão Description
validateCertificateChain

boolean

True

Sinalizador indicando se a validação da cadeia de certificados SSL deve ser feita ao usar certificados autoassinados para esse host de back-end.
validateCertificateName

boolean

True

Sinalizador indicando se a validação do nome do certificado SSL deve ser feita ao usar certificados autoassinados para esse host de back-end.

BackendType

Enumeração

Tipo de back-end. Um back-end pode ser Único ou Pool.

Valor Description
Single

dá suporte a back-end único
Pool

dá suporte ao back-end do pool

CircuitBreakerFailureCondition

Objeto

As condições de viagem do disjuntor

Nome Tipo Description
count

integer (int64)

O limite para abrir o circuito.
errorReasons

string[]

maxLength: 200

Os motivos de erro que são considerados como falha.
interval

string (duration)

O intervalo durante o qual as falhas são contadas.
percentage

integer (int64)

O limite para abrir o circuito.
statusCodeRanges

FailureStatusCodeRange[]

Os intervalos de código de status considerados como falha.

CircuitBreakerRule

Objeto

Configuração de regra para tripar o back-end.

Nome Tipo Description
acceptRetryAfter

boolean

sinalizador para aceitar Retry-After cabeçalho do back-end.
failureCondition

CircuitBreakerFailureCondition

As condições para despir o disjuntor.
name

string

O nome da regra.
tripDuration

string (duration)

A duração para a qual o circuito será tropeçado.

ErrorAdditionalInfo

Objeto

As informações adicionais do erro de gerenciamento de recursos.

Nome Tipo Description
info

object

As informações adicionais.
type

string

O tipo de informação adicional.

ErrorDetail

Objeto

O detalhe do erro.

Nome Tipo Description
additionalInfo

ErrorAdditionalInfo[]

As informações adicionais do erro.
code

string

O código de erro.
details

ErrorDetail[]

Os detalhes do erro.
message

string

A mensagem de erro.
target

string

O destino do erro.

ErrorResponse

Objeto

Resposta de erro

Nome Tipo Description
error

ErrorDetail

O objeto de erro.

FailureStatusCodeRange

Objeto

O intervalo de códigos de status http de falha

Nome Tipo Description
max

integer (int32)

minimum: 200
maximum: 599

O código de status http máximo.
min

integer (int32)

minimum: 200
maximum: 599

O código de status http mínimo.

Pool

Objeto
Nome Tipo Description
services

BackendPoolItem[]

A lista de entidades de back-end que pertencem a um pool.

X509CertificateName

Objeto

Propriedades do servidor X509Names.

Nome Tipo Description
issuerCertificateThumbprint

string

Impressão digital para o emissor do certificado.
name

string

Nome comum do certificado.