Backend - Update

Serviço:: API Management

Versão da API:: 2024-05-01

Atualiza um back-end existente.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
backendId	path	True	string minLength: 1 maxLength: 80	Identificador da entidade Back-end. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual.
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 um UUID.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-Match	True	string	ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação GET ou deve ser * para atualização incondicional.

Corpo do Pedido

Name	Tipo	Description
properties.circuitBreaker	BackendCircuitBreaker	Configuração do disjuntor 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. Necessá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 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.
properties.title	string minLength: 1 maxLength: 300	Título de back-end.
properties.tls	BackendTlsProperties	Propriedades TLS de back-end
properties.type	BackendType	Tipo de back-end. Um back-end pode ser Single ou Pool.
properties.url	string minLength: 1 maxLength: 2000	url de tempo de execução do back-end. Necessário quando o tipo de back-end é 'Único'.

Respostas

Name	Tipo	Description
200 OK	BackendContract	O back-end existente foi atualizado com êxito. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Name

Tipo

Description

200 OK

BackendContract

O back-end existente foi atualizado com êxito.

Cabeçalhos

ETag: string

Other Status Codes

ErrorResponse

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

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ApiManagementUpdateBackend

Pedido de amostra

HTTP

PATCH 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",
    "tls": {
      "validateCertificateChain": false,
      "validateCertificateName": true
    }
  }
}

Resposta da amostra

Código de estado:: 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": true
    }
  }
}

Definições

Name	Description
BackendAuthorizationHeaderCredentials	Informações do cabeçalho de autorização.
BackendCircuitBreaker	A configuração do disjuntor back-end
BackendContract	Detalhes do back-end.
BackendCredentialsContract	Detalhes das credenciais usadas para se conectar ao back-end.
BackendPoolItem	Informações sobre o serviço de pool de back-end
BackendProperties	Propriedades específicas para o tipo de back-end.
BackendProtocol	Protocolo de comunicação de back-end. Necessá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 do tipo Service Fabric.
BackendTlsProperties	Propriedades que controlam a Validação de Certificado TLS.
BackendType	Tipo de back-end. Um back-end pode ser Single ou Pool.
BackendUpdateParameters	Parâmetros de atualização de back-end.
CircuitBreakerFailureCondition	As condições de disparo do disjuntor
CircuitBreakerRule	Configuração de regra para tropeçar no back-end.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
FailureStatusCodeRange	O intervalo de código de status http de falha
Pool
X509CertificateName	Propriedades do servidor X509Names.

BackendAuthorizationHeaderCredentials

Object

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

Name	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

Object

A configuração do disjuntor back-end

Name	Tipo	Description
rules	CircuitBreakerRule[]	As regras para tropeçar no backend.

BackendContract

Object

Detalhes do back-end.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado 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 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. Necessá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 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.
properties.title	string minLength: 1 maxLength: 300	Título de back-end.
properties.tls	BackendTlsProperties	Propriedades TLS de back-end
properties.type	BackendType	Tipo de back-end. Um back-end pode ser Single ou Pool.
properties.url	string minLength: 1 maxLength: 2000	url de tempo de execução do back-end. Necessário quando o tipo de back-end é 'Único'.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Object

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

Name	Tipo	Description
authorization	BackendAuthorizationHeaderCredentials	Autenticação de cabeçalho de autorização
certificate	string[]	Lista de impressões digitais de certificados de cliente. Será ignorado se certificatesIds forem fornecidos.
certificateIds	string[]	Lista de IDs de certificado de cliente.
header	object	Descrição do parâmetro do cabeçalho.
query	object	Descrição do parâmetro de consulta.

BackendPoolItem

Object

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

Name	Tipo	Description
id	string (arm-id)	O ID ARM exclusivo da entidade de back-end. O ID ARM deve referir-se 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. Também pode 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. Também pode ser nulo se o valor não for especificado.

BackendProperties

Object

Propriedades específicas para o tipo de back-end.

Name	Tipo	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	Propriedades do cluster do Backend Service Fabric

