Backend - Update

Riferimento

Servizio:: API Management

Versione API:: 2024-05-01

Aggiorna un back-end esistente.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
backendId	path	True	string minLength: 1 maxLength: 80	Identificatore dell'entità back-end. Deve essere univoco nell'istanza corrente del servizio Gestione API.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nome del servizio Gestione API.
subscriptionId	path	True	string (uuid)	ID della sottoscrizione di destinazione. Il valore deve essere un UUID.
api-version	query	True	string minLength: 1	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-Match	True	string	ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta dell'intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.circuitBreaker	BackendCircuitBreaker	Configurazione dell'interruttore back-end
properties.credentials	BackendCredentialsContract	Proprietà del contratto credenziali back-end
properties.description	string minLength: 1 maxLength: 2000	Descrizione back-end.
properties.pool	Pool
properties.properties	BackendProperties	Contratto proprietà back-end
properties.protocol	BackendProtocol	Protocollo di comunicazione back-end.
properties.proxy	BackendProxyContract	Proprietà del contratto del gateway back-end
properties.resourceId	string minLength: 1 maxLength: 2000	URI di gestione della risorsa nel sistema esterno. Questo URL può essere l'ID risorsa arm di App per la logica, app per le funzioni o app per le API.
properties.title	string minLength: 1 maxLength: 300	Titolo back-end.
properties.tls	BackendTlsProperties	Proprietà TLS back-end
properties.type	BackendType	Tipo del back-end. Un back-end può essere singolo o pool.
properties.url	string minLength: 1 maxLength: 2000	URL di runtime del back-end.

Risposte

Nome	Tipo	Descrizione
200 OK	BackendContract	Il back-end esistente è stato aggiornato correttamente. Intestazioni ETag: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

BackendContract

Il back-end esistente è stato aggiornato correttamente.

Intestazioni

ETag: string

Other Status Codes

ErrorResponse

Risposta di errore che descrive il motivo per cui l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementUpdateBackend

Esempio di richiesta

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
    }
  }
}

Risposta di esempio

Codice di stato:: 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
    }
  }
}

Definizioni

Nome	Descrizione
BackendAuthorizationHeaderCredentials	Informazioni sull'intestazione dell'autorizzazione.
BackendCircuitBreaker	Configurazione dell'interruttore back-end
BackendContract	Dettagli back-end.
BackendCredentialsContract	Dettagli delle credenziali usate per la connessione al back-end.
BackendPoolItem	Informazioni sul servizio pool back-end
BackendProperties	Proprietà specifiche del tipo back-end.
BackendProtocol	Protocollo di comunicazione back-end.
BackendProxyContract	Dettagli del server WebProxy back-end da usare nella richiesta al back-end.
BackendServiceFabricClusterProperties	Proprietà del back-end del tipo di Service Fabric.
BackendTlsProperties	Proprietà che controllano la convalida del certificato TLS.
BackendType	Tipo del back-end. Un back-end può essere singolo o pool.
BackendUpdateParameters	Parametri di aggiornamento back-end.
CircuitBreakerFailureCondition	Le condizioni di corsa del interruttore
CircuitBreakerRule	Configurazione della regola per eseguire il trip del back-end.
ErrorAdditionalInfo	Informazioni aggiuntive sull'errore di gestione delle risorse.
ErrorDetail	Dettagli dell'errore.
ErrorResponse	Risposta di errore
FailureStatusCodeRange	Intervallo di codici di stato HTTP non riuscito
Pool
X509CertificateName	Proprietà del server X509Names.

BackendAuthorizationHeaderCredentials

Object

Informazioni sull'intestazione dell'autorizzazione.

Nome	Tipo	Descrizione
parameter	string minLength: 1 maxLength: 300	Valore del parametro di autenticazione.
scheme	string minLength: 1 maxLength: 100	Nome schema di autenticazione.

BackendCircuitBreaker

Object

Configurazione dell'interruttore back-end

Nome	Tipo	Descrizione
rules	CircuitBreakerRule[]	Regole per il tripping del back-end.

BackendContract

Object

Dettagli back-end.

