Backend - Update

リファレンス

サービス:: API Management

API バージョン:: 2024-05-01

既存のバックエンドを更新します。

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

URI パラメーター

名前	/	必須	型	説明
backendId	path	True	string minLength: 1 maxLength: 80	バックエンドエンティティの識別子。現在の API Management サービスインスタンスで一意である必要があります。
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 Management サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
If-Match	True	string	エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティの状態と一致するか、無条件更新の場合は * にする必要があります。

要求本文

名前	型	説明
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 リソース ID を指定できます。
properties.title	string minLength: 1 maxLength: 300	バックエンドタイトル。
properties.tls	BackendTlsProperties	バックエンド TLS プロパティ
properties.type	BackendType	バックエンドの種類。バックエンドには、単一またはプールのいずれかを指定できます。
properties.url	string minLength: 1 maxLength: 2000	バックエンドのランタイム URL。

応答

名前	型	説明
200 OK	BackendContract	既存のバックエンドが正常に更新されました。ヘッダー ETag: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

BackendContract

既存のバックエンドが正常に更新されました。

ヘッダー

ETag: string

Other Status Codes

ErrorResponse

操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

ApiManagementUpdateBackend

要求のサンプル

HTTP

PATCH 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",
    "tls": {
      "validateCertificateChain": false,
      "validateCertificateName": true
    }
  }
}

応答のサンプル

状態コード:: 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": true
    }
  }
}

定義

名前	説明
BackendAuthorizationHeaderCredentials	承認ヘッダー情報。
BackendCircuitBreaker	バックエンドサーキットブレーカーの構成
BackendContract	バックエンドの詳細。
BackendCredentialsContract	バックエンドへの接続に使用される資格情報の詳細。
BackendPoolItem	バックエンドプールサービス情報
BackendProperties	バックエンドの種類に固有のプロパティ。
BackendProtocol	バックエンド通信プロトコル。
BackendProxyContract	バックエンドへの要求で使用するバックエンド WebProxy サーバーの詳細。
BackendServiceFabricClusterProperties	Service Fabric タイプバックエンドのプロパティ。
BackendTlsProperties	TLS 証明書の検証を制御するプロパティ。
BackendType	バックエンドの種類。バックエンドには、単一またはプールのいずれかを指定できます。
BackendUpdateParameters	バックエンド更新パラメーター。
CircuitBreakerFailureCondition	サーキットブレーカーのトリップ条件
CircuitBreakerRule	バックエンドをトリップするためのルール構成。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
FailureStatusCodeRange	エラー http 状態コードの範囲
Pool
X509CertificateName	サーバー X509Names のプロパティ。

BackendAuthorizationHeaderCredentials

Object

承認ヘッダー情報。

名前	型	説明
parameter	string minLength: 1 maxLength: 300	認証パラメーターの値。
scheme	string minLength: 1 maxLength: 100	認証スキーム名。

BackendCircuitBreaker

Object

バックエンドサーキットブレーカーの構成

名前	型	説明
rules	CircuitBreakerRule[]	バックエンドをトリップするための規則。

BackendContract

Object

バックエンドの詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /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 リソース ID を指定できます。
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

バックエンドへの接続に使用される資格情報の詳細。

名前	型	説明
authorization	BackendAuthorizationHeaderCredentials	承認ヘッダー認証
certificate	string[]	クライアント証明書の拇印の一覧。 certificatesId が指定されている場合は無視されます。
certificateIds	string[]	クライアント証明書 ID の一覧。
header	object	ヘッダーパラメーターの説明。
query	object	クエリパラメーターの説明。

BackendPoolItem

Object

バックエンドプールサービス情報

名前	型	説明
id	string (arm-id)	バックエンドエンティティの一意の ARM ID。 ARM ID は、既存のバックエンドエンティティを参照する必要があります。
priority	integer (int32) minimum: 0 maximum: 100	バックエンドプール内のバックエンドエンティティの優先順位。 0 ~ 100 の間である必要があります。値が指定されていない場合は null にすることもできます。
weight	integer (int32) minimum: 0 maximum: 100	バックエンドプール内のバックエンドエンティティの重み。 0 ~ 100 の間である必要があります。値が指定されていない場合は null にすることもできます。

BackendProperties

Object

バックエンドの種類に固有のプロパティ。

名前	型	説明
serviceFabricCluster	BackendServiceFabricClusterProperties	バックエンド Service Fabric クラスターのプロパティ

BackendProtocol

