Backend - Create Or Update
Arka uç oluşturur veya Güncelleştirmeler.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}?api-version=2022-08-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
backend
|
path | True |
string |
Arka uç varlığının tanımlayıcısı. Geçerli API Management hizmet örneğinde benzersiz olmalıdır. |
resource
|
path | True |
string |
Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir. |
service
|
path | True |
string |
API Management hizmetinin adı. Normal ifade deseni: |
subscription
|
path | True |
string |
Hedef aboneliğin kimliği. |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
İstek Başlığı
Name | Gerekli | Tür | Description |
---|---|---|---|
If-Match |
string |
Varlığın ETag'i. Varlık oluştururken gerekli değildir, ancak varlığı güncelleştirirken gereklidir. |
İstek Gövdesi
Name | Gerekli | Tür | Description |
---|---|---|---|
properties.protocol | True |
Arka uç iletişim protokolü. |
|
properties.url | True |
string |
Arka Ucun Çalışma Zamanı Url'si. |
properties.credentials |
Arka Uç Kimlik Bilgileri Sözleşme Özellikleri |
||
properties.description |
string |
Arka Uç Açıklaması. |
|
properties.properties |
Arka Uç Özellikleri sözleşmesi |
||
properties.proxy |
Arka uç ağ geçidi Sözleşme Özellikleri |
||
properties.resourceId |
string |
Dış Sistemdeki Kaynağın Yönetim Uri'si. Bu URL Logic Apps, İşlev Uygulamaları veya API Uygulamalarının Arm Kaynak Kimliği olabilir. |
|
properties.title |
string |
Arka Uç Başlığı. |
|
properties.tls |
Arka Uç TLS Özellikleri |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Mevcut arka uç başarıyla güncelleştirildi. Üst Bilgiler ETag: string |
|
201 Created |
Arka uç başarıyla oluşturuldu. Üst Bilgiler ETag: string |
|
Other Status Codes |
İşlemin neden başarısız olduğunu açıklayan hata yanıtı. |
Güvenlik
azure_auth
Azure Active Directory OAuth2 Flow.
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/authorize
Kapsamlar
Name | Description |
---|---|
user_impersonation | kullanıcı hesabınızın kimliğine bürünme |
Örnekler
Api |
Api |
ApiManagementCreateBackendProxyBackend
Örnek isteği
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"
}
}
}
}
Örnek yanıt
{
"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
Örnek isteği
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
}
}
}
}
Örnek yanıt
{
"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
}
}
}
}
Tanımlar
Name | Description |
---|---|
Backend |
Yetkilendirme üst bilgisi bilgileri. |
Backend |
Arka uç ayrıntıları. |
Backend |
Arka Uç'a bağlanmak için kullanılan Kimlik Bilgilerinin ayrıntıları. |
Backend |
Arka Uç Türüne özgü özellikler. |
Backend |
Arka uç iletişim protokolü. |
Backend |
Arka Uç İsteğinde kullanılacak Arka Uç WebProxy Sunucusunun ayrıntıları. |
Backend |
Service Fabric Türü Arka Ucu özellikleri. |
Backend |
TLS Sertifika Doğrulamasını denetleen özellikler. |
Error |
Hata Alanı sözleşmesi. |
Error |
Hata Yanıtı. |
X509Certificate |
X509Names sunucusunun özellikleri. |
BackendAuthorizationHeaderCredentials
Yetkilendirme üst bilgisi bilgileri.
Name | Tür | Description |
---|---|---|
parameter |
string |
Kimlik Doğrulama Parametresi değeri. |
scheme |
string |
Kimlik Doğrulama Düzeni adı. |
BackendContract
Arka uç ayrıntıları.
Name | Tür | Description |
---|---|---|
id |
string |
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Kaynağın adı |
properties.credentials |
Arka Uç Kimlik Bilgileri Sözleşme Özellikleri |
|
properties.description |
string |
Arka Uç Açıklaması. |
properties.properties |
Arka Uç Özellikleri sözleşmesi |
|
properties.protocol |
Arka uç iletişim protokolü. |
|
properties.proxy |
Arka uç ağ geçidi Sözleşme Özellikleri |
|
properties.resourceId |
string |
Dış Sistemdeki Kaynağın Yönetim Uri'si. Bu URL Logic Apps, İşlev Uygulamaları veya API Uygulamalarının Arm Kaynak Kimliği olabilir. |
properties.title |
string |
Arka Uç Başlığı. |
properties.tls |
Arka Uç TLS Özellikleri |
|
properties.url |
string |
Arka Ucun Çalışma Zamanı Url'si. |
type |
string |
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" |
BackendCredentialsContract
Arka Uç'a bağlanmak için kullanılan Kimlik Bilgilerinin ayrıntıları.
Name | Tür | Description |
---|---|---|
authorization |
Yetkilendirme üst bilgisi kimlik doğrulaması |
|
certificate |
string[] |
İstemci Sertifikası Parmak İzleri listesi. CertificatesId'ler sağlanırsa yoksayılır. |
certificateIds |
string[] |
İstemci Sertifika Kimliklerinin listesi. |
header |
object |
Üst Bilgi Parametresi açıklaması. |
query |
object |
Sorgu Parametresi açıklaması. |
BackendProperties
Arka Uç Türüne özgü özellikler.
Name | Tür | Description |
---|---|---|
serviceFabricCluster |
Arka Uç Service Fabric Küme Özellikleri |
BackendProtocol
Arka uç iletişim protokolü.
Name | Tür | Description |
---|---|---|
http |
string |
Arka uç bir RESTful hizmetidir. |
soap |
string |
Arka Uç bir SOAP hizmetidir. |
BackendProxyContract
Arka Uç İsteğinde kullanılacak Arka Uç WebProxy Sunucusunun ayrıntıları.
Name | Tür | Description |
---|---|---|
password |
string |
WebProxy Sunucusuna bağlanmak için parola |
url |
string |
Tüm parçalar ve sorgu dizeleri dahil olmak üzere Uri örneğinde depolanan URI'nin tamamını içeren WebProxy Server AbsoluteUri özelliği. |
username |
string |
WebProxy sunucusuna bağlanmak için kullanıcı adı |
BackendServiceFabricClusterProperties
Service Fabric Türü Arka Ucu özellikleri.
Name | Tür | Description |
---|---|---|
clientCertificateId |
string |
Yönetim uç noktası için istemci sertifika kimliği. |
clientCertificatethumbprint |
string |
Yönetim uç noktası için istemci sertifikası parmak izi. CertificatesId'ler sağlanırsa yoksayılır |
managementEndpoints |
string[] |
Küme yönetimi uç noktası. |
maxPartitionResolutionRetries |
integer |
Bölümü çözümlemeye çalışırken en fazla yeniden deneme sayısı. |
serverCertificateThumbprints |
string[] |
Küme yönetim hizmetinin tls iletişimi için kullandığı sertifikaların parmak izleri |
serverX509Names |
Sunucu X509 Sertifika Adları Koleksiyonu |
BackendTlsProperties
TLS Sertifika Doğrulamasını denetleen özellikler.
Name | Tür | Default value | Description |
---|---|---|---|
validateCertificateChain |
boolean |
True |
Bu arka uç konağı için otomatik olarak imzalanan sertifikalar kullanılırken SSL sertifika zinciri doğrulamasının yapılıp yapılmayacağını belirten bayrak. |
validateCertificateName |
boolean |
True |
Bu arka uç konağı için otomatik olarak imzalanan sertifikalar kullanılırken SSL sertifika adı doğrulamasının yapılıp yapılmayacağını belirten bayrak. |
ErrorFieldContract
Hata Alanı sözleşmesi.
Name | Tür | Description |
---|---|---|
code |
string |
Özellik düzeyi hata kodu. |
message |
string |
Özellik düzeyi hatanın insan tarafından okunabilir gösterimi. |
target |
string |
Özellik adı. |
ErrorResponse
Hata Yanıtı.
Name | Tür | Description |
---|---|---|
error.code |
string |
Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür. |
error.details |
Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi. |
|
error.message |
string |
Hatanın insan tarafından okunabilir gösterimi. |
X509CertificateName
X509Names sunucusunun özellikleri.
Name | Tür | Description |
---|---|---|
issuerCertificateThumbprint |
string |
Sertifikayı Veren için parmak izi. |
name |
string |
Sertifikanın Ortak Adı. |