Nome	Tipo	Descrizione
id	string	ID risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	Nome della risorsa
properties.circuitBreaker	BackendCircuitBreaker	Configurazione dell'interruttore back-end
properties.credentials	BackendCredentialsContract	Proprietà del contratto credenziali back-end
properties.description	string minLength: 1 maxLength: 2000	Descrizione back-end.
properties.pool	Pool
properties.properties	BackendProperties	Contratto proprietà back-end
properties.protocol	BackendProtocol	Protocollo di comunicazione back-end.
properties.proxy	BackendProxyContract	Proprietà del contratto del gateway back-end
properties.resourceId	string minLength: 1 maxLength: 2000	URI di gestione della risorsa nel sistema esterno. Questo URL può essere l'ID risorsa arm di App per la logica, app per le funzioni o app per le API.
properties.title	string minLength: 1 maxLength: 300	Titolo back-end.
properties.tls	BackendTlsProperties	Proprietà TLS back-end
properties.type	BackendType	Tipo del back-end. Un back-end può essere singolo o pool.
properties.url	string minLength: 1 maxLength: 2000	URL di runtime del back-end.
type	string	Tipo della risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

Object

Dettagli delle credenziali usate per la connessione al back-end.

Nome	Tipo	Descrizione
authorization	BackendAuthorizationHeaderCredentials	Autenticazione dell'intestazione dell'autorizzazione
certificate	string[]	Elenco delle identificazioni personali del certificato client. Verrà ignorato se vengono forniti certificatesId.
certificateIds	string[]	Elenco di ID certificato client.
header	object	Descrizione del parametro di intestazione.
query	object	Descrizione del parametro di query.

BackendPoolItem

Object

Informazioni sul servizio pool back-end

Nome	Tipo	Descrizione
id	string (arm-id)	ID ARM univoco dell'entità back-end. L'ID ARM deve fare riferimento a un'entità back-end già esistente.
priority	integer (int32) minimum: 0 maximum: 100	Priorità dell'entità back-end nel pool back-end. Deve essere compreso tra 0 e 100. Può anche essere Null se il valore non specificato.
weight	integer (int32) minimum: 0 maximum: 100	Peso dell'entità back-end nel pool back-end. Deve essere compreso tra 0 e 100. Può anche essere Null se il valore non specificato.

BackendProperties

Object

Proprietà specifiche del tipo back-end.

Nome	Tipo	Descrizione
serviceFabricCluster	BackendServiceFabricClusterProperties	Proprietà del cluster back-end di Service Fabric

BackendProtocol

Enumerazione

Protocollo di comunicazione back-end.

Valore	Descrizione
http	Il back-end è un servizio RESTful.
soap	Il back-end è un servizio SOAP.

BackendProxyContract

Object

Dettagli del server WebProxy back-end da usare nella richiesta al back-end.

Nome	Tipo	Descrizione
password	string	Password per la connessione al server WebProxy
url	string minLength: 1 maxLength: 2000	Proprietà AbsoluteUri del server WebProxy che include l'intero URI archiviato nell'istanza Uri, inclusi tutti i frammenti e le stringhe di query.
username	string	Nome utente per la connessione al server WebProxy

BackendServiceFabricClusterProperties

Object

Proprietà del back-end del tipo di Service Fabric.

Nome	Tipo	Descrizione
clientCertificateId	string	ID certificato client per l'endpoint di gestione.
clientCertificatethumbprint	string	Identificazione personale del certificato client per l'endpoint di gestione. Verrà ignorato se vengono forniti certificatiId
managementEndpoints	string[]	Endpoint di gestione del cluster.
maxPartitionResolutionRetries	integer (int32)	Numero massimo di tentativi durante il tentativo di risolvere la partizione.
serverCertificateThumbprints	string[]	Identificazioni personali del servizio di gestione del cluster certificati usati per la comunicazione tls
serverX509Names	X509CertificateName[]	Raccolta nomi certificati server X509

BackendTlsProperties

Object

Proprietà che controllano la convalida del certificato TLS.

Nome	Tipo	Valore predefinito	Descrizione
validateCertificateChain	boolean	True	Flag che indica se la convalida della catena di certificati SSL deve essere eseguita quando si usano certificati autofirmato per questo host back-end.
validateCertificateName	boolean	True	Flag che indica se la convalida del nome del certificato SSL deve essere eseguita quando si usano certificati autofirmato per questo host back-end.

BackendType

Enumerazione

