Backend - Create Or Update

參考

服務:: API Management

API 版本:: 2024-05-01

建立或更新後端。

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

URI 參數

名稱	位於	必要	類型	Description
backendId	path	True	string minLength: 1 maxLength: 80	後端實體的標識碼。目前 API 管理服務實例中必須是唯一的。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	資源群組的名稱。名稱不區分大小寫。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API 管理服務的名稱。
subscriptionId	path	True	string (uuid)	目標訂用帳戶的標識碼。此值必須是 UUID。
api-version	query	True	string minLength: 1	要用於這項作業的 API 版本。

要求標頭

名稱	必要	類型	Description
If-Match		string	實體的 ETag。建立實體時不需要，但在更新實體時則為必要專案。

要求本文

名稱	必要	類型	Description
properties.protocol	True	BackendProtocol	後端通訊協定。
properties.url	True	string minLength: 1 maxLength: 2000	後端的運行時間 URL。
properties.circuitBreaker		BackendCircuitBreaker	後端斷路器組態
properties.credentials		BackendCredentialsContract	後端認證合約屬性
properties.description		string minLength: 1 maxLength: 2000	後端描述。
properties.pool		Pool
properties.properties		BackendProperties	後端屬性合約
properties.proxy		BackendProxyContract	後端閘道合約屬性
properties.resourceId		string minLength: 1 maxLength: 2000	外部系統中資源的管理 URI。此 URL 可以是 Logic Apps、Function Apps 或 API Apps 的 Arm 資源識別符。
properties.title		string minLength: 1 maxLength: 300	後端標題。
properties.tls		BackendTlsProperties	後端 TLS 屬性
properties.type		BackendType	後端的類型。後端可以是單一或集區。

回應

名稱	類型	Description
200 OK	BackendContract	已成功更新現有的後端。標題 ETag: string
201 Created	BackendContract	已成功建立後端。標題 ETag: string
Other Status Codes	ErrorResponse	描述作業失敗原因的錯誤回應。

名稱

類型

Description

200 OK

BackendContract

已成功更新現有的後端。

標題

ETag: string

201 Created

BackendContract

已成功建立後端。

標題

ETag: string

Other Status Codes

ErrorResponse

描述作業失敗原因的錯誤回應。

安全性

azure_auth

Azure Active Directory OAuth2 Flow。

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/authorize

範圍

名稱	Description
user_impersonation	模擬您的用戶帳戶

範例

ApiManagementCreateBackendProxyBackend

ApiManagementCreateBackendServiceFabric

ApiManagementCreateBackendProxyBackend

範例要求

HTTP

PUT 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",
    "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"
      }
    }
  }
}

範例回覆

狀態碼:: 201

{
  "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": false
    }
  }
}

狀態碼:: 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": false
    }
  }
}

ApiManagementCreateBackendServiceFabric

範例要求

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/sfbackend?api-version=2024-05-01

{
  "properties": {
    "description": "Service Fabric Test App 1",
    "protocol": "http",
    "url": "fabric:/mytestapp/mytestservice",
    "properties": {
      "serviceFabricCluster": {
        "managementEndpoints": [
          "https://somecluster.com"
        ],
        "clientCertificateId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
        "serverX509Names": [
          {
            "name": "ServerCommonName1",
            "issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
          }
        ],
        "maxPartitionResolutionRetries": 5
      }
    }
  }
}

範例回覆

狀態碼:: 201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
        "serverX509Names": [
          {
            "name": "ServerCommonName1",
            "issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
          }
        ],
        "maxPartitionResolutionRetries": 5
      }
    }
  }
}

狀態碼:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/certificates/cert1",
        "serverX509Names": [
          {
            "name": "ServerCommonName1",
            "issuerCertificateThumbprint": "IssuerCertificateThumbprint1"
          }
        ],
        "maxPartitionResolutionRetries": 5
      }
    }
  }
}

定義

