Backend - Update

Atualiza um backend existente.

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

Parâmetros do URI

Name In Required Type Description
backendId
path True
  • string

Identificador da entidade Backend. Deve ser único na atual instância de serviço de Gestão da API.

resourceGroupName
path True
  • string

O nome do grupo de recursos.

serviceName
path True
  • string

O nome do serviço de Gestão da API.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True
  • string

Credenciais de subscrição que identificam exclusivamente Microsoft Azure subscrição. O ID de subscrição faz parte do URI para cada chamada de serviço.

api-version
query True
  • string

Versão da API a ser usada com o pedido do cliente.

Cabeçalho do Pedido

Name Required Type Description
If-Match True
  • string

ETag da Entidade. O ETag deve coincidir com o estado da entidade atual a partir da resposta do cabeçalho do pedido GET ou deve ser * para atualização incondicional.

Corpo do Pedido

Name Type Description
properties.credentials

Propriedades contratuais de credenciais de backend

properties.description
  • string

Descrição do backend.

properties.properties

Contrato de Backend Properties

properties.protocol

Protocolo de comunicação de backend.

properties.proxy

Propriedades do contrato de procuração de backend

properties.resourceId
  • string

Gestão Uri do Recurso no Sistema Externo. Este url pode ser o Id de Recursos de Braço de Apps Lógicas, Apps de Função ou aplicações Api.

properties.title
  • string

Título de backend.

properties.tls

Propriedades Backend TLS

properties.url
  • string

Url de tempo de execução do Backend.

Respostas

Name Type Description
200 OK

O backend existente foi atualizado com sucesso.

Headers

  • ETag: string
Other Status Codes

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

Segurança

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

ApiManagementUpdateBackend

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend?api-version=2020-06-01-preview
If-Match: *
{
  "properties": {
    "description": "description5308",
    "tls": {
      "validateCertificateChain": false,
      "validateCertificateName": true
    }
  }
}

Sample Response

{
  "id": "/subscriptions/subid/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

BackendAuthorizationHeaderCredentials

Informação de cabeçalho de autorização.

BackendContract

Detalhes de backend.

BackendCredentialsContract

Detalhes das credenciais usadas para ligar ao Backend.

BackendProperties

Propriedades específicas do Tipo Backend.

BackendProtocol

Protocolo de comunicação de backend.

BackendProxyContract

Detalhes do Backend WebProxy Server para utilizar no Pedido de Backend.

BackendServiceFabricClusterProperties

Propriedades do Service Fabric Tipo Backend.

BackendTlsProperties

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

BackendUpdateParameters

Parâmetros de atualização de backend.

ErrorFieldContract

Contrato de Campo de Erro.

ErrorResponse

Resposta de erro.

X509CertificateName

Propriedades do servidor X509Namames.

BackendAuthorizationHeaderCredentials

Informação de cabeçalho de autorização.

Name Type Description
parameter
  • string

Valor do parâmetro de autenticação.

scheme
  • string

Nome do Esquema de Autenticação.

BackendContract

Detalhes de backend.

Name Type Description
id
  • string

Identificação de recursos.

name
  • string

Nome de recurso.

properties.credentials

Propriedades contratuais de credenciais de backend

properties.description
  • string

Descrição do backend.

properties.properties

Contrato de Backend Properties

properties.protocol

Protocolo de comunicação de backend.

properties.proxy

Propriedades do contrato de procuração de backend

properties.resourceId
  • string

Gestão Uri do Recurso no Sistema Externo. Este url pode ser o Id de Recursos de Braço de Apps Lógicas, Apps de Função ou aplicações Api.

properties.title
  • string

Título de backend.

properties.tls

Propriedades Backend TLS

properties.url
  • string

Url de tempo de execução do Backend.

type
  • string

Tipo de recurso para recurso de Gestão API.

BackendCredentialsContract

Detalhes das credenciais usadas para ligar ao Backend.

Name Type Description
authorization

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

certificate
  • string[]

Lista de impressões digitais do certificado de cliente. Será ignorado se os certificados forem fornecidos.

certificateIds
  • string[]

Lista de identificações de certificados de cliente.

header
  • object

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

query
  • object

Descrição do parâmetro de consulta.

BackendProperties

Propriedades específicas do Tipo Backend.

Name Type Description
serviceFabricCluster

Propriedades de cluster de Service Fabric de backend

BackendProtocol

Protocolo de comunicação de backend.

Name Type Description
http
  • string

O Backend é um serviço RESTful.

soap
  • string

O Backend é um serviço SOAP.

BackendProxyContract

Detalhes do Backend WebProxy Server para utilizar no Pedido de Backend.

Name Type Description
password
  • string

Palavra-passe para ligar ao Servidor De Procuração Web

url
  • string

Propriedade AbsoluteUri do Servidor WebProxy que inclui todo o URI armazenado na instância Uri, incluindo todos os fragmentos e cadeias de consulta.

username
  • string

Nome de utilizador para ligar ao servidor WebProxy

BackendServiceFabricClusterProperties

Propriedades do Service Fabric Tipo Backend.

Name Type Description
clientCertificateId
  • string

O certificado de cliente identifica-se para o ponto final da gestão.

clientCertificatethumbprint
  • string

A impressão digital do certificado do cliente para o ponto final da gestão. Será ignorado se os certificados forem fornecidos

managementEndpoints
  • string[]

O ponto final de gestão de clusters.

maxPartitionResolutionRetries
  • integer

Número máximo de retração enquanto tenta resolver a partição.

serverCertificateThumbprints
  • string[]

Impressões digitais de certificados cluster management service usa para comunicação tls

serverX509Names

Coleção de nomes de certificados do servidor X509

BackendTlsProperties

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

Name Type Description
validateCertificateChain
  • boolean

A bandeira indica se a validação da cadeia de certificados SSL deve ser feita quando utilizar certificados auto-assinados para este hospedeiro de backend.

validateCertificateName
  • boolean

A bandeira indica se a validação do nome do certificado SSL deve ser feita quando utilizar certificados auto-assinados para este hospedeiro de backend.

BackendUpdateParameters

Parâmetros de atualização de backend.

Name Type Description
properties.credentials

Propriedades contratuais de credenciais de backend

properties.description
  • string

Descrição do backend.

properties.properties

Contrato de Backend Properties

properties.protocol

Protocolo de comunicação de backend.

properties.proxy

Propriedades do contrato de procuração de backend

properties.resourceId
  • string

Gestão Uri do Recurso no Sistema Externo. Este url pode ser o Id de Recursos de Braço de Apps Lógicas, Apps de Função ou aplicações Api.

properties.title
  • string

Título de backend.

properties.tls

Propriedades Backend TLS

properties.url
  • string

Url de tempo de execução do Backend.

ErrorFieldContract

Contrato de Campo de Erro.

Name Type Description
code
  • string

Código de erro de nível de propriedade.

message
  • string

Representação legível pelo homem de erro de nível de propriedade.

target
  • string

Nome da propriedade.

ErrorResponse

Resposta de erro.

Name Type Description
error.code
  • string

Código de erro definido pelo serviço. Este código serve como sub-estado para o código de erro HTTP especificado na resposta.

error.details

A lista de campos inválidos envia a pedido, em caso de erro de validação.

error.message
  • string

Representação legível pelo erro.

X509CertificateName

Propriedades do servidor X509Namames.

Name Type Description
issuerCertificateThumbprint
  • string

Impressão digital para o emitente do certificado.

name
  • string

Nome comum do certificado.