Backend - Update

Service:

API Management

API Version:

2022-08-01

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

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

URI パラメーター

名前	/	必須	型	説明
backendId	path	True	string	バックエンド エンティティの識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
resourceGroupName	path	True	string	リソース グループの名前。 名前の大文字と小文字は区別されます。
serviceName	path	True	string	API Management サービスの名前。 Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	ターゲット サブスクリプションの ID。
api-version	query	True	string	この操作に使用する API バージョン。

要求ヘッダー

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

要求本文

名前	型	説明
properties.credentials	BackendCredentialsContract	バックエンド資格情報コントラクトのプロパティ
properties.description	string	バックエンドの説明。
properties.properties	BackendProperties	バックエンド プロパティ コントラクト
properties.protocol	BackendProtocol	バックエンド通信プロトコル。
properties.proxy	BackendProxyContract	バックエンド ゲートウェイ コントラクトのプロパティ
properties.resourceId	string	外部システムのリソースの管理 URI。 この URL には、Logic Apps、Function Apps、または API Apps の Arm リソース ID を指定できます。
properties.title	string	バックエンド タイトル。
properties.tls	BackendTlsProperties	バックエンド TLS プロパティ
properties.url	string	バックエンドのランタイム URL。

応答

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前	説明
user_impersonation	ユーザー アカウントの借用

例

ApiManagementUpdateBackend

Sample Request

HTTP

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
    }
  }
}

Java

import com.azure.resourcemanager.apimanagement.models.BackendContract;
import com.azure.resourcemanager.apimanagement.models.BackendTlsProperties;

/** Samples for Backend Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateBackend.json
     */
    /**
     * Sample code: ApiManagementUpdateBackend.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateBackend(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        BackendContract resource =
            manager
                .backends()
                .getWithResponse("rg1", "apimService1", "proxybackend", com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withDescription("description5308")
            .withTls(new BackendTlsProperties().withValidateCertificateChain(false).withValidateCertificateName(true))
            .withIfMatch("*")
            .apply();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_update_backend.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="subid",
    )

    response = client.backend.update(
        resource_group_name="rg1",
        service_name="apimService1",
        backend_id="proxybackend",
        if_match="*",
        parameters={
            "properties": {
                "description": "description5308",
                "tls": {"validateCertificateChain": False, "validateCertificateName": True},
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateBackend.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateBackend.json
func ExampleBackendClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewBackendClient().Update(ctx, "rg1", "apimService1", "proxybackend", "*", armapimanagement.BackendUpdateParameters{
		Properties: &armapimanagement.BackendUpdateParameterProperties{
			Description: to.Ptr("description5308"),
			TLS: &armapimanagement.BackendTLSProperties{
				ValidateCertificateChain: to.Ptr(false),
				ValidateCertificateName:  to.Ptr(true),
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.BackendContract = armapimanagement.BackendContract{
	// 	Name: to.Ptr("proxybackend"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/backends"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend"),
	// 	Properties: &armapimanagement.BackendContractProperties{
	// 		Description: to.Ptr("description5308"),
	// 		Credentials: &armapimanagement.BackendCredentialsContract{
	// 			Authorization: &armapimanagement.BackendAuthorizationHeaderCredentials{
	// 				Parameter: to.Ptr("opensesma"),
	// 				Scheme: to.Ptr("Basic"),
	// 			},
	// 			Header: map[string][]*string{
	// 				"x-my-1": []*string{
	// 					to.Ptr("val1"),
	// 					to.Ptr("val2")},
	// 				},
	// 				Query: map[string][]*string{
	// 					"sv": []*string{
	// 						to.Ptr("xx"),
	// 						to.Ptr("bb"),
	// 						to.Ptr("cc")},
	// 					},
	// 				},
	// 				Proxy: &armapimanagement.BackendProxyContract{
	// 					Password: to.Ptr("<password>"),
	// 					URL: to.Ptr("http://192.168.1.1:8080"),
	// 					Username: to.Ptr("Contoso\\admin"),
	// 				},
	// 				TLS: &armapimanagement.BackendTLSProperties{
	// 					ValidateCertificateChain: to.Ptr(false),
	// 					ValidateCertificateName: to.Ptr(true),
	// 				},
	// 				URL: to.Ptr("https://backendname2644/"),
	// 				Protocol: to.Ptr(armapimanagement.BackendProtocolHTTP),
	// 			},
	// 		}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Updates an existing backend.
 *
 * @summary Updates an existing backend.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateBackend.json
 */