Tipo del back-end. Un back-end può essere singolo o pool.

Valore	Descrizione
Pool	supporta il back-end del pool
Single	supporta un singolo back-end

BackendUpdateParameters

Object

Parametri di aggiornamento back-end.

Nome	Tipo	Descrizione
properties.circuitBreaker	BackendCircuitBreaker	Configurazione dell'interruttore back-end
properties.credentials	BackendCredentialsContract	Proprietà del contratto credenziali back-end
properties.description	string minLength: 1 maxLength: 2000	Descrizione back-end.
properties.pool	Pool
properties.properties	BackendProperties	Contratto proprietà back-end
properties.protocol	BackendProtocol	Protocollo di comunicazione back-end.
properties.proxy	BackendProxyContract	Proprietà del contratto del gateway back-end
properties.resourceId	string minLength: 1 maxLength: 2000	URI di gestione della risorsa nel sistema esterno. Questo URL può essere l'ID risorsa arm di App per la logica, app per le funzioni o app per le API.
properties.title	string minLength: 1 maxLength: 300	Titolo back-end.
properties.tls	BackendTlsProperties	Proprietà TLS back-end
properties.type	BackendType	Tipo del back-end. Un back-end può essere singolo o pool.
properties.url	string minLength: 1 maxLength: 2000	URL di runtime del back-end.

CircuitBreakerFailureCondition

Object

Le condizioni di corsa del interruttore

Nome	Tipo	Descrizione
count	integer (int64)	Soglia per l'apertura del circuito.
errorReasons	string[] maxLength: 200	Motivi dell'errore considerati come errori.
interval	string (duration)	Intervallo durante il quale vengono conteggiati gli errori.
percentage	integer (int64)	Soglia per l'apertura del circuito.
statusCodeRanges	FailureStatusCodeRange[]	Intervalli di codici di stato considerati come errori.

CircuitBreakerRule

Object

Configurazione della regola per eseguire il trip del back-end.

Nome	Tipo	Descrizione
acceptRetryAfter	boolean	flag per accettare Retry-After intestazione dal back-end.
failureCondition	CircuitBreakerFailureCondition	Condizioni per il tripping dell'interruttore.
name	string	Nome della regola.
tripDuration	string (duration)	Durata per cui verrà ritagliato il circuito.

ErrorAdditionalInfo

Object

Informazioni aggiuntive sull'errore di gestione delle risorse.

Nome	Tipo	Descrizione
info	object	Informazioni aggiuntive.
type	string	Tipo di informazioni aggiuntive.

ErrorDetail

Object

Dettagli dell'errore.

Nome	Tipo	Descrizione
additionalInfo	ErrorAdditionalInfo[]	Informazioni aggiuntive sull'errore.
code	string	Codice di errore.
details	ErrorDetail[]	Dettagli dell'errore.
message	string	Messaggio di errore.
target	string	Destinazione dell'errore.

ErrorResponse

Object

Risposta di errore

Nome	Tipo	Descrizione
error	ErrorDetail	Oggetto error.

FailureStatusCodeRange

Object

Intervallo di codici di stato HTTP non riuscito

Nome	Tipo	Descrizione
max	integer (int32) minimum: 200 maximum: 599	Codice di stato http massimo.
min	integer (int32) minimum: 200 maximum: 599	Codice di stato http minimo.

Pool

Object

Nome	Tipo	Descrizione
services	BackendPoolItem[]	Elenco di entità back-end appartenenti a un pool.

X509CertificateName

Object

Proprietà del server X509Names.

Nome	Tipo	Descrizione
issuerCertificateThumbprint	string	Identificazione personale per l'autorità emittente del certificato.
name	string	Nome comune del certificato.

Condividi tramite

Backend - Update

Parametri dell'URI

Intestazione della richiesta

Corpo della richiesta

Risposte

Sicurezza

azure_auth

Ambiti

Esempio

ApiManagementUpdateBackend

Esempio di richiesta

Risposta di esempio

Definizioni

BackendAuthorizationHeaderCredentials

BackendCircuitBreaker

BackendContract

BackendCredentialsContract

BackendPoolItem

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

BackendType

BackendUpdateParameters

CircuitBreakerFailureCondition

CircuitBreakerRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailureStatusCodeRange

Pool

X509CertificateName

Risorse aggiuntive