Backend - Update

Служба:

API Management

Версия API:

2021-08-01

Обновления существующую серверную часть.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
backendId	path	True	string	Идентификатор сущности Backend. Должен быть уникальным в текущем экземпляре службы Управление API.
resourceGroupName	path	True	string	Имя группы ресурсов.
serviceName	path	True	string	Имя службы Управление API. Шаблон регулярного выражения: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Учетные данные подписки, которые однозначно идентифицируют подписку Microsoft Azure. Идентификатор подписки формирует часть URI для каждого вызова службы.
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-адрес может быть идентификатором ресурса Arm приложений логики, приложений-функций или приложений API.
properties.title	string	Заголовок серверной части.
properties.tls	BackendTlsProperties	Свойства TLS серверной части
properties.url	string	URL-адрес среды выполнения серверной части.

Ответы

Имя	Тип	Описание
200 OK	BackendContract	Существующая серверная часть успешно обновлена. Заголовки ETag: string
Other Status Codes	ErrorResponse	Ответ об ошибке, описывающий причину сбоя операции.

Безопасность

azure_auth

Поток OAuth2 в Azure Active Directory.

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/authorize

Области

Имя	Описание
user_impersonation	олицетворения учетной записи пользователя

Примеры

ApiManagementUpdateBackend

Образец запроса

HTTP

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/backends/proxybackend?api-version=2021-08-01


{
  "properties": {
    "description": "description5308",
    "tls": {
      "validateCertificateChain": false,
      "validateCertificateName": true
    }
  }
}

Java

import com.azure.core.util.Context;
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/2021-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", 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 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/2021-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"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-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/2021-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

dotnet

using System;
using System.Threading.Tasks;
using System.Xml;
using Azure;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager;
using Azure.ResourceManager.ApiManagement;
using Azure.ResourceManager.ApiManagement.Models;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateBackend.json
// this example is just showing the usage of "Backend_Update" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementBackendResource created on azure
// for more information of creating ApiManagementBackendResource, please refer to the document of ApiManagementBackendResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
string backendId = "proxybackend";
ResourceIdentifier apiManagementBackendResourceId = ApiManagementBackendResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, backendId);
ApiManagementBackendResource apiManagementBackend = client.GetApiManagementBackendResource(apiManagementBackendResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
ApiManagementBackendPatch patch = new ApiManagementBackendPatch()
{
    Description = "description5308",
    Tls = new BackendTlsProperties()
    {
        ShouldValidateCertificateChain = false,
        ShouldValidateCertificateName = true,
    },
};
ApiManagementBackendResource result = await apiManagementBackend.UpdateAsync(ifMatch, patch);

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementBackendData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

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

Пример ответа

Код состояния:

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	Сведения о серверном веб-сервере для использования в запросе к серверной части.
BackendServiceFabricClusterProperties	Свойства серверной части типа Service Fabric.
BackendTlsProperties	Свойства, управляющие проверкой сертификата TLS.
BackendUpdateParameters	Параметры обновления серверной части.
ErrorFieldContract	Контракт поля ошибки.
ErrorResponse	Ответ об ошибке.
X509CertificateName	Свойства сервера X509Names.

BackendAuthorizationHeaderCredentials

Сведения о заголовке авторизации.

Имя	Тип	Описание
parameter	string	Значение параметра проверки подлинности.
scheme	string	Имя схемы проверки подлинности.

BackendContract

Сведения о серверной части.

Имя	Тип	Описание
id	string	Полный идентификатор ресурса. Например: /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-адрес может быть идентификатором ресурса Arm приложений логики, приложений-функций или приложений API.
properties.title	string	Заголовок серверной части.
properties.tls	BackendTlsProperties	Свойства TLS серверной части
properties.url	string	URL-адрес среды выполнения серверной части.
type	string	Тип ресурса. Например, Microsoft.Compute/virtualMachines или Microsoft.Storage/storageAccounts.

BackendCredentialsContract

Сведения об учетных данных, используемых для подключения к серверной части.

Имя	Тип	Описание
authorization	BackendAuthorizationHeaderCredentials	Проверка подлинности заголовка авторизации
certificate	string[]	Список отпечатков сертификатов клиента. Игнорируется, если указаны идентификаторы сертификатов.
certificateIds	string[]	Список идентификаторов сертификатов клиента.
header	object	Описание параметра заголовка.
query	object	Описание параметра запроса.

BackendProperties

Свойства, относящиеся к типу серверной части.

Имя	Тип	Описание
serviceFabricCluster	BackendServiceFabricClusterProperties	Свойства кластера Service Fabric серверной части

BackendProtocol

Серверный протокол связи.

Имя	Тип	Описание
http	string	Серверная часть — это служба RESTful.
soap	string	Серверная часть — это служба SOAP.

BackendProxyContract

Сведения о серверном веб-сервере для использования в запросе к серверной части.

Имя	Тип	Описание
password	string	Пароль для подключения к серверу WebProxy
url	string	Свойство AbsoluteUri сервера WebProxy, которое включает весь URI, хранящийся в экземпляре URI, включая все фрагменты и строки запроса.
username	string	Имя пользователя для подключения к серверу WebProxy

BackendServiceFabricClusterProperties

Свойства серверной части типа Service Fabric.

Имя	Тип	Описание
clientCertificateId	string	Идентификатор сертификата клиента для конечной точки управления.
clientCertificatethumbprint	string	Отпечаток сертификата клиента для конечной точки управления. Игнорируется, если указаны идентификаторы сертификатов
managementEndpoints	string[]	Конечная точка управления кластером.
maxPartitionResolutionRetries	integer	Максимальное число повторных попыток при попытке разрешения секции.
serverCertificateThumbprints	string[]	Отпечатки сертификатов, которые служба управления кластером использует для обмена данными по протоколу TLS
serverX509Names	X509CertificateName[]	Коллекция имен сертификатов X509 server

BackendTlsProperties

Свойства, управляющие проверкой сертификата TLS.

Имя	Тип	Default value	Описание
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-адрес может быть идентификатором ресурса Arm приложений логики, приложений-функций или приложений API.
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	Общее имя сертификата.