Мягкое удаление в API Management

ПРИМЕНЯЕТСЯ КО ВСЕМ уровням управления API

Используя функцию мягкого удаления в Управлении API, вы можете вернуть и восстановить недавно удаленный экземпляр. Эта функция защищает от случайного удаления экземпляра службы управления API.

Вспомогательные интерфейсы

Вы можете восстановить и выполнить другие операции с мягко удалённым экземпляром с помощью REST API версии 2020-06-01-preview или более поздней, Azure CLI или Пакета Azure SDK для .NET, Go или Python.

Подсказка

Операция Description Пространство имен управления API Минимальная версия API
Создание или обновление Создает или обновляет службу управления API. Служба Управления API Любое
Создать или обновить с установкой свойства restore Восстанавливает службу управления API, если она была ранее мягко удалена. Если restore задано и установлено в true, все остальные свойства игнорируются. Служба Управления API 2020-06-01-preview
Удалить Удаляет существующую службу управления API. Служба Управления API 2020-06-01-preview
Получение по имени Получить мягко удаленную службу управления API по имени. Удаленные услуги 2020-06-01-preview
Список по подписке Список всех обратимо удаленных служб, доступных для восстановления для данной подписки. Удаленные услуги 2020-06-01-preview
Чистка Очищает службу управления API (окончательно удаляет ее без возможности отмены). Удаленные услуги 2020-06-01-preview

Поведение обратимого удаления

Для создания экземпляра службы управления API можно использовать любую версию API. При использовании портала Azure, REST API Azure или другого средства Azure с версией API 2020-06-01-preview или более поздней для удаления экземпляра службы "Управление API", экземпляр автоматически мягко удаляется.

При мягком удалении экземпляра службы управления API, служба переходит в состояние удаления и становится недоступной для обычных операций управления API.

В состоянии мягкого удаления

  • Вы можете только создать список, восстановить или удалить (окончательно удалить) экземпляр API Management.
  • Azure планирует постоянное удаление базовых данных для экземпляра управления API после предопределенного 48-часового периода хранения.
  • Нельзя повторно использовать имя экземпляра службы управления API.

Если вы не восстанавливаете или не очищаете экземпляр службы управления API в течение 48 часов, экземпляр окончательно удаляется.

Перечислить удаленные экземпляры управления API

Вы можете проверить, доступен ли экземпляр API Management, подвергшийся мягкому удалению, для восстановления, используя операции Deleted Services Get By Name или List By Subscription.

Получить мягко удаленный экземпляр по имени

Используйте операцию "Получение по имени в Управлении API", заменяя {subscriptionId}, {location}, и {serviceName} на вашу подписку Azure, имя расположения ресурсов, и имя экземпляра Управления API:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/deletedservices/{serviceName}?api-version=2024-05-01

Если экземпляр службы управления API доступен для отмены, Azure возвращает запись экземпляра, отображающего его deletionDate и scheduledPurgeDate. Например, REST API возвращает выходные данные, аналогичные этому:

{
    "id": "subscriptions/bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f/providers/Microsoft.ApiManagement/locations/southcentralus/deletedservices/apimtest",
    "name": "apimtest",
    "type": "Microsoft.ApiManagement/deletedservices",
    "location": "South Central US",
    "properties": {
        "serviceId": "/subscriptions/bbbb1b1b-cc2c-dd3d-ee4e-ffffff5f5f5f/resourceGroups/apimtestgroup/providers/Microsoft.ApiManagement/service/apimtest",
        "scheduledPurgeDate": "2024-11-26T19:40:26.3596893Z",
        "deletionDate": "2024-11-24T19:40:50.1013572Z"
    }
}

Список всех мягко удаленных экземпляров для данной подписки

Используйте операцию управления API List By Subscription, заменив {subscriptionId} вашим идентификатором подписки:

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/deletedservices?api-version=2024-05-01

Эта команда возвращает список всех временно удаленных служб, которые можно восстановить в пределах данной подписки. В нем показаны deletionDate и scheduledPurgeDate для каждого сервиса.

Восстановление обратимого удаленного экземпляра

Используйте операцию Создать или обновить управления API, заменив {subscriptionId}, {resourceGroup} и {apimServiceName} на подписку Azure, имя группы ресурсов и имя управления API соответственно.

PUT
https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}/providers/Microsoft.ApiManagement/service/{apimServiceName}?api-version=2024-05-01

В теле запроса задайте значение свойства restore на true. (Если этот флаг указан и задан значение true, все остальные свойства игнорируются.) Например:

{
  "properties": {
    "publisherEmail": "help@contoso.com",
    "publisherName": "Contoso",
    "restore": true
  },
  "sku": {
    "name": "Developer",
    "capacity": 1
  },
  "location": "South Central US"
}

Очистка обратимого удаленного экземпляра

Замечание

Для удаления помеченного на удаление экземпляра необходимо иметь следующие разрешения на управление доступом на основе ролей (RBAC) в рамках подписки, а также права участника на экземпляр управления API: Microsoft.ApiManagement/locations/deletedservices/delete, Microsoft.ApiManagement/deletedservices/read.

Используйте операцию Purge управления API, заменив {subscriptionId}, {location}, и {serviceName} на вашу подписку Azure, расположение ресурса и имя управления API.

DELETE https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/locations/{location}/deletedservices/{serviceName}?api-version=2024-05-01

Эта команда окончательно удаляет экземпляр службы "Управление API" из Azure.

Повторное использование имени экземпляра службы управления API после удаления

Вы можете повторно использовать имя экземпляра службы управления API в новом развертывании:

  • После окончательного удаления экземпляра из Azure без возможности восстановления.

  • В той же подписке, что и исходный экземпляр.

В новом развертывании нельзя повторно использовать имя экземпляра службы управления API:

  • Хотя экземпляр помечен как удалённый.

  • В подписке, отличной от той, которая использовалась для развертывания исходного экземпляра, даже после окончательного удаления (очистки) исходного экземпляра из Azure. Это ограничение применяется к тому, находится ли новая подписка в одном или другом клиенте Microsoft Entra. Ограничение действует в течение нескольких дней или дольше после удаления в зависимости от типа подписки.

    Это ограничение существует, так как Azure резервирует имя узла службы клиентскому тенанту на период резервации, чтобы предотвратить захват поддомена из-за "висящих" записей DNS. Дополнительные сведения см. в разделе «Предотвращение болтающихся записей DNS и предотвращение захвата поддомена». Чтобы просмотреть все "висячие" DNS-записи для подписок в тенанте Microsoft Entra, см. статью "Определение висячих DNS-записей".

Связанный контент

Сведения о долгосрочных вариантах резервного копирования и восстановления службы управления API:

  • Последнее обновление: