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.
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, используемая для этой операции.

Заголовок запроса

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

Поток 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/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	Сведения о сервере Backend 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	Полный идентификатор ресурса для ресурса. Ex - /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-адрес может быть идентификатором ресурса Arm logic Apps, приложений-функций или приложений API.
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[]	Список отпечаток сертификата клиента. Будет игнорироваться, если указаны сертификаты.
certificateIds	string[]	Список идентификаторов сертификата клиента.
header	object	Описание параметра заголовка.
query	object	Описание параметра запроса.

BackendPoolItem

Object

Сведения о службе внутреннего пула

Имя	Тип	Описание
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

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

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

BackendProtocol

Перечисление

Внутренний протокол связи.

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

BackendProxyContract

Object

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

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

BackendServiceFabricClusterProperties

Object

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

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

BackendTlsProperties

Object

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

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

Дополнительные ресурсы