名稱	Description
BackendAuthorizationHeaderCredentials	授權標頭資訊。
BackendCircuitBreaker	後端斷路器的組態
BackendContract	後端詳細數據。
BackendCredentialsContract	用來連線到後端的認證詳細數據。
BackendPoolItem	後端集區服務資訊
BackendProperties	後端類型特有的屬性。
BackendProtocol	後端通訊協定。
BackendProxyContract	在要求後端中使用的後端 WebProxy 伺服器詳細數據。
BackendServiceFabricClusterProperties	Service Fabric 類型後端的屬性。
BackendTlsProperties	控制 TLS 憑證驗證的屬性。
BackendType	後端的類型。後端可以是單一或集區。
CircuitBreakerFailureCondition	斷路器的行程條件
CircuitBreakerRule	要前往後端的規則組態。
ErrorAdditionalInfo	資源管理錯誤其他資訊。
ErrorDetail	錯誤詳細數據。
ErrorResponse	錯誤回應
FailureStatusCodeRange	失敗 HTTP 狀態代碼範圍
Pool
X509CertificateName	伺服器 X509Names 的屬性。

BackendAuthorizationHeaderCredentials

Object

授權標頭資訊。

名稱	類型	Description
parameter	string minLength: 1 maxLength: 300	驗證參數值。
scheme	string minLength: 1 maxLength: 100	驗證配置名稱。

BackendCircuitBreaker

Object

後端斷路器的組態

名稱	類型	Description
rules	CircuitBreakerRule[]	將後端絆倒的規則。

BackendContract

Object

後端詳細數據。

名稱	類型	Description
id	string	資源的完整資源標識碼。例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	資源的名稱
properties.circuitBreaker	BackendCircuitBreaker	後端斷路器組態
properties.credentials	BackendCredentialsContract	後端認證合約屬性
properties.description	string minLength: 1 maxLength: 2000	後端描述。
properties.pool	Pool
properties.properties	BackendProperties	後端屬性合約
properties.protocol	BackendProtocol	後端通訊協定。
properties.proxy	BackendProxyContract	後端閘道合約屬性
properties.resourceId	string minLength: 1 maxLength: 2000	外部系統中資源的管理 URI。此 URL 可以是 Logic Apps、Function Apps 或 API Apps 的 Arm 資源識別符。
properties.title	string minLength: 1 maxLength: 300	後端標題。
properties.tls	BackendTlsProperties	後端 TLS 屬性
properties.type	BackendType	後端的類型。後端可以是單一或集區。
properties.url	string minLength: 1 maxLength: 2000	後端的運行時間 URL。
type	string	資源的型別。例如“Microsoft.Compute/virtualMachines” 或 “Microsoft.Storage/storageAccounts”

BackendCredentialsContract

Object

用來連線到後端的認證詳細數據。

名稱	類型	Description
authorization	BackendAuthorizationHeaderCredentials	授權標頭驗證
certificate	string[]	用戶端憑證指紋的清單。如果提供 certificatesIds，將會忽略。
certificateIds	string[]	用戶端憑證標識碼的清單。
header	object	標頭參數描述。
query	object	查詢參數描述。

BackendPoolItem

Object

後端集區服務資訊

名稱	類型	Description
id	string (arm-id)	後端實體的唯一 ARM 識別碼。 ARM識別碼應該參考已經存在的後端實體。
priority	integer (int32) minimum: 0 maximum: 100	後端集區中後端實體的優先順序。必須介於 0 到 100 之間。如果未指定值，它也可以是 Null。
weight	integer (int32) minimum: 0 maximum: 100	後端集區中後端實體的權數。必須介於 0 到 100 之間。如果未指定值，它也可以是 Null。

BackendProperties

Object

後端類型特有的屬性。

名稱	類型	Description
serviceFabricCluster	BackendServiceFabricClusterProperties	後端 Service Fabric 叢集屬性

BackendProtocol

列舉型別

後端通訊協定。

值	Description
http	後端是 RESTful 服務。
soap	後端是SOAP服務。

BackendProxyContract

Object

在要求後端中使用的後端 WebProxy 伺服器詳細數據。

