Backend - Create Or Update
Vytvoří nebo Aktualizace back-end.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}?api-version=2022-08-01
Parametry identifikátoru URI
Name | V | Vyžadováno | Typ | Description |
---|---|---|---|---|
backend
|
path | True |
string |
Identifikátor entity back-endu. Musí být jedinečný v aktuální instanci služby API Management. |
resource
|
path | True |
string |
Název skupiny prostředků. V názvu se rozlišují malá a velká písmena. |
service
|
path | True |
string |
Název služby API Management. Vzor regulárního výrazu: |
subscription
|
path | True |
string |
ID cílového předplatného. |
api-version
|
query | True |
string |
Verze rozhraní API, která se má použít pro tuto operaci. |
Hlavička požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
If-Match |
string |
Značka ETag entity. Nevyžaduje se při vytváření entity, ale vyžaduje se při aktualizaci entity. |
Text požadavku
Name | Vyžadováno | Typ | Description |
---|---|---|---|
properties.protocol | True |
Komunikační protokol back-endu. |
|
properties.url | True |
string |
Adresa URL modulu runtime back-endu. |
properties.credentials |
Vlastnosti kontraktu přihlašovacích údajů back-endu |
||
properties.description |
string |
Popis back-endu |
|
properties.properties |
Kontrakt vlastností back-endu |
||
properties.proxy |
Vlastnosti kontraktu back-endové brány |
||
properties.resourceId |
string |
Identifikátor URI správy prostředku v externím systému. Tato adresa URL může být ID prostředku ARM pro Logic Apps, Function Apps nebo API Apps. |
|
properties.title |
string |
Název back-endu. |
|
properties.tls |
Vlastnosti protokolu TLS back-endu |
Odpovědi
Name | Typ | Description |
---|---|---|
200 OK |
Existující back-end se úspěšně aktualizoval. Hlavičky ETag: string |
|
201 Created |
Back-end se úspěšně vytvořil. Hlavičky ETag: string |
|
Other Status Codes |
Chybová odpověď popisující, proč operace selhala. |
Zabezpečení
azure_auth
Tok Azure Active Directory OAuth2.
Typ:
oauth2
Tok:
implicit
URL autorizace:
https://login.microsoftonline.com/common/oauth2/authorize
Rozsahy
Name | Description |
---|---|
user_impersonation | zosobnění uživatelského účtu |
Příklady
Api |
Api |
ApiManagementCreateBackendProxyBackend
Ukázkový požadavek
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend?api-version=2022-08-01
{
"properties": {
"description": "description5308",
"url": "https://backendname2644/",
"protocol": "http",
"tls": {
"validateCertificateChain": true,
"validateCertificateName": true
},
"proxy": {
"url": "http://192.168.1.1:8080",
"username": "Contoso\\admin",
"password": "<password>"
},
"credentials": {
"query": {
"sv": [
"xx",
"bb",
"cc"
]
},
"header": {
"x-my-1": [
"val1",
"val2"
]
},
"authorization": {
"scheme": "Basic",
"parameter": "opensesma"
}
}
}
}
Ukázková odpověď
{
"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": false
}
}
}
{
"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": false
}
}
}
ApiManagementCreateBackendServiceFabric
Ukázkový požadavek
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend?api-version=2022-08-01
{
"properties": {
"description": "Service Fabric Test App 1",
"protocol": "http",
"url": "fabric:/mytestapp/mytestservice",
"properties": {
"serviceFabricCluster": {
"managementEndpoints": [
"https://somecluster.com"
],
"clientCertificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
"serverX509Names": [
{
"name": "ServerCommonName1",
"issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
}
],
"maxPartitionResolutionRetries": 5
}
}
}
}
Ukázková odpověď
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend",
"type": "Microsoft.ApiManagement/service/backends",
"name": "sfbackend",
"properties": {
"description": "Service Fabric Test App 1",
"url": "fabric:/mytestapp/mytestservice",
"protocol": "http",
"properties": {
"serviceFabricCluster": {
"managementEndpoints": [
"https://somecluster.com"
],
"clientCertificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
"serverX509Names": [
{
"name": "ServerCommonName1",
"issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
}
],
"maxPartitionResolutionRetries": 5
}
}
}
}
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend",
"type": "Microsoft.ApiManagement/service/backends",
"name": "sfbackend",
"properties": {
"description": "Service Fabric Test App 1",
"url": "fabric:/mytestapp/mytestservice",
"protocol": "http",
"properties": {
"serviceFabricCluster": {
"managementEndpoints": [
"https://somecluster.com"
],
"clientCertificateId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
"serverX509Names": [
{
"name": "ServerCommonName1",
"issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
}
],
"maxPartitionResolutionRetries": 5
}
}
}
}
Definice
Name | Description |
---|---|
Backend |
Informace o autorizační hlavičce. |
Backend |
Podrobnosti o back-endu |
Backend |
Podrobnosti o přihlašovacích údajích použitých pro připojení k back-endu |
Backend |
Vlastnosti specifické pro typ back-endu. |
Backend |
Komunikační protokol back-endu. |
Backend |
Podrobnosti o serveru WebProxy back-endu, který se použije v požadavku na back-end. |
Backend |
Vlastnosti back-endu typu Service Fabric. |
Backend |
Vlastnosti, které řídí ověřování certifikátu TLS. |
Error |
Chybový kontrakt pole. |
Error |
Odpověď na chybu. |
X509Certificate |
Vlastnosti serveru X509Names. |
BackendAuthorizationHeaderCredentials
Informace o autorizační hlavičce.
Name | Typ | Description |
---|---|---|
parameter |
string |
Hodnota parametru ověřování |
scheme |
string |
Název schématu ověřování. |
BackendContract
Podrobnosti o back-endu
Name | Typ | Description |
---|---|---|
id |
string |
Plně kvalifikované ID prostředku Příklad : /subscriptions/{id_předplatného}/resourceGroups/{název_skupiny_prostředků}/providers/{resourceProviderNamespace}/{typ_prostředku}/{název_prostředku} |
name |
string |
Název prostředku |
properties.credentials |
Vlastnosti kontraktu přihlašovacích údajů back-endu |
|
properties.description |
string |
Popis back-endu |
properties.properties |
Kontrakt vlastností back-endu |
|
properties.protocol |
Komunikační protokol back-endu. |
|
properties.proxy |
Vlastnosti kontraktu back-endové brány |
|
properties.resourceId |
string |
Identifikátor URI správy prostředku v externím systému. Tato adresa URL může být ID prostředku ARM pro Logic Apps, Function Apps nebo API Apps. |
properties.title |
string |
Název back-endu. |
properties.tls |
Vlastnosti protokolu TLS back-endu |
|
properties.url |
string |
Adresa URL modulu runtime back-endu. |
type |
string |
Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts |
BackendCredentialsContract
Podrobnosti o přihlašovacích údajích použitých pro připojení k back-endu
Name | Typ | Description |
---|---|---|
authorization |
Ověřování pomocí autorizační hlavičky |
|
certificate |
string[] |
Seznam kryptografických otisků klientských certifikátů Pokud jsou k dispozici identifikátory certificatesId, budou ignorovány. |
certificateIds |
string[] |
Seznam ID klientských certifikátů |
header |
object |
Popis parametru hlavičky. |
query |
object |
Popis parametru dotazu |
BackendProperties
Vlastnosti specifické pro typ back-endu.
Name | Typ | Description |
---|---|---|
serviceFabricCluster |
Vlastnosti back-endového clusteru Service Fabric |
BackendProtocol
Komunikační protokol back-endu.
Name | Typ | Description |
---|---|---|
http |
string |
Back-end je služba RESTful. |
soap |
string |
Back-end je služba SOAP. |
BackendProxyContract
Podrobnosti o serveru WebProxy back-endu, který se použije v požadavku na back-end.
Name | Typ | Description |
---|---|---|
password |
string |
Heslo pro připojení k serveru WebProxy |
url |
string |
Vlastnost AbsoluteUri serveru WebProxy, která zahrnuje celý identifikátor URI uložený v instanci Uri, včetně všech fragmentů a řetězců dotazu. |
username |
string |
Uživatelské jméno pro připojení k serveru WebProxy |
BackendServiceFabricClusterProperties
Vlastnosti back-endu typu Service Fabric.
Name | Typ | Description |
---|---|---|
clientCertificateId |
string |
ID klientského certifikátu pro koncový bod správy. |
clientCertificatethumbprint |
string |
Kryptografický otisk klientského certifikátu pro koncový bod správy. Pokud jsou k dispozici identifikátory certificatesId, bude se ignorovat. |
managementEndpoints |
string[] |
Koncový bod správy clusteru. |
maxPartitionResolutionRetries |
integer |
Maximální počet opakování při pokusu o překlad oddílu |
serverCertificateThumbprints |
string[] |
Kryptografické otisky certifikátů, které služba pro správu clusteru používá ke komunikaci tls |
serverX509Names |
Kolekce názvů certifikátů serveru X509 |
BackendTlsProperties
Vlastnosti, které řídí ověřování certifikátu TLS.
Name | Typ | Default value | Description |
---|---|---|---|
validateCertificateChain |
boolean |
True |
Příznak určující, jestli se má při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele provést ověření řetězu certifikátů SSL. |
validateCertificateName |
boolean |
True |
Příznak určující, jestli se má při použití certifikátů podepsaných svým držitelem pro tohoto back-endového hostitele provést ověření názvu certifikátu SSL. |
ErrorFieldContract
Chybový kontrakt pole.
Name | Typ | Description |
---|---|---|
code |
string |
Kód chyby na úrovni vlastnosti. |
message |
string |
Pro člověka čitelná reprezentace chyby na úrovni vlastností. |
target |
string |
Název vlastnosti. |
ErrorResponse
Odpověď na chybu.
Name | Typ | Description |
---|---|---|
error.code |
string |
Kód chyby definovaný službou. Tento kód slouží jako dílčí stav pro kód chyby HTTP zadaný v odpovědi. |
error.details |
Seznam neplatných polí se odešle v požadavku v případě chyby ověření. |
|
error.message |
string |
Pro člověka čitelná reprezentace chyby. |
X509CertificateName
Vlastnosti serveru X509Names.
Name | Typ | Description |
---|---|---|
issuerCertificateThumbprint |
string |
Kryptografický otisk vystavitele certifikátu. |
name |
string |
Běžný název certifikátu. |