Backend - Update
Frissítések egy meglévő háttérrendszert.
PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}?api-version=2022-08-01
URI-paraméterek
Name | In | Kötelező | Típus | Description |
---|---|---|---|---|
backend
|
path | True |
string |
A Háttérentitás azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie. |
resource
|
path | True |
string |
Az erőforráscsoport neve. A név megkülönbözteti a kis- és nagybetűket. |
service
|
path | True |
string |
A API Management szolgáltatás neve. Reguláris kifejezési minta: |
subscription
|
path | True |
string |
A cél-előfizetés azonosítója. |
api-version
|
query | True |
string |
A művelethez használandó API-verzió. |
Kérelem fejléce
Name | Kötelező | Típus | Description |
---|---|---|---|
If-Match | True |
string |
Az entitás ETagje. Az ETagnek meg kell egyeznie a GET-kérés fejlécválaszában szereplő aktuális entitásállapotmal, vagy * értékűnek kell lennie a feltétel nélküli frissítéshez. |
Kérelem törzse
Name | Típus | Description |
---|---|---|
properties.credentials |
Háttérbeli hitelesítő adatok szerződésének tulajdonságai |
|
properties.description |
string |
Háttér leírása. |
properties.properties |
Háttértulajdonságok szerződése |
|
properties.protocol |
Háttérrendszeri kommunikációs protokoll. |
|
properties.proxy |
Háttérbeli átjáró szerződésének tulajdonságai |
|
properties.resourceId |
string |
Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Függvényalkalmazások vagy az API-alkalmazások ARM-erőforrás-azonosítója. |
properties.title |
string |
Háttércím. |
properties.tls |
Háttérbeli TLS-tulajdonságok |
|
properties.url |
string |
A háttérrendszer futtatókörnyezeti URL-címe. |
Válaszok
Name | Típus | Description |
---|---|---|
200 OK |
A meglévő háttérrendszer frissítése sikerült. Fejlécek ETag: string |
|
Other Status Codes |
Hibaválasz, amely leírja, hogy a művelet miért hiúsult meg. |
Biztonság
azure_auth
Azure Active Directory OAuth2 Flow.
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/authorize
Hatókörök
Name | Description |
---|---|
user_impersonation | felhasználói fiók megszemélyesítése |
Példák
ApiManagementUpdateBackend
Mintakérelem
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
}
}
}
Mintaválasz
{
"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
}
}
}
Definíciók
Name | Description |
---|---|
Backend |
Engedélyezési fejléc adatai. |
Backend |
Háttéradatok. |
Backend |
A háttérrendszerhez való csatlakozáshoz használt hitelesítő adatok részletei. |
Backend |
A háttértípusra jellemző tulajdonságok. |
Backend |
Háttérrendszeri kommunikációs protokoll. |
Backend |
A háttérbeli WebProxy-kiszolgáló részletei, amelyet a Háttéralkalmazás kérése szolgáltatásban kell használni. |
Backend |
A Service Fabric típusú háttérrendszer tulajdonságai. |
Backend |
TLS-tanúsítványérvényesítést vezérlő tulajdonságok. |
Backend |
Háttérfrissítési paraméterek. |
Error |
Hibamező-szerződés. |
Error |
Hibaválasz. |
X509Certificate |
Az X509Names kiszolgáló tulajdonságai. |
BackendAuthorizationHeaderCredentials
Engedélyezési fejléc adatai.
Name | Típus | Description |
---|---|---|
parameter |
string |
Hitelesítési paraméter értéke. |
scheme |
string |
Hitelesítési séma neve. |
BackendContract
Háttéradatok.
Name | Típus | Description |
---|---|---|
id |
string |
Az erőforrás teljes erőforrás-azonosítója. Például : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Az erőforrás neve |
properties.credentials |
Háttérbeli hitelesítő adatok szerződésének tulajdonságai |
|
properties.description |
string |
Háttér leírása. |
properties.properties |
Háttértulajdonságok szerződése |
|
properties.protocol |
Háttérrendszeri kommunikációs protokoll. |
|
properties.proxy |
Háttérbeli átjáró szerződésének tulajdonságai |
|
properties.resourceId |
string |
Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Függvényalkalmazások vagy az API-alkalmazások ARM-erőforrás-azonosítója. |
properties.title |
string |
Háttércím. |
properties.tls |
Háttérbeli TLS-tulajdonságok |
|
properties.url |
string |
A háttérrendszer futtatókörnyezeti URL-címe. |
type |
string |
Az erőforrás típusa. Például"Microsoft.Compute/virtualMachines" vagy "Microsoft.Storage/storageAccounts" |
BackendCredentialsContract
A háttérrendszerhez való csatlakozáshoz használt hitelesítő adatok részletei.
Name | Típus | Description |
---|---|---|
authorization |
Engedélyezési fejléc hitelesítése |
|
certificate |
string[] |
Ügyféltanúsítvány ujjlenyomatainak listája. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva. |
certificateIds |
string[] |
Ügyféltanúsítvány-azonosítók listája. |
header |
object |
Fejlécparaméter leírása. |
query |
object |
Lekérdezési paraméter leírása. |
BackendProperties
A háttértípusra jellemző tulajdonságok.
Name | Típus | Description |
---|---|---|
serviceFabricCluster |
Háttérbeli Service Fabric-fürt tulajdonságai |
BackendProtocol
Háttérrendszeri kommunikációs protokoll.
Name | Típus | Description |
---|---|---|
http |
string |
A háttérrendszer egy RESTful szolgáltatás. |
soap |
string |
A háttérrendszer egy SOAP-szolgáltatás. |
BackendProxyContract
A háttérbeli WebProxy-kiszolgáló részletei, amelyet a Háttéralkalmazás kérése szolgáltatásban kell használni.
Name | Típus | Description |
---|---|---|
password |
string |
Jelszó a WebProxy-kiszolgálóhoz való csatlakozáshoz |
url |
string |
WebProxy Server AbsoluteUri tulajdonság, amely tartalmazza az URI-példányban tárolt teljes URI-t, beleértve az összes töredéket és lekérdezési sztringet. |
username |
string |
Felhasználónév a WebProxy-kiszolgálóhoz való csatlakozáshoz |
BackendServiceFabricClusterProperties
A Service Fabric típusú háttérrendszer tulajdonságai.
Name | Típus | Description |
---|---|---|
clientCertificateId |
string |
A felügyeleti végpont ügyféltanúsítvány-azonosítója. |
clientCertificatethumbprint |
string |
A felügyeleti végpont ügyféltanúsítvány-ujjlenyomata. A rendszer figyelmen kívül hagyja, ha a tanúsítványazonosítók meg vannak adva |
managementEndpoints |
string[] |
A fürtkezelési végpont. |
maxPartitionResolutionRetries |
integer |
A partíció feloldása során az újrapróbálkozások maximális száma. |
serverCertificateThumbprints |
string[] |
A fürtkezelési szolgáltatás által a tls-kommunikációhoz használt tanúsítványok ujjlenyomatai |
serverX509Names |
Server X509-tanúsítványnévgyűjtemény |
BackendTlsProperties
TLS-tanúsítványérvényesítést vezérlő tulajdonságok.
Name | Típus | Alapértelmezett érték | Description |
---|---|---|---|
validateCertificateChain |
boolean |
True |
Jelölő, amely jelzi, hogy az SSL-tanúsítványlánc érvényesítését el kell-e végezni, amikor önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez. |
validateCertificateName |
boolean |
True |
Jelölő, amely azt jelzi, hogy az SSL-tanúsítvány nevének érvényesítését el kell-e végezni, amikor önaláírt tanúsítványokat használ ehhez a háttér gazdagéphez. |
BackendUpdateParameters
Háttérfrissítési paraméterek.
Name | Típus | Description |
---|---|---|
properties.credentials |
Háttérbeli hitelesítő adatok szerződésének tulajdonságai |
|
properties.description |
string |
Háttér leírása. |
properties.properties |
Háttértulajdonságok szerződése |
|
properties.protocol |
Háttérrendszeri kommunikációs protokoll. |
|
properties.proxy |
Háttérbeli átjáró szerződésének tulajdonságai |
|
properties.resourceId |
string |
Az erőforrás felügyeleti URI-ja a külső rendszerben. Ez az URL-cím lehet a Logic Apps, a Függvényalkalmazások vagy az API-alkalmazások ARM-erőforrás-azonosítója. |
properties.title |
string |
Háttércím. |
properties.tls |
Háttérbeli TLS-tulajdonságok |
|
properties.url |
string |
A háttérrendszer futtatókörnyezeti URL-címe. |
ErrorFieldContract
Hibamező-szerződés.
Name | Típus | Description |
---|---|---|
code |
string |
Tulajdonságszintű hibakód. |
message |
string |
A tulajdonságszintű hiba emberi olvasásra alkalmas ábrázolása. |
target |
string |
Tulajdonság neve. |
ErrorResponse
Hibaválasz.
Name | Típus | Description |
---|---|---|
error.code |
string |
Szolgáltatás által definiált hibakód. Ez a kód a válaszban megadott HTTP-hibakód alállapotaként szolgál. |
error.details |
Érvényesítési hiba esetén a kérelemben küldött érvénytelen mezők listája. |
|
error.message |
string |
A hiba emberi olvasásra alkalmas ábrázolása. |
X509CertificateName
Az X509Names kiszolgáló tulajdonságai.
Name | Típus | Description |
---|---|---|
issuerCertificateThumbprint |
string |
A tanúsítvány kiállítójának ujjlenyomata. |
name |
string |
A tanúsítvány köznapi neve. |