BackendProtocol

Enumeração

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

Valor	Description
http	O Backend é um serviço RESTful.
soap	O Backend é um serviço SOAP.

BackendProxyContract

Object

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

Name	Tipo	Description
password	string	Senha para se conectar ao WebProxy Server
url	string minLength: 1 maxLength: 2000	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.
username	string	Nome de usuário para se conectar ao servidor WebProxy

BackendServiceFabricClusterProperties

Object

Propriedades do back-end do tipo Service Fabric.

Name	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á ignorado se certificatesIds forem fornecidos
managementEndpoints	string[]	O ponto de extremidade de gerenciamento de cluster.
maxPartitionResolutionRetries	integer (int32)	Número máximo de tentativas ao tentar resolver a partição.
serverCertificateThumbprints	string[]	Impressões digitais de certificados que o serviço de gerenciamento de cluster usa para comunicação tls
serverX509Names	X509CertificateName[]	Coleção de Nomes de Certificados X509 do Servidor

BackendTlsProperties

Object

Propriedades que controlam a Validação de Certificado TLS.

Name	Tipo	Default value	Description
validateCertificateChain	boolean	True	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.
validateCertificateName	boolean	True	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.

BackendType

Enumeração

Tipo de back-end. Um back-end pode ser Single ou Pool.

Valor	Description
Single	suporta back-end único
Pool	suporta back-end de pool

BackendUpdateParameters

Object

Parâmetros de atualização de back-end.

Name	Tipo	Description
properties.circuitBreaker	BackendCircuitBreaker	Configuração do disjuntor 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. Necessá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 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.
properties.title	string minLength: 1 maxLength: 300	Título de back-end.
properties.tls	BackendTlsProperties	Propriedades TLS de back-end
properties.type	BackendType	Tipo de back-end. Um back-end pode ser Single ou Pool.
properties.url	string minLength: 1 maxLength: 2000	url de tempo de execução do back-end. Necessário quando o tipo de back-end é 'Único'.

CircuitBreakerFailureCondition

Object

As condições de disparo do disjuntor

Name	Tipo	Description
count	integer (int64)	O limiar para abrir o circuito.
errorReasons	string[] maxLength: 200	As razões do erro que são consideradas como falha.
interval	string (duration)	O intervalo durante o qual as falhas são contadas.
percentage	integer (int64)	O limiar para abrir o circuito.
statusCodeRanges	FailureStatusCodeRange[]	Os intervalos de código de status que são considerados como falha.

CircuitBreakerRule

Object

Configuração de regra para tropeçar no back-end.

Name	Tipo	Description
acceptRetryAfter	boolean	sinalizar para aceitar Retry-After cabeçalho do back-end.
failureCondition	CircuitBreakerFailureCondition	As condições para acionar o disjuntor.
name	string	O nome da regra.
tripDuration	string (duration)	A duração durante a qual o circuito será percorrido.

ErrorAdditionalInfo

Object

O erro de gerenciamento de recursos informações adicionais.

Name	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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

Object

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

FailureStatusCodeRange

Object

O intervalo de código de status http de falha

Name	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

Object

Name	Tipo	Description
services	BackendPoolItem[]	A lista de entidades de back-end pertencentes a um pool.

X509CertificateName

Object

Propriedades do servidor X509Names.

Name	Tipo	Description
issuerCertificateThumbprint	string	Impressão digital para o emissor do certificado.
name	string	Nome comum do certificado.

Partilhar via

Backend - Update

Parâmetros do URI

Cabeçalho do Pedido

Corpo do Pedido

Respostas

Segurança

azure_auth

Âmbitos

Exemplos

ApiManagementUpdateBackend

Pedido de amostra

Resposta da amostra

Definições

BackendAuthorizationHeaderCredentials

BackendCircuitBreaker

BackendContract

BackendCredentialsContract

BackendPoolItem

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

BackendType

BackendUpdateParameters

CircuitBreakerFailureCondition

CircuitBreakerRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailureStatusCodeRange

Pool

X509CertificateName