Backend - Update
Aggiornamenti un back-end esistente.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}?api-version=2022-08-01
Parametri dell'URI
Nome | In | Necessario | Tipo | Descrizione |
---|---|---|---|---|
backend
|
path | True |
string |
Identificatore dell'entità back-end. Deve essere univoco nell'istanza corrente del servizio di Gestione API. |
resource
|
path | True |
string |
Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole. |
service
|
path | True |
string |
Nome del servizio di Gestione API. Criterio di espressione regolare: |
subscription
|
path | True |
string |
ID della sottoscrizione di destinazione. |
api-version
|
query | True |
string |
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 di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato. |
Corpo della richiesta
Nome | Tipo | Descrizione |
---|---|---|
properties.credentials |
Proprietà del contratto credenziali back-end |
|
properties.description |
string |
Descrizione back-end. |
properties.properties |
Contratto proprietà back-end |
|
properties.protocol |
Protocollo di comunicazione back-end. |
|
properties.proxy |
Proprietà del contratto del gateway back-end |
|
properties.resourceId |
string |
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 |
Titolo back-end. |
properties.tls |
Proprietà TLS back-end |
|
properties.url |
string |
URL di runtime del back-end. |
Risposte
Nome | Tipo | Descrizione |
---|---|---|
200 OK |
Il back-end esistente è stato aggiornato correttamente. Intestazioni ETag: string |
|
Other Status Codes |
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
PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend?api-version=2022-08-01
{
"properties": {
"description": "description5308",
"tls": {
"validateCertificateChain": false,
"validateCertificateName": true
}
}
}
Risposta di esempio
{
"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
}
}
}
Definizioni
Nome | Descrizione |
---|---|
Backend |
Informazioni sull'intestazione dell'autorizzazione. |
Backend |
Dettagli back-end. |
Backend |
Dettagli delle credenziali usate per connettersi al back-end. |
Backend |
Proprietà specifiche del tipo back-end. |
Backend |
Protocollo di comunicazione back-end. |
Backend |
Dettagli del server WebProxy back-end da usare nella richiesta al back-end. |
Backend |
Proprietà del back-end del tipo di Service Fabric. |
Backend |
Proprietà che controllano la convalida del certificato TLS. |
Backend |
Parametri di aggiornamento back-end. |
Error |
Contratto campo di errore. |
Error |
Risposta errore. |
X509Certificate |
Proprietà del server X509Names. |
BackendAuthorizationHeaderCredentials
Informazioni sull'intestazione dell'autorizzazione.
Nome | Tipo | Descrizione |
---|---|---|
parameter |
string |
Valore del parametro di autenticazione. |
scheme |
string |
Nome schema di autenticazione. |
BackendContract
Dettagli back-end.
Nome | Tipo | Descrizione |
---|---|---|
id |
string |
ID di risorsa completo per la risorsa. Ad esempio - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
nome della risorsa. |
properties.credentials |
Proprietà del contratto credenziali back-end |
|
properties.description |
string |
Descrizione back-end. |
properties.properties |
Contratto proprietà back-end |
|
properties.protocol |
Protocollo di comunicazione back-end. |
|
properties.proxy |
Proprietà del contratto del gateway back-end |
|
properties.resourceId |
string |
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 |
Titolo back-end. |
properties.tls |
Proprietà TLS back-end |
|
properties.url |
string |
URL di runtime del back-end. |
type |
string |
Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts" |
BackendCredentialsContract
Dettagli delle credenziali usate per connettersi al back-end.
Nome | Tipo | Descrizione |
---|---|---|
authorization |
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. |
BackendProperties
Proprietà specifiche del tipo back-end.
Nome | Tipo | Descrizione |
---|---|---|
serviceFabricCluster |
Proprietà del cluster back-end di Service Fabric |
BackendProtocol
Protocollo di comunicazione back-end.
Nome | Tipo | Descrizione |
---|---|---|
http |
string |
Il back-end è un servizio RESTful. |
soap |
string |
Il back-end è un servizio SOAP. |
BackendProxyContract
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 |
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 connettersi al server WebProxy |
BackendServiceFabricClusterProperties
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 certificatesId |
managementEndpoints |
string[] |
Endpoint di gestione del cluster. |
maxPartitionResolutionRetries |
integer |
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 |
Raccolta dei nomi dei certificati server X509 |
BackendTlsProperties
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. |
BackendUpdateParameters
Parametri di aggiornamento back-end.
Nome | Tipo | Descrizione |
---|---|---|
properties.credentials |
Proprietà del contratto credenziali back-end |
|
properties.description |
string |
Descrizione back-end. |
properties.properties |
Contratto proprietà back-end |
|
properties.protocol |
Protocollo di comunicazione back-end. |
|
properties.proxy |
Proprietà del contratto del gateway back-end |
|
properties.resourceId |
string |
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 |
Titolo back-end. |
properties.tls |
Proprietà TLS back-end |
|
properties.url |
string |
URL di runtime del back-end. |
ErrorFieldContract
Contratto campo di errore.
Nome | Tipo | Descrizione |
---|---|---|
code |
string |
Codice di errore a livello di proprietà. |
message |
string |
Rappresentazione leggibile dell'errore a livello di proprietà. |
target |
string |
Nome della proprietà. |
ErrorResponse
Risposta errore.
Nome | Tipo | Descrizione |
---|---|---|
error.code |
string |
Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta. |
error.details |
Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida. |
|
error.message |
string |
Rappresentazione leggibile dell'errore. |
X509CertificateName
Proprietà del server X509Names.
Nome | Tipo | Descrizione |
---|---|---|
issuerCertificateThumbprint |
string |
Identificazione personale per l'autorità emittente del certificato. |
name |
string |
Nome comune del certificato. |