Поделиться через

Backend - Reconnect

  • Ссылка
Служба:
API Management
Версия API:
2024-05-01

Уведомляет шлюз управления API создать новое подключение к серверной части после указанного времени ожидания. Если время ожидания не задано, используется время ожидания в течение 2 минут.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendId}/reconnect?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, используемая для этой операции.

Текст запроса

Имя Тип Описание
properties.after

string (duration)

Длительность в формате ISO8601, после чего будет инициировано повторное подключение. Минимальная длительность повторного подключения — PT2M.

Ответы

Имя Тип Описание
202 Accepted

Запрос повторного подключения принят.
Other Status Codes

ErrorResponse

Ответ на ошибку, описывающий причину сбоя операции.

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

azure_auth

Поток OAuth2 Azure Active Directory.

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

Области

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

Примеры

ApiManagementBackendReconnect

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

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

{
  "properties": {
    "after": "PT3S"
  }
}

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

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

Определения

Имя Описание
BackendReconnectContract

Параметры запроса повторного подключения.
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Сведения об ошибке.
ErrorResponse

Ответ на ошибку

BackendReconnectContract

Object

Параметры запроса повторного подключения.

Имя Тип Описание
id

string

Полный идентификатор ресурса для ресурса. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name

string

Имя ресурса
properties.after

string (duration)

Длительность в формате ISO8601, после чего будет инициировано повторное подключение. Минимальная длительность повторного подключения — PT2M.
type

string

Тип ресурса. Например, "Microsoft.Compute/virtualMachines" или "Microsoft.Storage/storageAccounts"

ErrorAdditionalInfo

Object

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

object

Дополнительные сведения.
type

string

Дополнительный тип сведений.

ErrorDetail

Object

Сведения об ошибке.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Object

Ответ на ошибку

Имя Тип Описание
error

ErrorDetail

Объект ошибки.