列挙

バックエンド通信プロトコル。

値	説明
http	バックエンドは RESTful サービスです。
soap	バックエンドは SOAP サービスです。

BackendProxyContract

Object

バックエンドへの要求で使用するバックエンド WebProxy サーバーの詳細。

名前	型	説明
password	string	WebProxy サーバーに接続するためのパスワード
url	string minLength: 1 maxLength: 2000	すべてのフラグメントとクエリ文字列を含む、Uri インスタンスに格納されている URI 全体を含む WebProxy Server AbsoluteUri プロパティ。
username	string	WebProxy サーバーに接続するためのユーザー名

BackendServiceFabricClusterProperties

Object

Service Fabric タイプバックエンドのプロパティ。

名前	型	説明
clientCertificateId	string	管理エンドポイントのクライアント証明書 ID。
clientCertificatethumbprint	string	管理エンドポイントのクライアント証明書の拇印。 certificatesId が指定されている場合は無視されます
managementEndpoints	string[]	クラスター管理エンドポイント。
maxPartitionResolutionRetries	integer (int32)	パーティションの解決を試みている間の再試行の最大数。
serverCertificateThumbprints	string[]	クラスター管理サービスが TLS 通信に使用する証明書の拇印
serverX509Names	X509CertificateName[]	Server X509 証明書名コレクション

BackendTlsProperties

Object

TLS 証明書の検証を制御するプロパティ。

名前	型	規定値	説明
validateCertificateChain	boolean	True	このバックエンドホストで自己署名証明書を使用するときに SSL 証明書チェーンの検証を行う必要があるかどうかを示すフラグ。
validateCertificateName	boolean	True	このバックエンドホストに自己署名証明書を使用するときに SSL 証明書名の検証を行う必要があるかどうかを示すフラグ。

BackendType

列挙

バックエンドの種類。バックエンドには、単一またはプールのいずれかを指定できます。

値	説明
Pool	はプールバックエンドをサポートします
Single	では、単一バックエンドがサポートされます

BackendUpdateParameters

Object

バックエンド更新パラメーター。

名前	型	説明
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 リソース ID を指定できます。
properties.title	string minLength: 1 maxLength: 300	バックエンドタイトル。
properties.tls	BackendTlsProperties	バックエンド TLS プロパティ
properties.type	BackendType	バックエンドの種類。バックエンドには、単一またはプールのいずれかを指定できます。
properties.url	string minLength: 1 maxLength: 2000	バックエンドのランタイム URL。

CircuitBreakerFailureCondition

Object

サーキットブレーカーのトリップ条件

名前	型	説明
count	integer (int64)	回路を開くしきい値。
errorReasons	string[] maxLength: 200	エラーと見なされるエラーの理由。
interval	string (duration)	エラーがカウントされる間隔。
percentage	integer (int64)	回路を開くしきい値。
statusCodeRanges	FailureStatusCodeRange[]	エラーと見なされる状態コードの範囲。

CircuitBreakerRule

Object

バックエンドをトリップするためのルール構成。

名前	型	説明
acceptRetryAfter	boolean	バックエンドからヘッダー Retry-After 受け入れるフラグ。
failureCondition	CircuitBreakerFailureCondition	サーキットブレーカーをトリップするための条件。
name	string	ルール名。
tripDuration	string (duration)	回線がトリップする期間。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

FailureStatusCodeRange

Object

エラー http 状態コードの範囲

名前	型	説明
max	integer (int32) minimum: 200 maximum: 599	最大 http 状態コード。
min	integer (int32) minimum: 200 maximum: 599	http 状態の最小コード。

Pool

Object

名前	型	説明
services	BackendPoolItem[]	プールに属するバックエンドエンティティの一覧。

X509CertificateName

Object

サーバー X509Names のプロパティ。

名前	型	説明
issuerCertificateThumbprint	string	証明書の発行者の拇印。
name	string	証明書の共通名。

次の方法で共有

Backend - Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementUpdateBackend

要求のサンプル

応答のサンプル

定義

BackendAuthorizationHeaderCredentials

BackendCircuitBreaker

BackendContract

BackendCredentialsContract

BackendPoolItem

BackendProperties

BackendProtocol

BackendProxyContract

BackendServiceFabricClusterProperties

BackendTlsProperties

BackendType

BackendUpdateParameters

CircuitBreakerFailureCondition

CircuitBreakerRule

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

FailureStatusCodeRange

Pool

X509CertificateName

その他のリソース