名稱	類型	Description
password	string	線上至 WebProxy 伺服器的密碼
url	string minLength: 1 maxLength: 2000	WebProxy Server AbsoluteUri 屬性，其中包含儲存在 Uri 實例中的整個 URI，包括所有片段和查詢字串。
username	string	線上至 WebProxy 伺服器的使用者名稱

BackendServiceFabricClusterProperties

Object

Service Fabric 類型後端的屬性。

名稱	類型	Description
clientCertificateId	string	管理端點的客戶端憑證標識碼。
clientCertificatethumbprint	string	管理端點的客戶端憑證指紋。如果提供 certificatesIds，將會忽略
managementEndpoints	string[]	叢集管理端點。
maxPartitionResolutionRetries	integer (int32)	嘗試解析分割區時重試次數上限。
serverCertificateThumbprints	string[]	叢集管理服務用於 tls 通訊的憑證指紋
serverX509Names	X509CertificateName[]	伺服器 X509 憑證名稱集合

BackendTlsProperties

Object

控制 TLS 憑證驗證的屬性。

名稱	類型	預設值	Description
validateCertificateChain	boolean	True	旗標，指出使用此後端主機的自我簽署憑證時，是否應該完成 SSL 憑證鏈結驗證。
validateCertificateName	boolean	True	旗標，指出使用此後端主機的自我簽署憑證時，是否應該完成SSL憑證名稱驗證。

BackendType

列舉型別

後端的類型。後端可以是單一或集區。

值	Description
Pool	支援集區後端
Single	支援單一後端

CircuitBreakerFailureCondition

Object

斷路器的行程條件

名稱	類型	Description
count	integer (int64)	開啟線路的臨界值。
errorReasons	string[] maxLength: 200	被視為失敗的錯誤原因。
interval	string (duration)	計算失敗的間隔。
percentage	integer (int64)	開啟線路的臨界值。
statusCodeRanges	FailureStatusCodeRange[]	被視為失敗的狀態代碼範圍。

CircuitBreakerRule

Object

要前往後端的規則組態。

名稱	類型	Description
acceptRetryAfter	boolean	旗標，以接受來自後端 Retry-After 標頭。
failureCondition	CircuitBreakerFailureCondition	斷路器的絆倒條件。
name	string	規則名稱。
tripDuration	string (duration)	將嘗試線路的持續時間。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱	類型	Description
info	object	其他資訊。
type	string	其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱	類型	Description
additionalInfo	ErrorAdditionalInfo[]	錯誤其他資訊。
code	string	錯誤碼。
details	ErrorDetail[]	錯誤詳細數據。
message	string	錯誤訊息。
target	string	錯誤目標。

ErrorResponse

Object

錯誤回應

名稱	類型	Description
error	ErrorDetail	error 物件。

FailureStatusCodeRange

Object

失敗 HTTP 狀態代碼範圍

名稱	類型	Description
max	integer (int32) minimum: 200 maximum: 599	HTTP 狀態代碼上限。
min	integer (int32) minimum: 200 maximum: 599	HTTP 狀態代碼下限。

Pool

Object

名稱	類型	Description
services	BackendPoolItem[]	屬於集區的後端實體清單。

X509CertificateName

Object

伺服器 X509Names 的屬性。

名稱	類型	Description
issuerCertificateThumbprint	string	憑證簽發者的指紋。
name	string	憑證的一般名稱。

共用方式為

Backend - Create Or Update

URI 參數

要求標頭

要求本文

回應

安全性

azure_auth

範圍

範例

ApiManagementCreateBackendProxyBackend

範例要求

範例回覆

ApiManagementCreateBackendServiceFabric

範例要求

範例回覆

定義

BackendAuthorizationHeaderCredentials

BackendCircuitBreaker

BackendContract

BackendCredentialsContract

BackendPoolItem

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

BackendType

CircuitBreakerFailureCondition

CircuitBreakerRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailureStatusCodeRange

Pool

X509CertificateName

其他資源