async function apiManagementUpdateBackend() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const backendId = "proxybackend";
  const ifMatch = "*";
  const parameters = {
    description: "description5308",
    tls: { validateCertificateChain: false, validateCertificateName: true },
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.backend.update(
    resourceGroupName,
    serviceName,
    backendId,
    ifMatch,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample Response

Status code:

200

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

定義

名前	説明
BackendAuthorizationHeaderCredentials	承認ヘッダー情報。
BackendContract	バックエンドの詳細。
BackendCredentialsContract	バックエンドへの接続に使用される資格情報の詳細。
BackendProperties	バックエンドの種類に固有のプロパティ。
BackendProtocol	バックエンド通信プロトコル。
BackendProxyContract	バックエンドへの要求で使用するバックエンド WebProxy サーバーの詳細。
BackendServiceFabricClusterProperties	Service Fabric の種類バックエンドのプロパティ。
BackendTlsProperties	TLS 証明書の検証を制御するプロパティ。
BackendUpdateParameters	バックエンド更新パラメーター。
ErrorFieldContract	エラー フィールド コントラクト。
ErrorResponse	エラー応答。
X509CertificateName	サーバー X509Names のプロパティ。

BackendAuthorizationHeaderCredentials

承認ヘッダー情報。

名前	型	説明
parameter	string	認証パラメーターの値。
scheme	string	認証スキーム名。

BackendContract

バックエンドの詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.credentials	BackendCredentialsContract	バックエンド資格情報コントラクトのプロパティ
properties.description	string	バックエンドの説明。
properties.properties	BackendProperties	バックエンド プロパティ コントラクト
properties.protocol	BackendProtocol	バックエンド通信プロトコル。
properties.proxy	BackendProxyContract	バックエンド ゲートウェイ コントラクトのプロパティ
properties.resourceId	string	外部システムのリソースの管理 URI。 この URL には、Logic Apps、Function Apps、または API Apps の Arm リソース ID を指定できます。
properties.title	string	バックエンド タイトル。
properties.tls	BackendTlsProperties	バックエンド TLS プロパティ
properties.url	string	バックエンドのランタイム URL。
type	string	リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

BackendCredentialsContract

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

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

BackendProperties

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

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

BackendProtocol

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

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

BackendProxyContract

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

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

BackendServiceFabricClusterProperties

Service Fabric の種類バックエンドのプロパティ。

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

BackendTlsProperties

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

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

BackendUpdateParameters

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

名前	型	説明
properties.credentials	BackendCredentialsContract	バックエンド資格情報コントラクトのプロパティ
properties.description	string	バックエンドの説明。
properties.properties	BackendProperties	バックエンド プロパティ コントラクト
properties.protocol	BackendProtocol	バックエンド通信プロトコル。
properties.proxy	BackendProxyContract	バックエンド ゲートウェイ コントラクトのプロパティ
properties.resourceId	string	外部システムのリソースの管理 URI。 この URL には、Logic Apps、Function Apps、または API Apps の Arm リソース ID を指定できます。
properties.title	string	バックエンド タイトル。
properties.tls	BackendTlsProperties	バックエンド TLS プロパティ
properties.url	string	バックエンドのランタイム URL。

ErrorFieldContract

エラー フィールド コントラクト。

名前	型	説明
code	string	プロパティ レベルのエラー コード。
message	string	プロパティ レベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

エラー応答。

名前	型	説明
error.code	string	サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message	string	人が判読できるエラーの表現。

X509CertificateName

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

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