Leer en inglés

Compartir a través de

Eliminación temporal de API Management (versión preliminar)

  • Artículo

SE APLICA A: todos los niveles de API Management

Con la eliminación temporal de API Management, puede recuperar y restaurar una instancia de API Management eliminada recientemente. Esta característica protege contra la eliminación accidental de la API Management predeterminada.

Actualmente, en función de cómo elimine una instancia de API Management, dicha instancia se elimina temporalmente y se puede recuperar durante un período de retención o se elimina permanentemente:

  • Cuando se usa Azure Portal o la versión de API REST 2020-06-01-preview o posterior para eliminar una instancia de API Management, se elimina de forma temporal.
  • Una API Management que se eliminó mediante una versión de API REST antes de 2020-06-01-preview se elimina de forma permanente.
  • Una instancia de API Management que se elimina mediante los comandos de API Management de Azure PowerShell o CLI de Azure se elimina temporalmente.

Interfaces admitidas

La recuperación y otras operaciones en una instancia eliminada temporalmente se habilitan a través de la versión de API REST2020-06-01-preview o posterior, o el SDK de Azure para .NET, Go o Python.

Sugerencia

Consulte Referencia de la API de REST de Azure para obtener sugerencias y herramientas para llamar a las API de REST de Azure y API Management REST para obtener información adicional específica de API Management.

Operación Descripción Espacio de nombres de API Management Versión mínima de la API
Create or Update (Crear o actualizar) Crea o actualiza un servicio API Management. Servicio API Management Any
Create or Update (Crear o actualizar) con la propiedad restore establecida en true Recupera un servicio API Management si se ha eliminado temporalmente con anterioridad. Si se especifica restore y se establece en true se omitirán todas las demás propiedades. Servicio API Management 2020-06-01-preview
Eliminar Elimina un servicio API Management existente. Servicio API Management 2020-06-01-preview
Get By Name (Obtener por nombre) Obtiene el servicio API Management eliminado temporalmente por el nombre. Servicios eliminados 2020-06-01-preview
List By Subscription (Enumerar por suscripción) Enumera todos los servicios eliminados temporalmente que están disponibles para recuperarse en la suscripción especificada. Servicios eliminados 2020-06-01-preview
Purgar Purga el servicio API Management (lo elimina permanentemente sin opción de recuperar). Servicios eliminados 2020-06-01-preview

Comportamiento de eliminación temporal

Puede usar cualquier versión de API para crear la instancia de API Management. Cuando se usa Azure Portal, la API REST de Azure u otra herramienta de Azure mediante la versión de API 2020-06-01-preview o posterior para eliminar una instancia de API Management, se elimina temporalmente de manera automática.

Tras eliminar temporalmente una API Management, el servicio existirá en un estado eliminado, lo que hará que no sea accesible a las operaciones de API Management normales.

En el estado de eliminación temporal:

  • La instancia de API Management se puede enumerar, recuperar o purgar (eliminar permanentemente).
  • Azure programará la eliminación permanente de los datos subyacentes correspondientes a la instancia de API Management después del período de retención predeterminado (48 horas).
  • No se puede volver a usar el nombre de la instancia de API Management.

Si la instancia de API Management no se recupera ni purga en un plazo de 48 horas, se elimina automáticamente de forma permanente.

Enumeración de las instancias de API Management eliminadas

Puede comprobar que una instancia de API Management eliminada temporalmente está disponible para restaurarse (recuperarse) mediante las operaciones Get By Name (Obtener por nombre) o List By Subscription (Enumerar por suscripción) de los servicios eliminados.

Obtención de una instancia eliminada temporalmente por nombre

Use la operación Get By Name (Obtener por nombre) de API Management, pero sustituya {subscriptionId}, {location} y {serviceName} por la suscripción de Azure, el nombre de la ubicación del recurso y el nombre de la instancia de API Management:

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

Si está disponible para la recuperación, Azure devolverá un registro de la instancia de API Management que muestra su valor de deletionDate y scheduledPurgeDate, por ejemplo:

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

Enumeración de todas las instancias eliminadas temporalmente de una suscripción determinada

Use la operación List By Subscription (Enumerar por suscripción) de API Management, pero sustituya {subscriptionId} por su identificador de suscripción:

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

Se devolverá una lista de todos los servicios eliminados temporalmente que están disponibles para recuperarse en la suscripción dada, donde se muestran los valores de deletionDate y scheduledPurgeDate para cada uno.

Recuperación de una instancia eliminada temporalmente

Use la operación Create Or Update (Crear o actualizar) de API Management, pero sustituya {subscriptionId}, {resourceGroup} y {apimServiceName} por la suscripción de Azure, el nombre del grupo de recursos y el nombre de API Management:

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

. . . y establezca la propiedad restore en true en el cuerpo de la solicitud. (Cuando se especifica esta marca y se establece en true, se omiten todas las demás propiedades). Por ejemplo:

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

Purgar una instancia eliminada temporalmente

Use la operación Purge (Purgar) de API Management, pero sustituya {subscriptionId}, {location} y {serviceName} por la suscripción de Azure, la ubicación del recurso y el nombre de API Management.

Nota

Para purgar una instancia eliminada temporalmente, debes tener los siguientes permisos de RBAC en el ámbito de la suscripción, además del acceso de colaborador a la instancia de API Management: Microsoft.ApiManagement/locations/deletedservices/delete, Microsoft.ApiManagement/deletedservices/read.

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

La instancia de API Management se eliminará permanentemente de Azure.

Reutilización de un nombre de instancia de API Management después de la eliminación

Puede reutilizar el nombre de una instancia de API Management en una nueva implementación:

  • Una vez que la instancia se haya eliminado permanentemente (purgado) de Azure.

  • En la misma suscripción que la instancia original.

No puede reutilizar el nombre de una instancia de API Management en una nueva implementación:

  • Mientras la instancia se elimina temporalmente.

  • En una suscripción distinta de la usada para implementar la instancia original, incluso después de que la instancia original se haya eliminado permanentemente (purgado) de Azure. Esta restricción se aplica si la nueva suscripción usada está en el mismo inquilino de Microsoft Entra o en otro. La restricción está en vigor durante varios días o más después de la eliminación, en función del tipo de suscripción.

    Esta restricción se debe a que Azure reserva el nombre de host del servicio al inquilino de un cliente durante un período de reserva para evitar la amenaza de la adquisición de subdominios con entradas DNS pendientes. Para más información, consulte Prevenir entradas DNS pendientes y evitar la adquisición de subdominios. Para ver todas las entradas DNS pendientes de las suscripciones de un inquilino de Microsoft Entra, consulte Identificar entradas DNS pendientes.

Pasos siguientes

Más información sobre las opciones de copia de seguridad y recuperación de API Management a largo plazo: